annotate lispref/processes.texi @ 66694:4e54f245caa7

(show_mouse_face): Clear mouse face to eol.
author Kim F. Storm <storm@cua.dk>
date Fri, 04 Nov 2005 10:14:54 +0000
parents 6677034b52bb
children a40ac89f9800 0ca0d9181b5e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1 @c -*-texinfo-*-
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2 @c This is part of the GNU Emacs Lisp Reference Manual.
64889
e836425ee789 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64720
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2002, 2003,
e836425ee789 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64720
diff changeset
4 @c 2004, 2005 Free Software Foundation, Inc.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5 @c See the file elisp.texi for copying conditions.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6 @setfilename ../info/processes
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
7 @node Processes, Display, Abbrevs, Top
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8 @chapter Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 @cindex child process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10 @cindex parent process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 @cindex subprocess
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12 @cindex process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 In the terminology of operating systems, a @dfn{process} is a space in
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15 which a program can execute. Emacs runs in a process. Emacs Lisp
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 programs can invoke other programs in processes of their own. These are
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 called @dfn{subprocesses} or @dfn{child processes} of the Emacs process,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 which is their @dfn{parent process}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 A subprocess of Emacs may be @dfn{synchronous} or @dfn{asynchronous},
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 depending on how it is created. When you create a synchronous
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22 subprocess, the Lisp program waits for the subprocess to terminate
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23 before continuing execution. When you create an asynchronous
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24 subprocess, it can run in parallel with the Lisp program. This kind of
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25 subprocess is represented within Emacs by a Lisp object which is also
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26 called a ``process''. Lisp programs can use this object to communicate
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27 with the subprocess or to control it. For example, you can send
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
28 signals, obtain status information, receive output from the process, or
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29 send input to it.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 @defun processp object
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32 This function returns @code{t} if @var{object} is a process,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33 @code{nil} otherwise.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 @menu
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 * Subprocess Creation:: Functions that start subprocesses.
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
38 * Shell Arguments:: Quoting an argument to pass it to a shell.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39 * Synchronous Processes:: Details of using synchronous subprocesses.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40 * Asynchronous Processes:: Starting up an asynchronous subprocess.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
41 * Deleting Processes:: Eliminating an asynchronous subprocess.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
42 * Process Information:: Accessing run-status and other attributes.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
43 * Input to Processes:: Sending input to an asynchronous subprocess.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44 * Signals to Processes:: Stopping, continuing or interrupting
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 an asynchronous subprocess.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46 * Output from Processes:: Collecting output from an asynchronous subprocess.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47 * Sentinels:: Sentinels run when process run-status changes.
46340
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
48 * Query Before Exit:: Whether to query if exiting will kill a process.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49 * Transaction Queues:: Transaction-based communication with subprocesses.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
50 * Network:: Opening network connections.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
51 * Network Servers:: Network servers let Emacs accept net connections.
62245
a9109def6d90 (Processes): Add menu description.
Lute Kamstra <lute@gnu.org>
parents: 62230
diff changeset
52 * Datagrams:: UDP network connections.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
53 * Low-Level Network:: Lower-level but more general function
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
54 to create connections and servers.
64913
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
55 * Misc Network:: Additional relevant functions for network connections.
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
56 * Byte Packing:: Using bindat to pack and unpack binary data.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
57 @end menu
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59 @node Subprocess Creation
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
60 @section Functions that Create Subprocesses
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62 There are three functions that create a new subprocess in which to run
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
63 a program. One of them, @code{start-process}, creates an asynchronous
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64 process and returns a process object (@pxref{Asynchronous Processes}).
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65 The other two, @code{call-process} and @code{call-process-region},
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66 create a synchronous process and do not return a process object
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
67 (@pxref{Synchronous Processes}).
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
68
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
69 Synchronous and asynchronous processes are explained in the following
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
70 sections. Since the three functions are all called in a similar
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71 fashion, their common arguments are described here.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
72
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
73 @cindex execute program
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74 @cindex @code{PATH} environment variable
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
75 @cindex @code{HOME} environment variable
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76 In all cases, the function's @var{program} argument specifies the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
77 program to be run. An error is signaled if the file is not found or
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
78 cannot be executed. If the file name is relative, the variable
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
79 @code{exec-path} contains a list of directories to search. Emacs
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
80 initializes @code{exec-path} when it starts up, based on the value of
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
81 the environment variable @code{PATH}. The standard file name
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
82 constructs, @samp{~}, @samp{.}, and @samp{..}, are interpreted as
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
83 usual in @code{exec-path}, but environment variable substitutions
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
84 (@samp{$HOME}, etc.) are not recognized; use
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
85 @code{substitute-in-file-name} to perform them (@pxref{File Name
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
86 Expansion}). @code{nil} in this list refers to
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
87 @code{default-directory}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
88
51922
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
89 Executing a program can also try adding suffixes to the specified
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
90 name:
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
91
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
92 @defvar exec-suffixes
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
93 This variable is a list of suffixes (strings) to try adding to the
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
94 specified program file name. The list should include @code{""} if you
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
95 want the name to be tried exactly as specified. The default value is
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
96 system-dependent.
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
97 @end defvar
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
98
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
99 @strong{Please note:} The argument @var{program} contains only the
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
100 name of the program; it may not contain any command-line arguments. You
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
101 must use @var{args} to provide those.
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
102
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
103 Each of the subprocess-creating functions has a @var{buffer-or-name}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
104 argument which specifies where the standard output from the program will
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
105 go. It should be a buffer or a buffer name; if it is a buffer name,
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
106 that will create the buffer if it does not already exist. It can also
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
107 be @code{nil}, which says to discard the output unless a filter function
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
108 handles it. (@xref{Filter Functions}, and @ref{Read and Print}.)
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
109 Normally, you should avoid having multiple processes send output to the
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
110 same buffer because their output would be intermixed randomly.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
111
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
112 @cindex program arguments
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
113 All three of the subprocess-creating functions have a @code{&rest}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
114 argument, @var{args}. The @var{args} must all be strings, and they are
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
115 supplied to @var{program} as separate command line arguments. Wildcard
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
116 characters and other shell constructs have no special meanings in these
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
117 strings, since the strings are passed directly to the specified program.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
118
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
119 The subprocess gets its current directory from the value of
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
120 @code{default-directory} (@pxref{File Name Expansion}).
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
121
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
122 @cindex environment variables, subprocesses
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
123 The subprocess inherits its environment from Emacs, but you can
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
124 specify overrides for it with @code{process-environment}. @xref{System
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
125 Environment}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
126
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46340
diff changeset
127 @defvar exec-directory
17611
1b2afa6391ca (exec-directory): Wakeup no longer exists, so use movemail as example.
Richard M. Stallman <rms@gnu.org>
parents: 16664
diff changeset
128 @pindex movemail
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
129 The value of this variable is a string, the name of a directory that
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
130 contains programs that come with GNU Emacs, programs intended for Emacs
17611
1b2afa6391ca (exec-directory): Wakeup no longer exists, so use movemail as example.
Richard M. Stallman <rms@gnu.org>
parents: 16664
diff changeset
131 to invoke. The program @code{movemail} is an example of such a program;
1b2afa6391ca (exec-directory): Wakeup no longer exists, so use movemail as example.
Richard M. Stallman <rms@gnu.org>
parents: 16664
diff changeset
132 Rmail uses it to fetch new mail from an inbox.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
133 @end defvar
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
134
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
135 @defopt exec-path
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
136 The value of this variable is a list of directories to search for
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
137 programs to run in subprocesses. Each element is either the name of a
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
138 directory (i.e., a string), or @code{nil}, which stands for the default
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
139 directory (which is the value of @code{default-directory}).
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
140 @cindex program directories
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
141
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
142 The value of @code{exec-path} is used by @code{call-process} and
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
143 @code{start-process} when the @var{program} argument is not an absolute
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
144 file name.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
145 @end defopt
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
146
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
147 @node Shell Arguments
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
148 @section Shell Arguments
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
149
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
150 Lisp programs sometimes need to run a shell and give it a command
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
151 that contains file names that were specified by the user. These
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
152 programs ought to be able to support any valid file name. But the shell
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
153 gives special treatment to certain characters, and if these characters
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
154 occur in the file name, they will confuse the shell. To handle these
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
155 characters, use the function @code{shell-quote-argument}:
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
156
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
157 @defun shell-quote-argument argument
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
158 This function returns a string which represents, in shell syntax,
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
159 an argument whose actual contents are @var{argument}. It should
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
160 work reliably to concatenate the return value into a shell command
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
161 and then pass it to a shell for execution.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
162
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
163 Precisely what this function does depends on your operating system. The
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
164 function is designed to work with the syntax of your system's standard
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
165 shell; if you use an unusual shell, you will need to redefine this
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
166 function.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
167
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
168 @example
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
169 ;; @r{This example shows the behavior on GNU and Unix systems.}
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
170 (shell-quote-argument "foo > bar")
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
171 @result{} "foo\\ \\>\\ bar"
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
172
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
173 ;; @r{This example shows the behavior on MS-DOS and MS-Windows.}
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
174 (shell-quote-argument "foo > bar")
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
175 @result{} "\"foo > bar\""
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
176 @end example
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
177
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
178 Here's an example of using @code{shell-quote-argument} to construct
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
179 a shell command:
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
180
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
181 @example
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
182 (concat "diff -c "
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
183 (shell-quote-argument oldfile)
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
184 " "
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
185 (shell-quote-argument newfile))
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
186 @end example
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
187 @end defun
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
188
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
189 @node Synchronous Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
190 @section Creating a Synchronous Process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
191 @cindex synchronous subprocess
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
192
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
193 After a @dfn{synchronous process} is created, Emacs waits for the
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
194 process to terminate before continuing. Starting Dired on GNU or
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
195 Unix@footnote{On other systems, Emacs uses a Lisp emulation of
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
196 @code{ls}; see @ref{Contents of Directories}.} is an example of this: it
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
197 runs @code{ls} in a synchronous process, then modifies the output
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
198 slightly. Because the process is synchronous, the entire directory
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
199 listing arrives in the buffer before Emacs tries to do anything with it.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
200
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
201 While Emacs waits for the synchronous subprocess to terminate, the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
202 user can quit by typing @kbd{C-g}. The first @kbd{C-g} tries to kill
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
203 the subprocess with a @code{SIGINT} signal; but it waits until the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
204 subprocess actually terminates before quitting. If during that time the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
205 user types another @kbd{C-g}, that kills the subprocess instantly with
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
206 @code{SIGKILL} and quits immediately (except on MS-DOS, where killing
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
207 other processes doesn't work). @xref{Quitting}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
208
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
209 The synchronous subprocess functions return an indication of how the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
210 process terminated.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
211
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
212 The output from a synchronous subprocess is generally decoded using a
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
213 coding system, much like text read from a file. The input sent to a
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
214 subprocess by @code{call-process-region} is encoded using a coding
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
215 system, much like text written into a file. @xref{Coding Systems}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
216
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
217 @defun call-process program &optional infile destination display &rest args
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
218 This function calls @var{program} in a separate process and waits for
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
219 it to finish.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
220
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
221 The standard input for the process comes from file @var{infile} if
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
222 @var{infile} is not @code{nil}, and from the null device otherwise.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
223 The argument @var{destination} says where to put the process output.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
224 Here are the possibilities:
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
225
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
226 @table @asis
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
227 @item a buffer
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
228 Insert the output in that buffer, before point. This includes both the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
229 standard output stream and the standard error stream of the process.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
230
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
231 @item a string
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
232 Insert the output in a buffer with that name, before point.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
233
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
234 @item @code{t}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
235 Insert the output in the current buffer, before point.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
236
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
237 @item @code{nil}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
238 Discard the output.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
239
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
240 @item 0
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
241 Discard the output, and return @code{nil} immediately without waiting
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
242 for the subprocess to finish.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
243
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
244 In this case, the process is not truly synchronous, since it can run in
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
245 parallel with Emacs; but you can think of it as synchronous in that
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
246 Emacs is essentially finished with the subprocess as soon as this
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
247 function returns.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
248
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
249 MS-DOS doesn't support asynchronous subprocesses, so this option doesn't
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
250 work there.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
251
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
252 @item @code{(@var{real-destination} @var{error-destination})}
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
253 Keep the standard output stream separate from the standard error stream;
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
254 deal with the ordinary output as specified by @var{real-destination},
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
255 and dispose of the error output according to @var{error-destination}.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
256 If @var{error-destination} is @code{nil}, that means to discard the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
257 error output, @code{t} means mix it with the ordinary output, and a
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
258 string specifies a file name to redirect error output into.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
259
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
260 You can't directly specify a buffer to put the error output in; that is
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
261 too difficult to implement. But you can achieve this result by sending
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
262 the error output to a temporary file and then inserting the file into a
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
263 buffer.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
264 @end table
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
265
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
266 If @var{display} is non-@code{nil}, then @code{call-process} redisplays
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
267 the buffer as output is inserted. (However, if the coding system chosen
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
268 for decoding output is @code{undecided}, meaning deduce the encoding
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
269 from the actual data, then redisplay sometimes cannot continue once
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
270 non-@acronym{ASCII} characters are encountered. There are fundamental
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
271 reasons why it is hard to fix this; see @ref{Output from Processes}.)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
272
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
273 Otherwise the function @code{call-process} does no redisplay, and the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
274 results become visible on the screen only when Emacs redisplays that
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
275 buffer in the normal course of events.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
276
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
277 The remaining arguments, @var{args}, are strings that specify command
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
278 line arguments for the program.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
279
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
280 The value returned by @code{call-process} (unless you told it not to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
281 wait) indicates the reason for process termination. A number gives the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
282 exit status of the subprocess; 0 means success, and any other value
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
283 means failure. If the process terminated with a signal,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
284 @code{call-process} returns a string describing the signal.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
285
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
286 In the examples below, the buffer @samp{foo} is current.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
287
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
288 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
289 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
290 (call-process "pwd" nil t)
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
291 @result{} 0
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
292
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
293 ---------- Buffer: foo ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
294 /usr/user/lewis/manual
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
295 ---------- Buffer: foo ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
296 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
297
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
298 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
299 (call-process "grep" nil "bar" nil "lewis" "/etc/passwd")
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
300 @result{} 0
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
301
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
302 ---------- Buffer: bar ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
303 lewis:5LTsHm66CSWKg:398:21:Bil Lewis:/user/lewis:/bin/csh
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
304
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
305 ---------- Buffer: bar ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
306 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
307 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
308
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
309 Here is a good example of the use of @code{call-process}, which used to
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
310 be found in the definition of @code{insert-directory}:
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
311
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
312 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
313 @group
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
314 (call-process insert-directory-program nil t nil @var{switches}
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
315 (if full-directory-p
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
316 (concat (file-name-as-directory file) ".")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
317 file))
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
318 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
319 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
320 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
321
57670
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
322 @defun process-file program &optional infile buffer display &rest args
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
323 This function processes files synchronously in a separate process. It
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
324 is similar to @code{call-process} but may invoke a file handler based
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
325 on the value of the variable @code{default-directory}. The current
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
326 working directory of the subprocess is @code{default-directory}.
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
327
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
328 The arguments are handled in almost the same way as for
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
329 @code{call-process}, with the following differences:
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
330
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
331 Some file handlers may not support all combinations and forms of the
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
332 arguments @var{infile}, @var{buffer}, and @var{display}. For example,
58500
6f8c0631e5aa (Synchronous Processes): Grammar fix.
Richard M. Stallman <rms@gnu.org>
parents: 58405
diff changeset
333 some file handlers might behave as if @var{display} were @code{nil},
57670
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
334 regardless of the value actually passed. As another example, some
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
335 file handlers might not support separating standard output and error
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
336 output by way of the @var{buffer} argument.
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
337
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
338 If a file handler is invoked, it determines the program to run based
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
339 on the first argument @var{program}. For instance, consider that a
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
340 handler for remote files is invoked. Then the path that is used for
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
341 searching the program might be different than @code{exec-path}.
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
342
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
343 The second argument @var{infile} may invoke a file handler. The file
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
344 handler could be different from the handler chosen for the
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
345 @code{process-file} function itself. (For example,
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
346 @code{default-directory} could be on a remote host, whereas
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
347 @var{infile} is on another remote host. Or @code{default-directory}
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
348 could be non-special, whereas @var{infile} is on a remote host.)
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
349
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
350 If @var{buffer} has the form @code{(@var{real-destination}
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
351 @var{error-destination})}, and @var{error-destination} names a file,
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
352 then the same remarks as for @var{infile} apply.
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
353
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
354 The remaining arguments (@var{args}) will be passed to the process
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
355 verbatim. Emacs is not involved in processing file names that are
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
356 present in @var{args}. To avoid confusion, it may be best to avoid
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
357 absolute file names in @var{args}, but rather to specify all file
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
358 names as relative to @code{default-directory}. The function
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
359 @code{file-relative-name} is useful for constructing such relative
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
360 file names.
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
361 @end defun
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
362
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
363 @defun call-process-region start end program &optional delete destination display &rest args
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
364 This function sends the text from @var{start} to @var{end} as
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
365 standard input to a process running @var{program}. It deletes the text
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
366 sent if @var{delete} is non-@code{nil}; this is useful when
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
367 @var{destination} is @code{t}, to insert the output in the current
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
368 buffer in place of the input.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
369
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
370 The arguments @var{destination} and @var{display} control what to do
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
371 with the output from the subprocess, and whether to update the display
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
372 as it comes in. For details, see the description of
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
373 @code{call-process}, above. If @var{destination} is the integer 0,
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
374 @code{call-process-region} discards the output and returns @code{nil}
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
375 immediately, without waiting for the subprocess to finish (this only
27370
70846ee19545 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27259
diff changeset
376 works if asynchronous subprocesses are supported).
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
377
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
378 The remaining arguments, @var{args}, are strings that specify command
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
379 line arguments for the program.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
380
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
381 The return value of @code{call-process-region} is just like that of
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
382 @code{call-process}: @code{nil} if you told it to return without
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
383 waiting; otherwise, a number or string which indicates how the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
384 subprocess terminated.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
385
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
386 In the following example, we use @code{call-process-region} to run the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
387 @code{cat} utility, with standard input being the first five characters
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
388 in buffer @samp{foo} (the word @samp{input}). @code{cat} copies its
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
389 standard input into its standard output. Since the argument
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
390 @var{destination} is @code{t}, this output is inserted in the current
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
391 buffer.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
392
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
393 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
394 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
395 ---------- Buffer: foo ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
396 input@point{}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
397 ---------- Buffer: foo ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
398 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
399
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
400 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
401 (call-process-region 1 6 "cat" nil t)
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
402 @result{} 0
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
403
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
404 ---------- Buffer: foo ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
405 inputinput@point{}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
406 ---------- Buffer: foo ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
407 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
408 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
409
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
410 The @code{shell-command-on-region} command uses
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
411 @code{call-process-region} like this:
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
412
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
413 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
414 @group
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46340
diff changeset
415 (call-process-region
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46340
diff changeset
416 start end
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
417 shell-file-name ; @r{Name of program.}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
418 nil ; @r{Do not delete region.}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
419 buffer ; @r{Send output to @code{buffer}.}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
420 nil ; @r{No redisplay during output.}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
421 "-c" command) ; @r{Arguments for the shell.}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
422 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
423 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
424 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
425
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
426 @defun call-process-shell-command command &optional infile destination display &rest args
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
427 This function executes the shell command @var{command} synchronously
54265
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
428 in a separate process. The final arguments @var{args} are additional
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
429 arguments to add at the end of @var{command}. The other arguments
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
430 are handled as in @code{call-process}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
431 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
432
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
433 @defun shell-command-to-string command
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
434 This function executes @var{command} (a string) as a shell command,
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
435 then returns the command's output as a string.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
436 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
437
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
438 @node Asynchronous Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
439 @section Creating an Asynchronous Process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
440 @cindex asynchronous subprocess
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
441
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
442 After an @dfn{asynchronous process} is created, Emacs and the subprocess
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
443 both continue running immediately. The process thereafter runs
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
444 in parallel with Emacs, and the two can communicate with each other
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
445 using the functions described in the following sections. However,
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
446 communication is only partially asynchronous: Emacs sends data to the
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
447 process only when certain functions are called, and Emacs accepts data
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
448 from the process only when Emacs is waiting for input or for a time
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
449 delay.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
450
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
451 Here we describe how to create an asynchronous process.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
452
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
453 @defun start-process name buffer-or-name program &rest args
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
454 This function creates a new asynchronous subprocess and starts the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
455 program @var{program} running in it. It returns a process object that
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
456 stands for the new subprocess in Lisp. The argument @var{name}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
457 specifies the name for the process object; if a process with this name
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
458 already exists, then @var{name} is modified (by appending @samp{<1>},
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
459 etc.) to be unique. The buffer @var{buffer-or-name} is the buffer to
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
460 associate with the process.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
461
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
462 The remaining arguments, @var{args}, are strings that specify command
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
463 line arguments for the program.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
464
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
465 In the example below, the first process is started and runs (rather,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
466 sleeps) for 100 seconds. Meanwhile, the second process is started, and
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
467 given the name @samp{my-process<1>} for the sake of uniqueness. It
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
468 inserts the directory listing at the end of the buffer @samp{foo},
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
469 before the first process finishes. Then it finishes, and a message to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
470 that effect is inserted in the buffer. Much later, the first process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
471 finishes, and another message is inserted in the buffer for it.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
472
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
473 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
474 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
475 (start-process "my-process" "foo" "sleep" "100")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
476 @result{} #<process my-process>
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
477 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
478
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
479 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
480 (start-process "my-process" "foo" "ls" "-l" "/user/lewis/bin")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
481 @result{} #<process my-process<1>>
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
482
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
483 ---------- Buffer: foo ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
484 total 2
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
485 lrwxrwxrwx 1 lewis 14 Jul 22 10:12 gnuemacs --> /emacs
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
486 -rwxrwxrwx 1 lewis 19 Jul 30 21:02 lemon
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
487
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
488 Process my-process<1> finished
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
489
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
490 Process my-process finished
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
491 ---------- Buffer: foo ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
492 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
493 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
494 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
495
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
496 @defun start-process-shell-command name buffer-or-name command &rest command-args
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
497 This function is like @code{start-process} except that it uses a shell
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
498 to execute the specified command. The argument @var{command} is a shell
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
499 command name, and @var{command-args} are the arguments for the shell
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
500 command. The variable @code{shell-file-name} specifies which shell to
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
501 use.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
502
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
503 The point of running a program through the shell, rather than directly
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
504 with @code{start-process}, is so that you can employ shell features such
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
505 as wildcards in the arguments. It follows that if you include an
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
506 arbitrary user-specified arguments in the command, you should quote it
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
507 with @code{shell-quote-argument} first, so that any special shell
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
508 characters do @emph{not} have their special shell meanings. @xref{Shell
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
509 Arguments}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
510 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
511
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
512 @defvar process-connection-type
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
513 @cindex pipes
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
514 @cindex @acronym{PTY}s
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
515 This variable controls the type of device used to communicate with
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
516 asynchronous subprocesses. If it is non-@code{nil}, then @acronym{PTY}s are
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
517 used, when available. Otherwise, pipes are used.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
518
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
519 @acronym{PTY}s are usually preferable for processes visible to the user, as
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
520 in Shell mode, because they allow job control (@kbd{C-c}, @kbd{C-z},
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
521 etc.) to work between the process and its children, whereas pipes do
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
522 not. For subprocesses used for internal purposes by programs, it is
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
523 often better to use a pipe, because they are more efficient. In
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
524 addition, the total number of @acronym{PTY}s is limited on many systems and
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
525 it is good not to waste them.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
526
46340
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
527 The value of @code{process-connection-type} takes effect when
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
528 @code{start-process} is called. So you can specify how to communicate
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
529 with one subprocess by binding the variable around the call to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
530 @code{start-process}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
531
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
532 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
533 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
534 (let ((process-connection-type nil)) ; @r{Use a pipe.}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
535 (start-process @dots{}))
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
536 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
537 @end smallexample
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
538
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
539 To determine whether a given subprocess actually got a pipe or a
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
540 @acronym{PTY}, use the function @code{process-tty-name} (@pxref{Process
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
541 Information}).
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
542 @end defvar
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
543
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
544 @node Deleting Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
545 @section Deleting Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
546 @cindex deleting processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
547
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
548 @dfn{Deleting a process} disconnects Emacs immediately from the
44345
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
549 subprocess. Processes are deleted automatically after they terminate,
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
550 but not necessarily right away. You can delete a process explicitly
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
551 at any time. If you delete a terminated process explicitly before it
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
552 is deleted automatically, no harm results. Deleting a running
46340
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
553 process sends a signal to terminate it (and its child processes if
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
554 any), and calls the process sentinel if it has one. @xref{Sentinels}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
555
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
556 When a process is deleted, the process object itself continues to
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
557 exist as long as other Lisp objects point to it. All the Lisp
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
558 primitives that work on process objects accept deleted processes, but
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
559 those that do I/O or send signals will report an error. The process
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
560 mark continues to point to the same place as before, usually into a
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
561 buffer where output from the process was being inserted.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
562
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
563 @defopt delete-exited-processes
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
564 This variable controls automatic deletion of processes that have
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
565 terminated (due to calling @code{exit} or to a signal). If it is
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
566 @code{nil}, then they continue to exist until the user runs
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
567 @code{list-processes}. Otherwise, they are deleted immediately after
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
568 they exit.
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
569 @end defopt
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
570
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
571 @defun delete-process process
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
572 This function deletes a process, killing it with a @code{SIGKILL}
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
573 signal. The argument may be a process, the name of a process, a
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
574 buffer, or the name of a buffer. (A buffer or buffer-name stands for
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
575 the process that @code{get-buffer-process} returns.) Calling
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
576 @code{delete-process} on a running process terminates it, updates the
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
577 process status, and runs the sentinel (if any) immediately. If the
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
578 process has already terminated, calling @code{delete-process} has no
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
579 effect on its status, or on the running of its sentinel (which will
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
580 happen sooner or later).
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
581
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
582 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
583 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
584 (delete-process "*shell*")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
585 @result{} nil
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
586 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
587 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
588 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
589
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
590 @node Process Information
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
591 @section Process Information
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
592
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
593 Several functions return information about processes.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
594 @code{list-processes} is provided for interactive use.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
595
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
596 @deffn Command list-processes &optional query-only
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
597 This command displays a listing of all living processes. In addition,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
598 it finally deletes any process whose status was @samp{Exited} or
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
599 @samp{Signaled}. It returns @code{nil}.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
600
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
601 If @var{query-only} is non-@code{nil} then it lists only processes
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
602 whose query flag is non-@code{nil}. @xref{Query Before Exit}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
603 @end deffn
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
604
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
605 @defun process-list
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
606 This function returns a list of all processes that have not been deleted.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
607
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
608 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
609 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
610 (process-list)
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
611 @result{} (#<process display-time> #<process shell>)
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
612 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
613 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
614 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
615
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
616 @defun get-process name
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
617 This function returns the process named @var{name}, or @code{nil} if
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
618 there is none. An error is signaled if @var{name} is not a string.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
619
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
620 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
621 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
622 (get-process "shell")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
623 @result{} #<process shell>
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
624 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
625 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
626 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
627
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
628 @defun process-command process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
629 This function returns the command that was executed to start
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
630 @var{process}. This is a list of strings, the first string being the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
631 program executed and the rest of the strings being the arguments that
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
632 were given to the program.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
633
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
634 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
635 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
636 (process-command (get-process "shell"))
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
637 @result{} ("/bin/csh" "-i")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
638 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
639 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
640 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
641
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
642 @defun process-id process
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
643 This function returns the @acronym{PID} of @var{process}. This is an
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
644 integer that distinguishes the process @var{process} from all other
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
645 processes running on the same computer at the current time. The
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
646 @acronym{PID} of a process is chosen by the operating system kernel when the
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
647 process is started and remains constant as long as the process exists.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
648 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
649
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
650 @defun process-name process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
651 This function returns the name of @var{process}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
652 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
653
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
654 @defun process-status process-name
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
655 This function returns the status of @var{process-name} as a symbol.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
656 The argument @var{process-name} must be a process, a buffer, a
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
657 process name (string) or a buffer name (string).
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
658
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
659 The possible values for an actual subprocess are:
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
660
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
661 @table @code
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
662 @item run
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
663 for a process that is running.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
664 @item stop
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
665 for a process that is stopped but continuable.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
666 @item exit
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
667 for a process that has exited.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
668 @item signal
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
669 for a process that has received a fatal signal.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
670 @item open
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
671 for a network connection that is open.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
672 @item closed
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
673 for a network connection that is closed. Once a connection
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
674 is closed, you cannot reopen it, though you might be able to open
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
675 a new connection to the same place.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
676 @item connect
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
677 for a non-blocking connection that is waiting to complete.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
678 @item failed
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
679 for a non-blocking connection that has failed to complete.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
680 @item listen
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
681 for a network server that is listening.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
682 @item nil
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
683 if @var{process-name} is not the name of an existing process.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
684 @end table
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
685
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
686 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
687 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
688 (process-status "shell")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
689 @result{} run
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
690 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
691 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
692 (process-status (get-buffer "*shell*"))
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
693 @result{} run
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
694 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
695 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
696 x
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
697 @result{} #<process xx<1>>
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
698 (process-status x)
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
699 @result{} exit
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
700 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
701 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
702
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
703 For a network connection, @code{process-status} returns one of the symbols
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
704 @code{open} or @code{closed}. The latter means that the other side
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
705 closed the connection, or Emacs did @code{delete-process}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
706 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
707
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
708 @defun process-exit-status process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
709 This function returns the exit status of @var{process} or the signal
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
710 number that killed it. (Use the result of @code{process-status} to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
711 determine which of those it is.) If @var{process} has not yet
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
712 terminated, the value is 0.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
713 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
714
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
715 @defun process-tty-name process
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
716 This function returns the terminal name that @var{process} is using for
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
717 its communication with Emacs---or @code{nil} if it is using pipes
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
718 instead of a terminal (see @code{process-connection-type} in
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
719 @ref{Asynchronous Processes}).
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
720 @end defun
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
721
56215
c9aa4127a482 Reposition @anchor's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54916
diff changeset
722 @defun process-coding-system process
53292
5408fe43d709 (Process Information): Add anchor.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52978
diff changeset
723 @anchor{Coding systems for a subprocess}
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
724 This function returns a cons cell describing the coding systems in use
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
725 for decoding output from @var{process} and for encoding input to
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
726 @var{process} (@pxref{Coding Systems}). The value has this form:
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
727
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
728 @example
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
729 (@var{coding-system-for-decoding} . @var{coding-system-for-encoding})
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
730 @end example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
731 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
732
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
733 @defun set-process-coding-system process &optional decoding-system encoding-system
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
734 This function specifies the coding systems to use for subsequent output
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
735 from and input to @var{process}. It will use @var{decoding-system} to
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
736 decode subprocess output, and @var{encoding-system} to encode subprocess
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
737 input.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
738 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
739
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
740 Every process also has a property list that you can use to store
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
741 miscellaneous values associated with the process.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
742
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
743 @defun process-get process propname
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
744 This function returns the value of the @var{propname} property
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
745 of @var{process}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
746 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
747
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
748 @defun process-put process propname value
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
749 This function sets the value of the @var{propname} property
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
750 of @var{process} to @var{value}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
751 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
752
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
753 @defun process-plist process
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
754 This function returns the process plist of @var{process}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
755 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
756
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
757 @defun set-process-plist process plist
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
758 This function sets the process plist of @var{process} to @var{plist}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
759 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
760
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
761 @node Input to Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
762 @section Sending Input to Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
763 @cindex process input
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
764
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
765 Asynchronous subprocesses receive input when it is sent to them by
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
766 Emacs, which is done with the functions in this section. You must
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
767 specify the process to send input to, and the input data to send. The
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
768 data appears on the ``standard input'' of the subprocess.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
769
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
770 Some operating systems have limited space for buffered input in a
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
771 @acronym{PTY}. On these systems, Emacs sends an @acronym{EOF}
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
772 periodically amidst the other characters, to force them through. For
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
773 most programs, these @acronym{EOF}s do no harm.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
774
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
775 Subprocess input is normally encoded using a coding system before the
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
776 subprocess receives it, much like text written into a file. You can use
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
777 @code{set-process-coding-system} to specify which coding system to use
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
778 (@pxref{Process Information}). Otherwise, the coding system comes from
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
779 @code{coding-system-for-write}, if that is non-@code{nil}; or else from
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
780 the defaulting mechanism (@pxref{Default Coding Systems}).
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
781
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
782 Sometimes the system is unable to accept input for that process,
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
783 because the input buffer is full. When this happens, the send functions
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
784 wait a short while, accepting output from subprocesses, and then try
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
785 again. This gives the subprocess a chance to read more of its pending
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
786 input and make space in the buffer. It also allows filters, sentinels
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
787 and timers to run---so take account of that in writing your code.
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
788
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
789 In these functions, the @var{process} argument can be a process or
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
790 the name of a process, or a buffer or buffer name (which stands
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
791 for a process via @code{get-buffer-process}). @code{nil} means
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
792 the current buffer's process.
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
793
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
794 @defun process-send-string process string
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
795 This function sends @var{process} the contents of @var{string} as
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
796 standard input. If it is @code{nil}, the current buffer's process is used.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
797
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
798 The function returns @code{nil}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
799
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
800 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
801 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
802 (process-send-string "shell<1>" "ls\n")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
803 @result{} nil
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
804 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
805
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
806
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
807 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
808 ---------- Buffer: *shell* ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
809 ...
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
810 introduction.texi syntax-tables.texi~
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
811 introduction.texi~ text.texi
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
812 introduction.txt text.texi~
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
813 ...
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
814 ---------- Buffer: *shell* ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
815 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
816 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
817 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
818
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
819 @defun process-send-region process start end
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
820 This function sends the text in the region defined by @var{start} and
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
821 @var{end} as standard input to @var{process}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
822
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
823 An error is signaled unless both @var{start} and @var{end} are
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
824 integers or markers that indicate positions in the current buffer. (It
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
825 is unimportant which number is larger.)
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
826 @end defun
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
827
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
828 @defun process-send-eof &optional process
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
829 This function makes @var{process} see an end-of-file in its
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
830 input. The @acronym{EOF} comes after any text already sent to it.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
831
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
832 The function returns @var{process}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
833
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
834 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
835 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
836 (process-send-eof "shell")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
837 @result{} "shell"
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
838 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
839 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
840 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
841
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
842 @defun process-running-child-p process
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
843 @tindex process-running-child-p process
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
844 This function will tell you whether a subprocess has given control of
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
845 its terminal to its own child process. The value is @code{t} if this is
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
846 true, or if Emacs cannot tell; it is @code{nil} if Emacs can be certain
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
847 that this is not so.
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
848 @end defun
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
849
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
850 @node Signals to Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
851 @section Sending Signals to Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
852 @cindex process signals
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
853 @cindex sending signals
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
854 @cindex signals
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
855
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
856 @dfn{Sending a signal} to a subprocess is a way of interrupting its
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
857 activities. There are several different signals, each with its own
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
858 meaning. The set of signals and their names is defined by the operating
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
859 system. For example, the signal @code{SIGINT} means that the user has
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
860 typed @kbd{C-c}, or that some analogous thing has happened.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
861
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
862 Each signal has a standard effect on the subprocess. Most signals
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
863 kill the subprocess, but some stop or resume execution instead. Most
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
864 signals can optionally be handled by programs; if the program handles
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
865 the signal, then we can say nothing in general about its effects.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
866
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
867 You can send signals explicitly by calling the functions in this
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
868 section. Emacs also sends signals automatically at certain times:
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
869 killing a buffer sends a @code{SIGHUP} signal to all its associated
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
870 processes; killing Emacs sends a @code{SIGHUP} signal to all remaining
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
871 processes. (@code{SIGHUP} is a signal that usually indicates that the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
872 user hung up the phone.)
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
873
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
874 Each of the signal-sending functions takes two optional arguments:
62229
789b9a24928a (Signals to Processes): Fix typo.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 60270
diff changeset
875 @var{process} and @var{current-group}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
876
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
877 The argument @var{process} must be either a process, a process
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
878 name, a buffer, a buffer name, or @code{nil}. A buffer or buffer name
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
879 stands for a process through @code{get-buffer-process}. @code{nil}
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
880 stands for the process associated with the current buffer. An error
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
881 is signaled if @var{process} does not identify a process.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
882
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
883 The argument @var{current-group} is a flag that makes a difference
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
884 when you are running a job-control shell as an Emacs subprocess. If it
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
885 is non-@code{nil}, then the signal is sent to the current process-group
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
886 of the terminal that Emacs uses to communicate with the subprocess. If
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
887 the process is a job-control shell, this means the shell's current
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
888 subjob. If it is @code{nil}, the signal is sent to the process group of
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
889 the immediate subprocess of Emacs. If the subprocess is a job-control
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
890 shell, this is the shell itself.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
891
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
892 The flag @var{current-group} has no effect when a pipe is used to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
893 communicate with the subprocess, because the operating system does not
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
894 support the distinction in the case of pipes. For the same reason,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
895 job-control shells won't work when a pipe is used. See
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
896 @code{process-connection-type} in @ref{Asynchronous Processes}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
897
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
898 @defun interrupt-process &optional process current-group
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
899 This function interrupts the process @var{process} by sending the
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
900 signal @code{SIGINT}. Outside of Emacs, typing the ``interrupt
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
901 character'' (normally @kbd{C-c} on some systems, and @code{DEL} on
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
902 others) sends this signal. When the argument @var{current-group} is
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
903 non-@code{nil}, you can think of this function as ``typing @kbd{C-c}''
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
904 on the terminal by which Emacs talks to the subprocess.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
905 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
906
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
907 @defun kill-process &optional process current-group
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
908 This function kills the process @var{process} by sending the
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
909 signal @code{SIGKILL}. This signal kills the subprocess immediately,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
910 and cannot be handled by the subprocess.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
911 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
912
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
913 @defun quit-process &optional process current-group
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
914 This function sends the signal @code{SIGQUIT} to the process
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
915 @var{process}. This signal is the one sent by the ``quit
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
916 character'' (usually @kbd{C-b} or @kbd{C-\}) when you are not inside
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
917 Emacs.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
918 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
919
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
920 @defun stop-process &optional process current-group
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
921 This function stops the process @var{process} by sending the
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
922 signal @code{SIGTSTP}. Use @code{continue-process} to resume its
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
923 execution.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
924
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
925 Outside of Emacs, on systems with job control, the ``stop character''
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
926 (usually @kbd{C-z}) normally sends this signal. When
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
927 @var{current-group} is non-@code{nil}, you can think of this function as
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
928 ``typing @kbd{C-z}'' on the terminal Emacs uses to communicate with the
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
929 subprocess.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
930 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
931
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
932 @defun continue-process &optional process current-group
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
933 This function resumes execution of the process @var{process} by sending
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
934 it the signal @code{SIGCONT}. This presumes that @var{process} was
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
935 stopped previously.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
936 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
937
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
938 @c Emacs 19 feature
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
939 @defun signal-process process signal
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
940 This function sends a signal to process @var{process}. The argument
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
941 @var{signal} specifies which signal to send; it should be an integer.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
942
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
943 The @var{process} argument can be a system process @acronym{ID}; that
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
944 allows you to send signals to processes that are not children of
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
945 Emacs.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
946 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
947
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
948 @node Output from Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
949 @section Receiving Output from Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
950 @cindex process output
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
951 @cindex output from processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
952
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
953 There are two ways to receive the output that a subprocess writes to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
954 its standard output stream. The output can be inserted in a buffer,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
955 which is called the associated buffer of the process, or a function
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
956 called the @dfn{filter function} can be called to act on the output. If
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
957 the process has no buffer and no filter function, its output is
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
958 discarded.
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46340
diff changeset
959
46340
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
960 When a subprocess terminates, Emacs reads any pending output,
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
961 then stops reading output from that subprocess. Therefore, if the
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
962 subprocess has children that are still live and still producing
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
963 output, Emacs won't receive that output.
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
964
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
965 Output from a subprocess can arrive only while Emacs is waiting: when
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
966 reading terminal input, in @code{sit-for} and @code{sleep-for}
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
967 (@pxref{Waiting}), and in @code{accept-process-output} (@pxref{Accepting
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
968 Output}). This minimizes the problem of timing errors that usually
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
969 plague parallel programming. For example, you can safely create a
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
970 process and only then specify its buffer or filter function; no output
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
971 can arrive before you finish, if the code in between does not call any
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
972 primitive that waits.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
973
56704
900340a218c9 (Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents: 56703
diff changeset
974 @defvar process-adaptive-read-buffering
900340a218c9 (Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents: 56703
diff changeset
975 On some systems, when Emacs reads the output from a subprocess, the
900340a218c9 (Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents: 56703
diff changeset
976 output data is read in very small blocks, potentially resulting in
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
977 very poor performance. This behavior can be remedied to some extent
56704
900340a218c9 (Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents: 56703
diff changeset
978 by setting the variable @var{process-adaptive-read-buffering} to a
58405
4fe765649696 (Synchronous Processes, Output from Processes):
Jesper Harder <harder@ifa.au.dk>
parents: 57670
diff changeset
979 non-@code{nil} value (the default), as it will automatically delay reading
56704
900340a218c9 (Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents: 56703
diff changeset
980 from such processes, thus allowing them to produce more output before
900340a218c9 (Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents: 56703
diff changeset
981 Emacs tries to read it.
900340a218c9 (Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents: 56703
diff changeset
982 @end defvar
900340a218c9 (Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents: 56703
diff changeset
983
27259
c41efa6c4be1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
984 It is impossible to separate the standard output and standard error
c41efa6c4be1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
985 streams of the subprocess, because Emacs normally spawns the subprocess
c41efa6c4be1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
986 inside a pseudo-TTY, and a pseudo-TTY has only one output channel. If
c41efa6c4be1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
987 you want to keep the output to those streams separate, you should
54916
07f4773453a0 Markup fixes.
Jesper Harder <harder@ifa.au.dk>
parents: 54864
diff changeset
988 redirect one of them to a file---for example, by using an appropriate
27259
c41efa6c4be1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
989 shell command.
c41efa6c4be1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
990
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
991 @menu
51993
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
992 * Process Buffers:: If no filter, output is put in a buffer.
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
993 * Filter Functions:: Filter functions accept output from the process.
51994
eb38ba134224 Fix typo.
Richard M. Stallman <rms@gnu.org>
parents: 51993
diff changeset
994 * Decoding Output:: Filters can get unibyte or multibyte strings.
51993
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
995 * Accepting Output:: How to wait until process output arrives.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
996 @end menu
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
997
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
998 @node Process Buffers
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
999 @subsection Process Buffers
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1000
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1001 A process can (and usually does) have an @dfn{associated buffer},
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1002 which is an ordinary Emacs buffer that is used for two purposes: storing
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1003 the output from the process, and deciding when to kill the process. You
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1004 can also use the buffer to identify a process to operate on, since in
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1005 normal practice only one process is associated with any given buffer.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1006 Many applications of processes also use the buffer for editing input to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1007 be sent to the process, but this is not built into Emacs Lisp.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1008
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1009 Unless the process has a filter function (@pxref{Filter Functions}),
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1010 its output is inserted in the associated buffer. The position to insert
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
1011 the output is determined by the @code{process-mark}, which is then
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
1012 updated to point to the end of the text just inserted. Usually, but not
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
1013 always, the @code{process-mark} is at the end of the buffer.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1014
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1015 @defun process-buffer process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1016 This function returns the associated buffer of the process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1017 @var{process}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1018
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1019 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1020 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1021 (process-buffer (get-process "shell"))
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1022 @result{} #<buffer *shell*>
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1023 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1024 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1025 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1026
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1027 @defun process-mark process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1028 This function returns the process marker for @var{process}, which is the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1029 marker that says where to insert output from the process.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1030
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1031 If @var{process} does not have a buffer, @code{process-mark} returns a
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1032 marker that points nowhere.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1033
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1034 Insertion of process output in a buffer uses this marker to decide where
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1035 to insert, and updates it to point after the inserted text. That is why
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1036 successive batches of output are inserted consecutively.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1037
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1038 Filter functions normally should use this marker in the same fashion
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1039 as is done by direct insertion of output in the buffer. A good
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1040 example of a filter function that uses @code{process-mark} is found at
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1041 the end of the following section.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1042
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1043 When the user is expected to enter input in the process buffer for
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1044 transmission to the process, the process marker separates the new input
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1045 from previous output.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1046 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1047
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1048 @defun set-process-buffer process buffer
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1049 This function sets the buffer associated with @var{process} to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1050 @var{buffer}. If @var{buffer} is @code{nil}, the process becomes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1051 associated with no buffer.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1052 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1053
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1054 @defun get-buffer-process buffer-or-name
44345
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1055 This function returns a nondeleted process associated with the buffer
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1056 specified by @var{buffer-or-name}. If there are several processes
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1057 associated with it, this function chooses one (currently, the one most
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1058 recently created, but don't count on that). Deletion of a process
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1059 (see @code{delete-process}) makes it ineligible for this function to
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1060 return.
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1061
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1062 It is usually a bad idea to have more than one process associated with
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1063 the same buffer.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1064
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1065 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1066 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1067 (get-buffer-process "*shell*")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1068 @result{} #<process shell>
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1069 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1070 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1071
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1072 Killing the process's buffer deletes the process, which kills the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1073 subprocess with a @code{SIGHUP} signal (@pxref{Signals to Processes}).
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1074 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1075
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1076 @node Filter Functions
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1077 @subsection Process Filter Functions
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1078 @cindex filter function
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1079 @cindex process filter
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1080
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1081 A process @dfn{filter function} is a function that receives the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1082 standard output from the associated process. If a process has a filter,
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
1083 then @emph{all} output from that process is passed to the filter. The
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
1084 process buffer is used directly for output from the process only when
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
1085 there is no filter.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1086
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1087 The filter function can only be called when Emacs is waiting for
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1088 something, because process output arrives only at such times. Emacs
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1089 waits when reading terminal input, in @code{sit-for} and
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1090 @code{sleep-for} (@pxref{Waiting}), and in @code{accept-process-output}
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1091 (@pxref{Accepting Output}).
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1092
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1093 A filter function must accept two arguments: the associated process
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1094 and a string, which is output just received from it. The function is
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1095 then free to do whatever it chooses with the output.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1096
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1097 Quitting is normally inhibited within a filter function---otherwise,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1098 the effect of typing @kbd{C-g} at command level or to quit a user
66152
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1099 command would be unpredictable. If you want to permit quitting inside
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1100 a filter function, bind @code{inhibit-quit} to @code{nil}. In most
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1101 cases, the right way to do this is with the macro
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1102 @code{with-local-quit}. @xref{Quitting}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1103
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1104 If an error happens during execution of a filter function, it is
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1105 caught automatically, so that it doesn't stop the execution of whatever
12125
995be67f3fd1 updates for version 19.29.
Melissa Weisshaus <melissa@gnu.org>
parents: 12098
diff changeset
1106 program was running when the filter function was started. However, if
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1107 @code{debug-on-error} is non-@code{nil}, the error-catching is turned
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1108 off. This makes it possible to use the Lisp debugger to debug the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1109 filter function. @xref{Debugger}.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1110
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1111 Many filter functions sometimes or always insert the text in the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1112 process's buffer, mimicking the actions of Emacs when there is no
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1113 filter. Such filter functions need to use @code{set-buffer} in order to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1114 be sure to insert in that buffer. To avoid setting the current buffer
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1115 semipermanently, these filter functions must save and restore the
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1116 current buffer. They should also update the process marker, and in some
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1117 cases update the value of point. Here is how to do these things:
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1118
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1119 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1120 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1121 (defun ordinary-insertion-filter (proc string)
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1122 (with-current-buffer (process-buffer proc)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1123 (let ((moving (= (point) (process-mark proc))))
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1124 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1125 @group
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1126 (save-excursion
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1127 ;; @r{Insert the text, advancing the process marker.}
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1128 (goto-char (process-mark proc))
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1129 (insert string)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1130 (set-marker (process-mark proc) (point)))
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1131 (if moving (goto-char (process-mark proc))))))
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1132 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1133 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1134
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1135 @noindent
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1136 The reason to use @code{with-current-buffer}, rather than using
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1137 @code{save-excursion} to save and restore the current buffer, is so as
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1138 to preserve the change in point made by the second call to
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1139 @code{goto-char}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1140
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1141 To make the filter force the process buffer to be visible whenever new
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1142 text arrives, insert the following line just before the
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1143 @code{with-current-buffer} construct:
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1144
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1145 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1146 (display-buffer (process-buffer proc))
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1147 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1148
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1149 To force point to the end of the new output, no matter where it was
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1150 previously, eliminate the variable @code{moving} and call
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1151 @code{goto-char} unconditionally.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1152
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1153 In earlier Emacs versions, every filter function that did regular
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1154 expression searching or matching had to explicitly save and restore the
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1155 match data. Now Emacs does this automatically for filter functions;
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1156 they never need to do it explicitly. @xref{Match Data}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1157
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1158 A filter function that writes the output into the buffer of the
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1159 process should check whether the buffer is still alive. If it tries to
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1160 insert into a dead buffer, it will get an error. The expression
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1161 @code{(buffer-name (process-buffer @var{process}))} returns @code{nil}
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1162 if the buffer is dead.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1163
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1164 The output to the function may come in chunks of any size. A program
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1165 that produces the same output twice in a row may send it as one batch of
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1166 200 characters one time, and five batches of 40 characters the next. If
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1167 the filter looks for certain text strings in the subprocess output, make
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1168 sure to handle the case where one of these strings is split across two
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1169 or more batches of output.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1170
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1171 @defun set-process-filter process filter
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1172 This function gives @var{process} the filter function @var{filter}. If
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1173 @var{filter} is @code{nil}, it gives the process no filter.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1174 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1175
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1176 @defun process-filter process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1177 This function returns the filter function of @var{process}, or @code{nil}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1178 if it has none.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1179 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1180
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1181 Here is an example of use of a filter function:
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1182
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1183 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1184 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1185 (defun keep-output (process output)
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1186 (setq kept (cons output kept)))
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1187 @result{} keep-output
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1188 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1189 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1190 (setq kept nil)
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1191 @result{} nil
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1192 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1193 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1194 (set-process-filter (get-process "shell") 'keep-output)
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1195 @result{} keep-output
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1196 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1197 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1198 (process-send-string "shell" "ls ~/other\n")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1199 @result{} nil
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1200 kept
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1201 @result{} ("lewis@@slug[8] % "
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1202 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1203 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1204 "FINAL-W87-SHORT.MSS backup.otl kolstad.mss~
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1205 address.txt backup.psf kolstad.psf
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1206 backup.bib~ david.mss resume-Dec-86.mss~
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1207 backup.err david.psf resume-Dec.psf
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1208 backup.mss dland syllabus.mss
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1209 "
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1210 "#backups.mss# backup.mss~ kolstad.mss
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1211 ")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1212 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1213 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1214
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1215 @ignore @c The code in this example doesn't show the right way to do things.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1216 Here is another, more realistic example, which demonstrates how to use
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1217 the process mark to do insertion in the same fashion as is done when
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1218 there is no filter function:
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1219
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1220 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1221 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1222 ;; @r{Insert input in the buffer specified by @code{my-shell-buffer}}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1223 ;; @r{and make sure that buffer is shown in some window.}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1224 (defun my-process-filter (proc str)
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1225 (let ((cur (selected-window))
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1226 (pop-up-windows t))
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1227 (pop-to-buffer my-shell-buffer)
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1228 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1229 @group
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1230 (goto-char (point-max))
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1231 (insert str)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1232 (set-marker (process-mark proc) (point-max))
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1233 (select-window cur)))
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1234 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1235 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1236 @end ignore
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1237
51993
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1238 @node Decoding Output
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1239 @subsection Decoding Process Output
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1240
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1241 When Emacs writes process output directly into a multibyte buffer,
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1242 it decodes the output according to the process output coding system.
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1243 If the coding system is @code{raw-text} or @code{no-conversion}, Emacs
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1244 converts the unibyte output to multibyte using
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
1245 @code{string-to-multibyte}, and inserts the resulting multibyte text.
51993
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1246
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1247 You can use @code{set-process-coding-system} to specify which coding
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1248 system to use (@pxref{Process Information}). Otherwise, the coding
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1249 system comes from @code{coding-system-for-read}, if that is
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1250 non-@code{nil}; or else from the defaulting mechanism (@pxref{Default
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1251 Coding Systems}).
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1252
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1253 @strong{Warning:} Coding systems such as @code{undecided} which
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1254 determine the coding system from the data do not work entirely
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1255 reliably with asynchronous subprocess output. This is because Emacs
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1256 has to process asynchronous subprocess output in batches, as it
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1257 arrives. Emacs must try to detect the proper coding system from one
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1258 batch at a time, and this does not always work. Therefore, if at all
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1259 possible, specify a coding system that determines both the character
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1260 code conversion and the end of line conversion---that is, one like
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1261 @code{latin-1-unix}, rather than @code{undecided} or @code{latin-1}.
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1262
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1263 @cindex filter multibyte flag, of process
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1264 @cindex process filter multibyte flag
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1265 When Emacs calls a process filter function, it provides the process
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1266 output as a multibyte string or as a unibyte string according to the
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1267 process's filter multibyte flag. If the flag is non-@code{nil}, Emacs
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1268 decodes the output according to the process output coding system to
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1269 produce a multibyte string, and passes that to the process. If the
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1270 flag is @code{nil}, Emacs puts the output into a unibyte string, with
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1271 no decoding, and passes that.
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1272
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1273 When you create a process, the filter multibyte flag takes its
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1274 initial value from @code{default-enable-multibyte-characters}. If you
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1275 want to change the flag later on, use
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1276 @code{set-process-filter-multibyte}.
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1277
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1278 @defun set-process-filter-multibyte process multibyte
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1279 This function sets the filter multibyte flag of @var{process}
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1280 to @var{multibyte}.
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1281 @end defun
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1282
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1283 @defun process-filter-multibyte-p process
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1284 This function returns the filter multibyte flag of @var{process}.
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1285 @end defun
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1286
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1287 @node Accepting Output
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1288 @subsection Accepting Output from Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1289
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1290 Output from asynchronous subprocesses normally arrives only while
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1291 Emacs is waiting for some sort of external event, such as elapsed time
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1292 or terminal input. Occasionally it is useful in a Lisp program to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1293 explicitly permit output to arrive at a specific point, or even to wait
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1294 until output arrives from a process.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1295
56703
fdf8546f215b (Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents: 56215
diff changeset
1296 @defun accept-process-output &optional process seconds millisec just-this-one
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1297 This function allows Emacs to read pending output from processes. The
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1298 output is inserted in the associated buffers or given to their filter
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1299 functions. If @var{process} is non-@code{nil} then this function does
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1300 not return until some output has been received from @var{process}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1301
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1302 @c Emacs 19 feature
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1303 The arguments @var{seconds} and @var{millisec} let you specify timeout
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1304 periods. The former specifies a period measured in seconds and the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1305 latter specifies one measured in milliseconds. The two time periods
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1306 thus specified are added together, and @code{accept-process-output}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1307 returns after that much time whether or not there has been any
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1308 subprocess output.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1309
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1310 The argument @var{seconds} need not be an integer. If it is a floating
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1311 point number, this function waits for a fractional number of seconds.
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1312 Some systems support only a whole number of seconds; on these systems,
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
1313 @var{seconds} is rounded down.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1314
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1315 Not all operating systems support waiting periods other than multiples
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1316 of a second; on those that do not, you get an error if you specify
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1317 nonzero @var{millisec}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1318
59996
aac0a33f5772 Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents: 58500
diff changeset
1319 @c Emacs 22.1 feature
56703
fdf8546f215b (Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents: 56215
diff changeset
1320 If @var{process} is a process, and the argument @var{just-this-one} is
58405
4fe765649696 (Synchronous Processes, Output from Processes):
Jesper Harder <harder@ifa.au.dk>
parents: 57670
diff changeset
1321 non-@code{nil}, only output from that process is handled, suspending output
56703
fdf8546f215b (Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents: 56215
diff changeset
1322 from other processes until some output has been received from that
fdf8546f215b (Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents: 56215
diff changeset
1323 process or the timeout expires. If @var{just-this-one} is an integer,
fdf8546f215b (Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents: 56215
diff changeset
1324 also inhibit running timers. This feature is generally not
fdf8546f215b (Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents: 56215
diff changeset
1325 recommended, but may be necessary for specific applications, such as
fdf8546f215b (Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents: 56215
diff changeset
1326 speech synthesis.
fdf8546f215b (Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents: 56215
diff changeset
1327
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1328 The function @code{accept-process-output} returns non-@code{nil} if it
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1329 did get some output, or @code{nil} if the timeout expired before output
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1330 arrived.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1331 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1332
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1333 @node Sentinels
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1334 @section Sentinels: Detecting Process Status Changes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1335 @cindex process sentinel
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1336 @cindex sentinel
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1337
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1338 A @dfn{process sentinel} is a function that is called whenever the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1339 associated process changes status for any reason, including signals
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1340 (whether sent by Emacs or caused by the process's own actions) that
44345
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1341 terminate, stop, or continue the process. The process sentinel is
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1342 also called if the process exits. The sentinel receives two
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1343 arguments: the process for which the event occurred, and a string
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1344 describing the type of event.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1345
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1346 The string describing the event looks like one of the following:
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1347
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1348 @itemize @bullet
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46340
diff changeset
1349 @item
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1350 @code{"finished\n"}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1351
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1352 @item
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1353 @code{"exited abnormally with code @var{exitcode}\n"}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1354
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1355 @item
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1356 @code{"@var{name-of-signal}\n"}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1357
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1358 @item
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1359 @code{"@var{name-of-signal} (core dumped)\n"}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1360 @end itemize
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1361
44345
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1362 A sentinel runs only while Emacs is waiting (e.g., for terminal
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1363 input, or for time to elapse, or for process output). This avoids the
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1364 timing errors that could result from running them at random places in
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1365 the middle of other Lisp programs. A program can wait, so that
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1366 sentinels will run, by calling @code{sit-for} or @code{sleep-for}
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
1367 (@pxref{Waiting}), or @code{accept-process-output} (@pxref{Accepting
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1368 Output}). Emacs also allows sentinels to run when the command loop is
44345
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1369 reading input. @code{delete-process} calls the sentinel when it
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1370 terminates a running process.
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1371
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1372 Emacs does not keep a queue of multiple reasons to call the sentinel
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1373 of one process; it records just the current status and the fact that
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1374 there has been a change. Therefore two changes in status, coming in
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1375 quick succession, can call the sentinel just once. However, process
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1376 termination will always run the sentinel exactly once. This is
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1377 because the process status can't change again after termination.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1378
66152
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1379 Emacs explicitly checks for output from the process before running
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1380 the process sentinel. Once the sentinel runs due to process
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1381 termination, no further output can arrive from the process.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1382
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1383 A sentinel that writes the output into the buffer of the process
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1384 should check whether the buffer is still alive. If it tries to insert
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1385 into a dead buffer, it will get an error. If the buffer is dead,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1386 @code{(buffer-name (process-buffer @var{process}))} returns @code{nil}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1387
66152
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1388 Quitting is normally inhibited within a sentinel---otherwise, the
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1389 effect of typing @kbd{C-g} at command level or to quit a user command
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1390 would be unpredictable. If you want to permit quitting inside a
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1391 sentinel, bind @code{inhibit-quit} to @code{nil}. In most cases, the
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1392 right way to do this is with the macro @code{with-local-quit}.
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1393 @xref{Quitting}.
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1394
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1395 If an error happens during execution of a sentinel, it is caught
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1396 automatically, so that it doesn't stop the execution of whatever
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1397 programs was running when the sentinel was started. However, if
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1398 @code{debug-on-error} is non-@code{nil}, the error-catching is turned
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1399 off. This makes it possible to use the Lisp debugger to debug the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1400 sentinel. @xref{Debugger}.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1401
44428
7e1a0877a121 Explain that sentinels cannot run recursively.
Richard M. Stallman <rms@gnu.org>
parents: 44345
diff changeset
1402 While a sentinel is running, the process sentinel is temporarily
7e1a0877a121 Explain that sentinels cannot run recursively.
Richard M. Stallman <rms@gnu.org>
parents: 44345
diff changeset
1403 set to @code{nil} so that the sentinel won't run recursively.
7e1a0877a121 Explain that sentinels cannot run recursively.
Richard M. Stallman <rms@gnu.org>
parents: 44345
diff changeset
1404 For this reason it is not possible for a sentinel to specify
7e1a0877a121 Explain that sentinels cannot run recursively.
Richard M. Stallman <rms@gnu.org>
parents: 44345
diff changeset
1405 a new sentinel.
7e1a0877a121 Explain that sentinels cannot run recursively.
Richard M. Stallman <rms@gnu.org>
parents: 44345
diff changeset
1406
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1407 In earlier Emacs versions, every sentinel that did regular expression
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1408 searching or matching had to explicitly save and restore the match data.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1409 Now Emacs does this automatically for sentinels; they never need to do
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1410 it explicitly. @xref{Match Data}.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1411
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1412 @defun set-process-sentinel process sentinel
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1413 This function associates @var{sentinel} with @var{process}. If
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1414 @var{sentinel} is @code{nil}, then the process will have no sentinel.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1415 The default behavior when there is no sentinel is to insert a message in
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1416 the process's buffer when the process status changes.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1417
44345
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1418 Changes in process sentinel take effect immediately---if the sentinel
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1419 is slated to be run but has not been called yet, and you specify a new
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1420 sentinel, the eventual call to the sentinel will use the new one.
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1421
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1422 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1423 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1424 (defun msg-me (process event)
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1425 (princ
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1426 (format "Process: %s had the event `%s'" process event)))
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1427 (set-process-sentinel (get-process "shell") 'msg-me)
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1428 @result{} msg-me
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1429 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1430 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1431 (kill-process (get-process "shell"))
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1432 @print{} Process: #<process shell> had the event `killed'
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1433 @result{} #<process shell>
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1434 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1435 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1436 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1437
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1438 @defun process-sentinel process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1439 This function returns the sentinel of @var{process}, or @code{nil} if it
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1440 has none.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1441 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1442
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1443 @defun waiting-for-user-input-p
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1444 While a sentinel or filter function is running, this function returns
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1445 non-@code{nil} if Emacs was waiting for keyboard input from the user at
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1446 the time the sentinel or filter function was called, @code{nil} if it
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1447 was not.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1448 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1449
46340
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1450 @node Query Before Exit
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46340
diff changeset
1451 @section Querying Before Exit
46340
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1452
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1453 When Emacs exits, it terminates all its subprocesses by sending them
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
1454 the @code{SIGHUP} signal. Because subprocesses may be doing
46340
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1455 valuable work, Emacs normally asks the user to confirm that it is ok
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1456 to terminate them. Each process has a query flag which, if
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1457 non-@code{nil}, says that Emacs should ask for confirmation before
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1458 exiting and thus killing that process. The default for the query flag
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1459 is @code{t}, meaning @emph{do} query.
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1460
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1461 @tindex process-query-on-exit-flag
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1462 @defun process-query-on-exit-flag process
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1463 This returns the query flag of @var{process}.
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1464 @end defun
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1465
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1466 @tindex set-process-query-on-exit-flag
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1467 @defun set-process-query-on-exit-flag process flag
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1468 This function sets the query flag of @var{process} to @var{flag}. It
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1469 returns @var{flag}.
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1470
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1471 @smallexample
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1472 @group
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1473 ;; @r{Don't query about the shell process}
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1474 (set-process-query-on-exit-flag (get-process "shell") nil)
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1475 @result{} t
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1476 @end group
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1477 @end smallexample
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1478 @end defun
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1479
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1480 @defun process-kill-without-query process &optional do-query
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1481 This function clears the query flag of @var{process}, so that
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1482 Emacs will not query the user on account of that process.
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1483
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1484 Actually, the function does more than that: it returns the old value of
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1485 the process's query flag, and sets the query flag to @var{do-query}.
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1486 Please don't use this function to do those things any more---please
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1487 use the newer, cleaner functions @code{process-query-on-exit-flag} and
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1488 @code{set-process-query-on-exit-flag} in all but the simplest cases.
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1489 The only way you should use @code{process-kill-without-query} nowadays
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1490 is like this:
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1491
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1492 @smallexample
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1493 @group
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1494 ;; @r{Don't query about the shell process}
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1495 (process-kill-without-query (get-process "shell"))
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1496 @end group
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1497 @end smallexample
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1498 @end defun
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1499
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1500 @node Transaction Queues
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1501 @section Transaction Queues
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1502 @cindex transaction queue
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1503
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1504 You can use a @dfn{transaction queue} to communicate with a subprocess
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1505 using transactions. First use @code{tq-create} to create a transaction
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1506 queue communicating with a specified process. Then you can call
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1507 @code{tq-enqueue} to send a transaction.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1508
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1509 @defun tq-create process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1510 This function creates and returns a transaction queue communicating with
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1511 @var{process}. The argument @var{process} should be a subprocess
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1512 capable of sending and receiving streams of bytes. It may be a child
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
1513 process, or it may be a TCP connection to a server, possibly on another
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1514 machine.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1515 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1516
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1517 @defun tq-enqueue queue question regexp closure fn
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1518 This function sends a transaction to queue @var{queue}. Specifying the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1519 queue has the effect of specifying the subprocess to talk to.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1520
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
1521 The argument @var{question} is the outgoing message that starts the
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1522 transaction. The argument @var{fn} is the function to call when the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1523 corresponding answer comes back; it is called with two arguments:
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1524 @var{closure}, and the answer received.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1525
39426
4520697c8aa5 (tq-enqueue): Clarify meaning of REGEXP.
Richard M. Stallman <rms@gnu.org>
parents: 27370
diff changeset
1526 The argument @var{regexp} is a regular expression that should match
4520697c8aa5 (tq-enqueue): Clarify meaning of REGEXP.
Richard M. Stallman <rms@gnu.org>
parents: 27370
diff changeset
1527 text at the end of the entire answer, but nothing before; that's how
4520697c8aa5 (tq-enqueue): Clarify meaning of REGEXP.
Richard M. Stallman <rms@gnu.org>
parents: 27370
diff changeset
1528 @code{tq-enqueue} determines where the answer ends.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1529
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1530 The return value of @code{tq-enqueue} itself is not meaningful.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1531 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1532
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1533 @defun tq-close queue
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1534 Shut down transaction queue @var{queue}, waiting for all pending transactions
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1535 to complete, and then terminate the connection or child process.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1536 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1537
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1538 Transaction queues are implemented by means of a filter function.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1539 @xref{Filter Functions}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1540
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1541 @node Network
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1542 @section Network Connections
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1543 @cindex network connection
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1544 @cindex TCP
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1545 @cindex UDP
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1546
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1547 Emacs Lisp programs can open stream (TCP) and datagram (UDP) network
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1548 connections to other processes on the same machine or other machines.
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1549 A network connection is handled by Lisp much like a subprocess, and is
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1550 represented by a process object. However, the process you are
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1551 communicating with is not a child of the Emacs process, so it has no
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
1552 process @acronym{ID}, and you can't kill it or send it signals. All you
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1553 can do is send and receive data. @code{delete-process} closes the
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1554 connection, but does not kill the program at the other end; that
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1555 program must decide what to do about closure of the connection.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1556
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1557 Lisp programs can listen for connections by creating network
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1558 servers. A network server is also represented by a kind of process
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1559 object, but unlike a network connection, the network server never
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1560 transfers data itself. When it receives a connection request, it
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1561 creates a new network connection to represent the connection just
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1562 made. (The network connection inherits certain information, including
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1563 the process plist, from the server.) The network server then goes
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1564 back to listening for more connection requests.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1565
52818
39239421c7e3 (Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents: 52759
diff changeset
1566 Network connections and servers are created by calling
39239421c7e3 (Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents: 52759
diff changeset
1567 @code{make-network-process} with an argument list consisting of
39239421c7e3 (Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents: 52759
diff changeset
1568 keyword/argument pairs, for example @code{:server t} to create a
39239421c7e3 (Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents: 52759
diff changeset
1569 server process, or @code{:type 'datagram} to create a datagram
52830
b4281fb5cff8 (Network): Fix typo in xref (from Robert J. Chassell).
Kim F. Storm <storm@cua.dk>
parents: 52818
diff changeset
1570 connection. @xref{Low-Level Network}, for details. You can also use
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
1571 the @code{open-network-stream} function described below.
52818
39239421c7e3 (Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents: 52759
diff changeset
1572
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1573 You can distinguish process objects representing network connections
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1574 and servers from those representing subprocesses with the
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1575 @code{process-status} function. The possible status values for
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1576 network connections are @code{open}, @code{closed}, @code{connect},
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1577 and @code{failed}. For a network server, the status is always
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1578 @code{listen}. None of those values is possible for a real
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1579 subprocess. @xref{Process Information}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1580
54265
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
1581 You can stop and resume operation of a network process by calling
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1582 @code{stop-process} and @code{continue-process}. For a server
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1583 process, being stopped means not accepting new connections. (Up to 5
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1584 connection requests will be queued for when you resume the server; you
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1585 can increase this limit, unless it is imposed by the operating
64720
3d8efebded47 Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 63583
diff changeset
1586 system.) For a network stream connection, being stopped means not
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1587 processing input (any arriving input waits until you resume the
52695
e5c94aabfe90 (Network): Say what stopped datagram connections do.
Richard M. Stallman <rms@gnu.org>
parents: 52598
diff changeset
1588 connection). For a datagram connection, some number of packets may be
e5c94aabfe90 (Network): Say what stopped datagram connections do.
Richard M. Stallman <rms@gnu.org>
parents: 52598
diff changeset
1589 queued but input may be lost. You can use the function
e5c94aabfe90 (Network): Say what stopped datagram connections do.
Richard M. Stallman <rms@gnu.org>
parents: 52598
diff changeset
1590 @code{process-command} to determine whether a network connection or
e5c94aabfe90 (Network): Say what stopped datagram connections do.
Richard M. Stallman <rms@gnu.org>
parents: 52598
diff changeset
1591 server is stopped; a non-@code{nil} value means yes.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1592
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1593 @defun open-network-stream name buffer-or-name host service
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1594 This function opens a TCP connection, and returns a process object
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1595 that represents the connection.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1596
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1597 The @var{name} argument specifies the name for the process object. It
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1598 is modified as necessary to make it unique.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1599
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1600 The @var{buffer-or-name} argument is the buffer to associate with the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1601 connection. Output from the connection is inserted in the buffer,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1602 unless you specify a filter function to handle the output. If
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1603 @var{buffer-or-name} is @code{nil}, it means that the connection is not
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1604 associated with any buffer.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1605
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1606 The arguments @var{host} and @var{service} specify where to connect to;
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1607 @var{host} is the host name (a string), and @var{service} is the name of
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1608 a defined network service (a string) or a port number (an integer).
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1609 @end defun
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51994
diff changeset
1610
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1611 @defun process-contact process &optional key
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1612 This function returns information about how a network process was set
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1613 up. For a connection, when @var{key} is @code{nil}, it returns
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1614 @code{(@var{hostname} @var{service})} which specifies what you
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1615 connected to.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1616
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1617 If @var{key} is @code{t}, the value is the complete status information
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1618 for the connection or server; that is, the list of keywords and values
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1619 specified in @code{make-network-process}, except that some of the
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1620 values represent the current status instead of what you specified:
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1621
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1622 @table @code
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1623 @item :buffer
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1624 The associated value is the process buffer.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1625 @item :filter
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1626 The associated value is the process filter function.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1627 @item :sentinel
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1628 The associated value is the process sentinel function.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1629 @item :remote
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1630 In a connection, this is the address in internal format of the remote peer.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1631 @item :local
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1632 The local address, in internal format.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1633 @item :service
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1634 In a server, if you specified @code{t} for @var{service},
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1635 this value is the actual port number.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1636 @end table
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1637
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1638 @code{:local} and @code{:remote} are included even if they were not
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1639 specified explicitly in @code{make-network-process}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1640
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1641 If @var{key} is a keyword, the function returns the value corresponding
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1642 to that keyword.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1643
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1644 For an ordinary child process, this function always returns @code{t}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1645 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1646
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1647 @node Network Servers
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1648 @section Network Servers
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1649
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1650 You create a server by calling @code{make-network-process} with
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1651 @code{:server t}. The server will listen for connection requests from
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1652 clients. When it accepts a client connection request, that creates a
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1653 new network connection, itself a process object, with the following
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1654 parameters:
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1655
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1656 @itemize @bullet
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1657 @item
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1658 The connection's process name is constructed by concatenating the
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1659 server process' @var{name} with a client identification string. The
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1660 client identification string for an IPv4 connection looks like
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1661 @samp{<@var{a}.@var{b}.@var{c}.@var{d}:@var{p}>}. Otherwise, it is a
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1662 unique number in brackets, as in @samp{<@var{nnn}>}. The number
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1663 is unique for each connection in the Emacs session.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1664
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1665 @item
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1666 If the server's filter is non-@code{nil}, the connection process does
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1667 not get a separate process buffer; otherwise, Emacs creates a new
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1668 buffer for the purpose. The buffer name is the server's buffer name
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1669 or process name, concatenated with the client identification string.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1670
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1671 The server's process buffer value is never used directly by Emacs, but
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1672 it is passed to the log function, which can log connections by
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1673 inserting text there.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1674
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1675 @item
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1676 The communication type and the process filter and sentinel are
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1677 inherited from those of the server. The server never directly
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1678 uses its filter and sentinel; their sole purpose is to initialize
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1679 connections made to the server.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1680
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1681 @item
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1682 The connection's process contact info is set according to the client's
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1683 addressing information (typically an IP address and a port number).
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1684 This information is associated with the @code{process-contact}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1685 keywords @code{:host}, @code{:service}, @code{:remote}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1686
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1687 @item
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1688 The connection's local address is set up according to the port
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1689 number used for the connection.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1690
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1691 @item
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1692 The client process' plist is initialized from the server's plist.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1693 @end itemize
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1694
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1695 @node Datagrams
56703
fdf8546f215b (Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents: 56215
diff changeset
1696 @section Datagrams
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1697 @cindex datagrams
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1698
54265
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
1699 A datagram connection communicates with individual packets rather
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
1700 than streams of data. Each call to @code{process-send} sends one
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
1701 datagram packet (@pxref{Input to Processes}), and each datagram
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
1702 received results in one call to the filter function.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1703
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1704 The datagram connection doesn't have to talk with the same remote
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1705 peer all the time. It has a @dfn{remote peer address} which specifies
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1706 where to send datagrams to. Each time an incoming datagram is passed
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1707 to the filter function, the peer address is set to the address that
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1708 datagram came from; that way, if the filter function sends a datagram,
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1709 it will go back to that place. You can specify the remote peer
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1710 address when you create the datagram connection using the
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1711 @code{:remote} keyword. You can change it later on by calling
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1712 @code{set-process-datagram-address}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1713
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1714 @defun process-datagram-address process
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1715 If @var{process} is a datagram connection or server, this function
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1716 returns its remote peer address.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1717 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1718
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1719 @defun set-process-datagram-address process address
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1720 If @var{process} is a datagram connection or server, this function
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1721 sets its remote peer address to @var{address}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1722 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1723
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1724 @node Low-Level Network
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1725 @section Low-Level Network Access
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1726
64913
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1727 You can also create network connections by operating at a lower
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1728 level that that of @code{open-network-stream}, using
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1729 @code{make-network-process}.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1730
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1731 @menu
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1732 * Make Network:: Using @code{make-network-process}.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1733 * Network Options:: Further control over network connections.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1734 * Network Feature Testing:: Determining which network features work on
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1735 the machine you are using.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1736 @end menu
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1737
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1738 @node Make Network
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1739 @subsection @code{make-network-process}
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1740
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1741 The basic function for creating network connections and network
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1742 servers is @code{make-network-process}. It can do either of those
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1743 jobs, depending on the arguments you give it.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1744
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1745 @defun make-network-process &rest args
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1746 This function creates a network connection or server and returns the
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1747 process object that represents it. The arguments @var{args} are a
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1748 list of keyword/argument pairs. Omitting a keyword is always
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1749 equivalent to specifying it with value @code{nil}, except for
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1750 @code{:coding}, @code{:filter-multibyte}, and @code{:reuseaddr}. Here
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1751 are the meaningful keywords:
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1752
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1753 @table @asis
62230
98c45ed7ca3f (Low-Level Network): Fix typo.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 62229
diff changeset
1754 @item :name @var{name}
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1755 Use the string @var{name} as the process name. It is modified if
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1756 necessary to make it unique.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1757
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1758 @item :type @var{type}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1759 Specify the communication type. A value of @code{nil} specifies a
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1760 stream connection (the default); @code{datagram} specifies a datagram
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1761 connection. Both connections and servers can be of either type.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1762
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1763 @item :server @var{server-flag}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1764 If @var{server-flag} is non-@code{nil}, create a server. Otherwise,
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1765 create a connection. For a stream type server, @var{server-flag} may
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1766 be an integer which then specifies the length of the queue of pending
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1767 connections to the server. The default queue length is 5.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1768
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1769 @item :host @var{host}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1770 Specify the host to connect to. @var{host} should be a host name or
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1771 internet address, as a string, or the symbol @code{local} to specify
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1772 the local host. If you specify @var{host} for a server, it must
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1773 specify a valid address for the local host, and only clients
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1774 connecting to that address will be accepted.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1775
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1776 @item :service @var{service}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1777 @var{service} specifies a port number to connect to, or, for a server,
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1778 the port number to listen on. It should be a service name that
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1779 translates to a port number, or an integer specifying the port number
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1780 directly. For a server, it can also be @code{t}, which means to let
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1781 the system select an unused port number.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1782
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1783 @item :family @var{family}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1784 @var{family} specifies the address (and protocol) family for
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1785 communication. @code{nil} stands for IPv4. @code{local} specifies a
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1786 Unix socket, in which case @var{host} is ignored.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1787
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1788 @item :local @var{local-address}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1789 For a server process, @var{local-address} is the address to listen on.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1790 It overrides @var{family}, @var{host} and @var{service}, and you
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1791 may as well not specify them.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1792
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1793 @item :remote @var{remote-address}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1794 For a connection, @var{remote-address} is the address to connect to.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1795 It overrides @var{family}, @var{host} and @var{service}, and you
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1796 may as well not specify them.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1797
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1798 For a datagram server, @var{remote-address} specifies the initial
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1799 setting of the remote datagram address.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1800
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1801 The format of @var{local-address} or @var{remote-address} depends on
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1802 the address family:
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1803
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1804 @itemize -
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1805 @item
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1806 An IPv4 address is represented as a vector of integers @code{[@var{a}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1807 @var{b} @var{c} @var{d} @var{p}]} corresponding to numeric IP address
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1808 @var{a}.@var{b}.@var{c}.@var{d} and port number @var{p}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1809
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1810 @item
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1811 A local address is represented as a string which specifies the address
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1812 in the local address space.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1813
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1814 @item
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1815 An ``unsupported family'' address is represented by a cons
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1816 @code{(@var{f} . @var{av})}, where @var{f} is the family number and
54265
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
1817 @var{av} is a vector specifying the socket address using one element
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
1818 per address data byte. Do not rely on this format in portable code,
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
1819 as it may depend on implementation defined constants, data sizes, and
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
1820 data structure alignment.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1821 @end itemize
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1822
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1823 @item :nowait @var{bool}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1824 If @var{bool} is non-@code{nil} for a stream connection, return
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1825 without waiting for the connection to complete. When the connection
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1826 succeeds or fails, Emacs will call the sentinel function, with a
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1827 second argument matching @code{"open"} (if successful) or
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1828 @code{"failed"}. The default is to block, so that
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1829 @code{make-network-process} does not return until the connection
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1830 has succeeded or failed.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1831
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1832 @item :stop @var{stopped}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1833 Start the network connection or server in the `stopped' state if
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1834 @var{stopped} is non-@code{nil}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1835
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1836 @item :buffer @var{buffer}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1837 Use @var{buffer} as the process buffer.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1838
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1839 @item :coding @var{coding}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1840 Use @var{coding} as the coding system for this process. To specify
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1841 different coding systems for decoding data from the connection and for
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1842 encoding data sent to it, specify @code{(@var{decoding} .
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1843 @var{encoding})} for @var{coding}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1844
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1845 If you don't specify this keyword at all, the default
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1846 is to determine the coding systems from the data.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1847
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1848 @item :noquery @var{query-flag}
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
1849 Initialize the process query flag to @var{query-flag}.
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
1850 @xref{Query Before Exit}.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1851
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1852 @item :filter @var{filter}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1853 Initialize the process filter to @var{filter}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1854
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1855 @item :filter-multibyte @var{bool}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1856 If @var{bool} is non-@code{nil}, strings given to the process filter
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1857 are multibyte, otherwise they are unibyte. If you don't specify this
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1858 keyword at all, the default is that the strings are multibyte if
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1859 @code{default-enable-multibyte-characters} is non-@code{nil}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1860
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1861 @item :sentinel @var{sentinel}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1862 Initialize the process sentinel to @var{sentinel}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1863
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1864 @item :log @var{log}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1865 Initialize the log function of a server process to @var{log}. The log
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1866 function is called each time the server accepts a network connection
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1867 from a client. The arguments passed to the log function are
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1868 @var{server}, @var{connection}, and @var{message}, where @var{server}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1869 is the server process, @var{connection} is the new process for the
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1870 connection, and @var{message} is a string describing what has
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1871 happened.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1872
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1873 @item :plist @var{plist}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1874 Initialize the process plist to @var{plist}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1875 @end table
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1876
64913
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1877 The original argument list, modified with the actual connection
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1878 information, is available via the @code{process-contact} function.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1879 @end defun
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1880
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1881 @node Network Options
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1882 @subsection Network Options
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1883
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1884 The following network options can be specified when you create a
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1885 network process. Except for @code{:reuseaddr}, you can also set or
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1886 modify these options later, using @code{set-network-process-option}.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1887
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1888 For a server process, the options specified with
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1889 @code{make-network-process} are not inherited by the client
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1890 connections, so you will need to set the necessary options for each
64913
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1891 child connection as it is created.
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1892
52598
a0ba017ef9ef (Low-Level Network): Fix typo.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52596
diff changeset
1893 @table @asis
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1894 @item :bindtodevice @var{device-name}
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1895 If @var{device-name} is a non-empty string identifying a network
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1896 interface name (see @code{network-interface-list}), only handle
54777
5745bf089073 Markup fixes.
Jesper Harder <harder@ifa.au.dk>
parents: 54265
diff changeset
1897 packets received on that interface. If @var{device-name} is @code{nil}
5745bf089073 Markup fixes.
Jesper Harder <harder@ifa.au.dk>
parents: 54265
diff changeset
1898 (the default), handle packets received on any interface.
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1899
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1900 Using this option may require special privileges on some systems.
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1901
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1902 @item :broadcast @var{broadcast-flag}
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1903 If @var{broadcast-flag} is non-@code{nil} for a datagram process, the
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1904 process will receive datagram packet sent to a broadcast address, and
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1905 be able to send packets to a broadcast address. Ignored for a stream
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1906 connection.
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1907
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1908 @item :dontroute @var{dontroute-flag}
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1909 If @var{dontroute-flag} is non-@code{nil}, the process can only send
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1910 to hosts on the same network as the local host.
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1911
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1912 @item :keepalive @var{keepalive-flag}
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1913 If @var{keepalive-flag} is non-@code{nil} for a stream connection,
54004
8cc16a7bf4ce (Low-Level Network): Fix a typo.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53292
diff changeset
1914 enable exchange of low-level keep-alive messages.
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1915
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1916 @item :linger @var{linger-arg}
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1917 If @var{linger-arg} is non-@code{nil}, wait for successful
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1918 transmission of all queued packets on the connection before it is
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1919 deleted (see @code{delete-process}). If @var{linger-arg} is an
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1920 integer, it specifies the maximum time in seconds to wait for queued
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1921 packets to be sent before closing the connection. Default is
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1922 @code{nil} which means to discard unsent queued packets when the
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1923 process is deleted.
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1924
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1925 @item :oobinline @var{oobinline-flag}
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1926 If @var{oobinline-flag} is non-@code{nil} for a stream connection,
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1927 receive out-of-band data in the normal data stream. Otherwise, ignore
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1928 out-of-band data.
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1929
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1930 @item :priority @var{priority}
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1931 Set the priority for packets sent on this connection to the integer
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1932 @var{priority}. The interpretation of this number is protocol
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1933 specific, such as setting the TOS (type of service) field on IP
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1934 packets sent on this connection. It may also have system dependent
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1935 effects, such as selecting a specific output queue on the network
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1936 interface.
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1937
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1938 @item :reuseaddr @var{reuseaddr-flag}
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1939 If @var{reuseaddr-flag} is non-@code{nil} (the default) for a stream
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1940 server process, allow this server to reuse a specific port number (see
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1941 @code{:service}) unless another process on this host is already
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1942 listening on that port. If @var{reuseaddr-flag} is @code{nil}, there
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1943 may be a period of time after the last use of that port (by any
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1944 process on the host), where it is not possible to make a new server on
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1945 that port.
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1946 @end table
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1947
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1948 @defun set-network-process-option process option value
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1949 This function sets or modifies a network option for network process
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1950 @var{process}. See @code{make-network-process} for details of options
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1951 @var{option} and their corresponding values @var{value}.
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1952
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1953 The current setting of an option is available via the
54864
ca548870d87a Markup fixes.
Jesper Harder <harder@ifa.au.dk>
parents: 54777
diff changeset
1954 @code{process-contact} function.
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1955 @end defun
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1956
64913
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1957 @node Network Feature Testing
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1958 @subsection Testing Availability of Network Features
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1959
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1960 To test for the availability of a given network feature, use
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1961 @code{featurep} like this:
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1962
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1963 @example
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1964 (featurep 'make-network-process '(@var{keyword} @var{value}))
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1965 @end example
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1966
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1967 @noindent
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1968 The result of the first form is @code{t} if it works to specify
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1969 @var{keyword} with value @var{value} in @code{make-network-process}.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1970 The result of the second form is @code{t} if @var{keyword} is
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1971 supported by @code{make-network-process}. Here are some of the
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1972 @var{keyword}---@var{value} pairs you can test in
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1973 this way.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1974
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1975 @table @code
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1976 @item (:nowait t)
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1977 Non-@code{nil} if non-blocking connect is supported.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1978 @item (:type datagram)
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1979 Non-@code{nil} if datagrams are supported.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1980 @item (:family local)
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1981 Non-@code{nil} if local (aka ``UNIX domain'') sockets are supported.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1982 @item (:service t)
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1983 Non-@code{nil} if the system can select the port for a server.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1984 @end table
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1985
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1986 To test for the availability of a given network option, use
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1987 @code{featurep} like this:
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1988
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1989 @example
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1990 (featurep 'make-network-process '@var{keyword})
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1991 @end example
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1992
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1993 @noindent
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1994 Here are some of the options you can test in this way.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1995
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1996 @table @code
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1997 @item :bindtodevice
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1998 @itemx :broadcast
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1999 @itemx :dontroute
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2000 @itemx :keepalive
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2001 @itemx :linger
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2002 @itemx :oobinline
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2003 @itemx :priority
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2004 @itemx :reuseaddr
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2005 That particular network option is supported by
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2006 @code{make-network-process} and @code{set-network-process-option}.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2007 @end table
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2008
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2009 @node Misc Network
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2010 @section Misc Network Facilities
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2011
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2012 These additional functions are useful for creating and operating
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2013 on network connections.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2014
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2015 @defun network-interface-list
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2016 This function returns a list describing the network interfaces
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2017 of the machine you are using. The value is an alist whose
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2018 elements have the form @code{(@var{name} . @var{address})}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2019 @var{address} has the same form as the @var{local-address}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2020 and @var{remote-address} arguments to @code{make-network-process}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2021 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2022
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2023 @defun network-interface-info ifname
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2024 This function returns information about the network interface named
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
2025 @var{ifname}. The value is a list of the form
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
2026 @code{(@var{addr} @var{bcast} @var{netmask} @var{hwaddr} @var{flags})}.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2027
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2028 @table @var
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2029 @item addr
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2030 The internet protocol address.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2031 @item bcast
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2032 The broadcast address.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2033 @item netmask
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2034 The network mask.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2035 @item hwaddr
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2036 The layer 2 address (Ethernet MAC address, for instance).
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2037 @item flags
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2038 The current flags of the interface.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2039 @end table
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2040 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2041
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2042 @defun format-network-address address &optional omit-port
52759
b85ed952e000 Fix typo.
Richard M. Stallman <rms@gnu.org>
parents: 52695
diff changeset
2043 This function converts the Lisp representation of a network address to
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2044 a string. For example, a five-element vector @code{[@var{a} @var{b}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2045 @var{c} @var{d} @var{p}]} represents an IP address
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2046 @var{a}.@var{b}.@var{c}.@var{d} and port number @var{p}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2047 @code{format-network-address} converts that to the string
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2048 @code{"@var{a}.@var{b}.@var{c}.@var{d}:@var{p}"}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2049
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2050 If @var{omit-port} is non-@code{nil}, the value does not include
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2051 the port number.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2052 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2053
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2054 @node Byte Packing
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2055 @section Packing and Unpacking Byte Arrays
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2056
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2057 This section describes how to pack and unpack arrays of bytes,
63563
c78918330811 (Byte Packing): Fix ungrammatical sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63562
diff changeset
2058 usually for binary network protocols. These functions convert byte arrays
c78918330811 (Byte Packing): Fix ungrammatical sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63562
diff changeset
2059 to alists, and vice versa. The byte array can be represented as a
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2060 unibyte string or as a vector of integers, while the alist associates
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2061 symbols either with fixed-size objects or with recursive sub-alists.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2062
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2063 @cindex serializing
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2064 @cindex deserializing
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2065 @cindex packing
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2066 @cindex unpacking
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2067 Conversion from byte arrays to nested alists is also known as
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2068 @dfn{deserializing} or @dfn{unpacking}, while going in the opposite
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2069 direction is also known as @dfn{serializing} or @dfn{packing}.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2070
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2071 @menu
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2072 * Bindat Spec:: Describing data layout.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2073 * Bindat Functions:: Doing the unpacking and packing.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2074 * Bindat Examples:: Samples of what bindat.el can do for you!
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2075 @end menu
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2076
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2077 @node Bindat Spec
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2078 @subsection Describing Data Layout
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2079
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2080 To control unpacking and packing, you write a @dfn{data layout
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2081 specification}, a special nested list describing named and typed
63568
3586a05f26ff Fix typo.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63563
diff changeset
2082 @dfn{fields}. This specification controls length of each field to be
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2083 processed, and how to pack or unpack it.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2084
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2085 @cindex endianness
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2086 @cindex big endian
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2087 @cindex little endian
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2088 @cindex network byte ordering
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2089 A field's @dfn{type} describes the size (in bytes) of the object
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2090 that the field represents and, in the case of multibyte fields, how
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
2091 the bytes are ordered within the field. The two possible orderings
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2092 are ``big endian'' (also known as ``network byte ordering'') and
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2093 ``little endian''. For instance, the number @code{#x23cd} (decimal
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2094 9165) in big endian would be the two bytes @code{#x23} @code{#xcd};
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2095 and in little endian, @code{#xcd} @code{#x23}. Here are the possible
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2096 type values:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2097
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2098 @table @code
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2099 @item u8
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2100 @itemx byte
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2101 Unsigned byte, with length 1.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2102
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2103 @item u16
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2104 @itemx word
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2105 @itemx short
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2106 Unsigned integer in network byte order, with length 2.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2107
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2108 @item u24
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2109 Unsigned integer in network byte order, with length 3.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2110
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2111 @item u32
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2112 @itemx dword
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2113 @itemx long
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2114 Unsigned integer in network byte order, with length 4.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2115 Note: These values may be limited by Emacs' integer implementation limits.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2116
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2117 @item u16r
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2118 @itemx u24r
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2119 @itemx u32r
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2120 Unsigned integer in little endian order, with length 2, 3 and 4, respectively.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2121
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2122 @item str @var{len}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2123 String of length @var{len}.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2124
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2125 @item strz @var{len}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2126 Zero-terminated string of length @var{len}.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2127
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2128 @item vec @var{len}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2129 Vector of @var{len} bytes.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2130
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2131 @item ip
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2132 Four-byte vector representing an Internet address. For example:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2133 @code{[127 0 0 1]} for localhost.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2134
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2135 @item bits @var{len}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2136 List of set bits in @var{len} bytes. The bytes are taken in big
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2137 endian order and the bits are numbered starting with @code{8 *
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
2138 @var{len} @minus{} 1} and ending with zero. For example: @code{bits
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2139 2} unpacks @code{#x28} @code{#x1c} to @code{(2 3 4 11 13)} and
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2140 @code{#x1c} @code{#x28} to @code{(3 5 10 11 12)}.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2141
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2142 @item (eval @var{form})
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2143 @var{form} is a Lisp expression evaluated at the moment the field is
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2144 unpacked or packed. The result of the evaluation should be one of the
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2145 above-listed type specifications.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2146 @end table
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2147
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2148 A field specification generally has the form @code{([@var{name}]
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2149 @var{handler})}. The square braces indicate that @var{name} is
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2150 optional. (Don't use names that are symbols meaningful as type
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2151 specifications (above) or handler specifications (below), since that
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2152 would be ambiguous.) @var{name} can be a symbol or the expression
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2153 @code{(eval @var{form})}, in which case @var{form} should evaluate to
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2154 a symbol.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2155
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2156 @var{handler} describes how to unpack or pack the field and can be one
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2157 of the following:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2158
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2159 @table @code
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2160 @item @var{type}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2161 Unpack/pack this field according to the type specification @var{type}.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2162
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2163 @item eval @var{form}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2164 Evaluate @var{form}, a Lisp expression, for side-effect only. If the
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2165 field name is specified, the value is bound to that field name.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2166 @var{form} can access and update these dynamically bound variables:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2167
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2168 @table @code
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2169 @item raw-data
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2170 The data as a byte array.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2171
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2172 @item pos
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2173 Current position of the unpacking or packing operation.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2174
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2175 @item struct
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2176 Alist.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2177
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2178 @item last
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2179 Value of the last field processed.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2180 @end table
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2181
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2182 @item fill @var{len}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2183 Skip @var{len} bytes. In packing, this leaves them unchanged,
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2184 which normally means they remain zero. In unpacking, this means
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2185 they are ignored.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2186
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2187 @item align @var{len}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2188 Skip to the next multiple of @var{len} bytes.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2189
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2190 @item struct @var{spec-name}
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
2191 Process @var{spec-name} as a sub-specification. This describes a
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2192 structure nested within another structure.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2193
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2194 @item union @var{form} (@var{tag} @var{spec})@dots{}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2195 @c ??? I don't see how one would actually use this.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2196 @c ??? what kind of expression would be useful for @var{form}?
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2197 Evaluate @var{form}, a Lisp expression, find the first @var{tag}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2198 that matches it, and process its associated data layout specification
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2199 @var{spec}. Matching can occur in one of three ways:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2200
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2201 @itemize
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2202 @item
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2203 If a @var{tag} has the form @code{(eval @var{expr})}, evaluate
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2204 @var{expr} with the variable @code{tag} dynamically bound to the value
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2205 of @var{form}. A non-@code{nil} result indicates a match.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2206
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2207 @item
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2208 @var{tag} matches if it is @code{equal} to the value of @var{form}.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2209
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2210 @item
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2211 @var{tag} matches unconditionally if it is @code{t}.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2212 @end itemize
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2213
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2214 @item repeat @var{count} @var{field-spec}@dots{}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2215 @var{count} may be an integer, or a list of one element naming a
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2216 previous field. For correct operation, each @var{field-spec} must
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2217 include a name.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2218 @c ??? What does it MEAN?
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2219 @end table
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2220
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2221 @node Bindat Functions
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2222 @subsection Functions to Unpack and Pack Bytes
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2223
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2224 In the following documentation, @var{spec} refers to a data layout
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2225 specification, @code{raw-data} to a byte array, and @var{struct} to an
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2226 alist representing unpacked field data.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2227
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2228 @defun bindat-unpack spec raw-data &optional pos
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2229 This function unpacks data from the byte array @code{raw-data}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2230 according to @var{spec}. Normally this starts unpacking at the
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2231 beginning of the byte array, but if @var{pos} is non-@code{nil}, it
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2232 specifies a zero-based starting position to use instead.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2233
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2234 The value is an alist or nested alist in which each element describes
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2235 one unpacked field.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2236 @end defun
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2237
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2238 @defun bindat-get-field struct &rest name
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2239 This function selects a field's data from the nested alist
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2240 @var{struct}. Usually @var{struct} was returned by
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2241 @code{bindat-unpack}. If @var{name} corresponds to just one argument,
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2242 that means to extract a top-level field value. Multiple @var{name}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2243 arguments specify repeated lookup of sub-structures. An integer name
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2244 acts as an array index.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2245
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2246 For example, if @var{name} is @code{(a b 2 c)}, that means to find
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2247 field @code{c} in the second element of subfield @code{b} of field
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2248 @code{a}. (This corresponds to @code{struct.a.b[2].c} in C.)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2249 @end defun
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2250
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2251 @defun bindat-length spec struct
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2252 @c ??? I don't understand this at all -- rms
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2253 This function returns the length in bytes of @var{struct}, according
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2254 to @var{spec}.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2255 @end defun
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2256
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2257 @defun bindat-pack spec struct &optional raw-data pos
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2258 This function returns a byte array packed according to @var{spec} from
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2259 the data in the alist @var{struct}. Normally it creates and fills a
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2260 new byte array starting at the beginning. However, if @var{raw-data}
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
2261 is non-@code{nil}, it specifies a pre-allocated string or vector to
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2262 pack into. If @var{pos} is non-@code{nil}, it specifies the starting
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2263 offset for packing into @code{raw-data}.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2264
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
2265 @c ??? Isn't this a bug? Shouldn't it always be unibyte?
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2266 Note: The result is a multibyte string; use @code{string-make-unibyte}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2267 on it to make it unibyte if necessary.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2268 @end defun
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2269
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2270 @defun bindat-ip-to-string ip
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2271 Convert the Internet address vector @var{ip} to a string in the usual
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2272 dotted notation.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2273
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2274 @example
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2275 (bindat-ip-to-string [127 0 0 1])
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2276 @result{} "127.0.0.1"
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2277 @end example
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2278 @end defun
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2279
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2280 @node Bindat Examples
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2281 @subsection Examples of Byte Unpacking and Packing
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2282
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2283 Here is a complete example of byte unpacking and packing:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2284
63569
bd65461db3b8 (Bindat Examples): Move @lisp to beginning of line. (Whitespace change.)
Luc Teirlinck <teirllm@auburn.edu>
parents: 63568
diff changeset
2285 @lisp
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2286 (defvar fcookie-index-spec
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2287 '((:version u32)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2288 (:count u32)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2289 (:longest u32)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2290 (:shortest u32)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2291 (:flags u32)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2292 (:delim u8)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2293 (:ignored fill 3)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2294 (:offset repeat (:count)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2295 (:foo u32)))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2296 "Description of a fortune cookie index file's contents.")
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2297
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2298 (defun fcookie (cookies &optional index)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2299 "Display a random fortune cookie from file COOKIES.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2300 Optional second arg INDEX specifies the associated index
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2301 filename, which is by default constructed by appending
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2302 \".dat\" to COOKIES. Display cookie text in possibly
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2303 new buffer \"*Fortune Cookie: BASENAME*\" where BASENAME
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2304 is COOKIES without the directory part."
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2305 (interactive "fCookies file: ")
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2306 (let* ((info (with-temp-buffer
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2307 (insert-file-contents-literally
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2308 (or index (concat cookies ".dat")))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2309 (bindat-unpack fcookie-index-spec
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2310 (buffer-string))))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2311 (sel (random (bindat-get-field info :count)))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2312 (beg (cdar (bindat-get-field info :offset sel)))
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2313 (end (or (cdar (bindat-get-field info
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2314 :offset (1+ sel)))
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2315 (nth 7 (file-attributes cookies)))))
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2316 (switch-to-buffer
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2317 (get-buffer-create
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2318 (format "*Fortune Cookie: %s*"
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2319 (file-name-nondirectory cookies))))
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2320 (erase-buffer)
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2321 (insert-file-contents-literally
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2322 cookies nil beg (- end 3))))
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2323
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2324 (defun fcookie-create-index (cookies &optional index delim)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2325 "Scan file COOKIES, and write out its index file.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2326 Optional second arg INDEX specifies the index filename,
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2327 which is by default constructed by appending \".dat\" to
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2328 COOKIES. Optional third arg DELIM specifies the unibyte
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2329 character which, when found on a line of its own in
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2330 COOKIES, indicates the border between entries."
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2331 (interactive "fCookies file: ")
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2332 (setq delim (or delim ?%))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2333 (let ((delim-line (format "\n%c\n" delim))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2334 (count 0)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2335 (max 0)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2336 min p q len offsets)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2337 (unless (= 3 (string-bytes delim-line))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2338 (error "Delimiter cannot be represented in one byte"))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2339 (with-temp-buffer
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2340 (insert-file-contents-literally cookies)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2341 (while (and (setq p (point))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2342 (search-forward delim-line (point-max) t)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2343 (setq len (- (point) 3 p)))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2344 (setq count (1+ count)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2345 max (max max len)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2346 min (min (or min max) len)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2347 offsets (cons (1- p) offsets))))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2348 (with-temp-buffer
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2349 (set-buffer-multibyte nil)
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2350 (insert
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2351 (string-make-unibyte
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2352 (bindat-pack
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2353 fcookie-index-spec
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2354 `((:version . 2)
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2355 (:count . ,count)
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2356 (:longest . ,max)
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2357 (:shortest . ,min)
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2358 (:flags . 0)
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2359 (:delim . ,delim)
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2360 (:offset . ,(mapcar (lambda (o)
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2361 (list (cons :foo o)))
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2362 (nreverse offsets)))))))
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2363 (let ((coding-system-for-write 'raw-text-unix))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2364 (write-file (or index (concat cookies ".dat")))))))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2365 @end lisp
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2366
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2367 Following is an example of defining and unpacking a complex structure.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2368 Consider the following C structures:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2369
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2370 @example
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2371 struct header @{
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2372 unsigned long dest_ip;
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2373 unsigned long src_ip;
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2374 unsigned short dest_port;
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2375 unsigned short src_port;
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2376 @};
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2377
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2378 struct data @{
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2379 unsigned char type;
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2380 unsigned char opcode;
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2381 unsigned long length; /* In little endian order */
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
2382 unsigned char id[8]; /* null-terminated string */
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2383 unsigned char data[/* (length + 3) & ~3 */];
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2384 @};
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2385
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2386 struct packet @{
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2387 struct header header;
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2388 unsigned char items;
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2389 unsigned char filler[3];
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2390 struct data item[/* items */];
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2391
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2392 @};
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2393 @end example
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2394
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2395 The corresponding data layout specification:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2396
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2397 @lisp
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2398 (setq header-spec
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2399 '((dest-ip ip)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2400 (src-ip ip)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2401 (dest-port u16)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2402 (src-port u16)))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2403
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2404 (setq data-spec
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2405 '((type u8)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2406 (opcode u8)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2407 (length u16r) ;; little endian order
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2408 (id strz 8)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2409 (data vec (length))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2410 (align 4)))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2411
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2412 (setq packet-spec
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2413 '((header struct header-spec)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2414 (items u8)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2415 (fill 3)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2416 (item repeat (items)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2417 (struct data-spec))))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2418 @end lisp
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2419
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2420 A binary data representation:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2421
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2422 @lisp
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2423 (setq binary-data
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2424 [ 192 168 1 100 192 168 1 101 01 28 21 32 2 0 0 0
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2425 2 3 5 0 ?A ?B ?C ?D ?E ?F 0 0 1 2 3 4 5 0 0 0
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2426 1 4 7 0 ?B ?C ?D ?E ?F ?G 0 0 6 7 8 9 10 11 12 0 ])
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2427 @end lisp
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2428
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2429 The corresponding decoded structure:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2430
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2431 @lisp
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2432 (setq decoded (bindat-unpack packet-spec binary-data))
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2433 @result{}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2434 ((header
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2435 (dest-ip . [192 168 1 100])
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2436 (src-ip . [192 168 1 101])
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2437 (dest-port . 284)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2438 (src-port . 5408))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2439 (items . 2)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2440 (item ((data . [1 2 3 4 5])
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2441 (id . "ABCDEF")
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2442 (length . 5)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2443 (opcode . 3)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2444 (type . 2))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2445 ((data . [6 7 8 9 10 11 12])
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2446 (id . "BCDEFG")
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2447 (length . 7)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2448 (opcode . 4)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2449 (type . 1))))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2450 @end lisp
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2451
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2452 Fetching data from this structure:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2453
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2454 @lisp
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2455 (bindat-get-field decoded 'item 1 'id)
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2456 @result{} "BCDEFG"
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2457 @end lisp
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2458
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51994
diff changeset
2459 @ignore
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51994
diff changeset
2460 arch-tag: ba9da253-e65f-4e7f-b727-08fba0a1df7a
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51994
diff changeset
2461 @end ignore