diff options
Diffstat (limited to 'doc/lispref/processes.texi')
-rw-r--r-- | doc/lispref/processes.texi | 39 |
1 files changed, 23 insertions, 16 deletions
diff --git a/doc/lispref/processes.texi b/doc/lispref/processes.texi index 43c794104b8..e3eee3d0719 100644 --- a/doc/lispref/processes.texi +++ b/doc/lispref/processes.texi @@ -1,6 +1,6 @@ @c -*-texinfo-*- @c This is part of the GNU Emacs Lisp Reference Manual. -@c Copyright (C) 1990--1995, 1998--1999, 2001--2023 Free Software +@c Copyright (C) 1990--1995, 1998--1999, 2001--2024 Free Software @c Foundation, Inc. @c See the file elisp.texi for copying conditions. @node Processes @@ -1497,6 +1497,9 @@ If @var{process} is a process object which contains the property @code{remote-pid}, or @var{process} is a number and @var{remote} is a remote file name, @var{process} is interpreted as process on the respective remote host, which will be the process to signal. + +If @var{process} is a string, it is interpreted as process object with +the respective process name, or as a number. @end deffn Sometimes, it is necessary to send a signal to a non-local @@ -1641,8 +1644,10 @@ from previous output. @defun set-process-buffer process buffer This function sets the buffer associated with @var{process} to @var{buffer}. If @var{buffer} is @code{nil}, the process becomes -associated with no buffer; if non-@code{nil}, the process mark will be -set to point to the end of @var{buffer}. +associated with no buffer; if non-@code{nil} and different from the +buffer associated with the process, the process mark will be set to +point to the end of @var{buffer} (unless the process mark is already +associated with @var{buffer}). @end defun @defun get-buffer-process buffer-or-name @@ -2615,7 +2620,7 @@ and @samp{:capability-command} are supplied, try to upgrade to an encrypted connection via @acronym{STARTTLS}. If that fails, retain the unencrypted connection. @item starttls -As for @code{nil}, but if @acronym{STARTTLS} fails drop the connection. +As for @code{nil}, but if @acronym{STARTTLS} fails, drop the connection. @item shell A shell connection. @end table @@ -2626,9 +2631,9 @@ doing a @samp{plain} connection. @item :capability-command @var{capability-command} Command to query the host capabilities. This can either be a string -(which will then be sent verbatim to the server), or a function -(called with a single parameter; the "greeting" from the server when -connecting), and should return a string. +(which will then be sent verbatim to the server) or a function +(called with a single parameter: the ``greeting'' from the server when +connecting) that should return a string. @item :end-of-command @var{regexp} @itemx :end-of-capability @var{regexp} @@ -2637,8 +2642,8 @@ command @var{capability-command}. The latter defaults to the former. @item :starttls-function @var{function} Function of one argument (the response to @var{capability-command}), -which returns either @code{nil}, or the command to activate @acronym{STARTTLS} -if supported. +which returns either @code{nil} or the command to activate +@acronym{STARTTLS}, if supported. @item :success @var{regexp} Regular expression matching a successful @acronym{STARTTLS} negotiation. @@ -2666,8 +2671,9 @@ enable automatic queries of @code{auth-source} when @item :return-list @var{cons-or-nil} The return value of this function. If omitted or @code{nil}, return a -process object. Otherwise, a cons of the form @code{(@var{process-object} -. @var{plist})}, where @var{plist} has keywords: +process object. Otherwise, a cons of the form +@w{@code{(@var{process-object} . @var{plist})}}, where @var{plist} can +include the following keywords: @table @code @item :greeting @var{string-or-nil} @@ -2680,11 +2686,12 @@ The connection type: @samp{plain} or @samp{tls}. @item :shell-command @var{string-or-nil} If the connection @code{type} is @code{shell}, this parameter will be -interpreted as a format-spec string that will be executed to make the -connection. The specs available are @samp{%s} for the host name and -@samp{%p} for the port number. For instance, if you want to first ssh -to @samp{gateway} before making a plain connection, then this -parameter could be something like @samp{ssh gateway nc %s %p}. +interpreted as a format-spec string (@pxref{Custom Format Strings}) +that will be executed to make the connection. The specs available are +@samp{%s} for the host name and @samp{%p} for the port number. For +instance, if you want to first ssh to @samp{gateway} before making a +plain connection, then this parameter's value could be something like +@samp{ssh gateway nc %s %p}. @end table |