annotate doc/lispref/processes.texi @ 99684:f749d8b61704

* frames.texi (Color Parameters): Document alpha parameter.
author Chong Yidong <cyd@stupidchicken.com>
date Tue, 18 Nov 2008 07:05:26 +0000
parents 524aa1296742
children 2b9c924c3d42
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1 @c -*-texinfo-*-
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2 @c This is part of the GNU Emacs Lisp Reference Manual.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2001,
87649
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 85114
diff changeset
4 @c 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5 @c See the file elisp.texi for copying conditions.
84116
0ba80d073e27 (setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents: 84095
diff changeset
6 @setfilename ../../info/processes
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7 @node Processes, Display, Abbrevs, Top
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8 @chapter Processes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9 @cindex child process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10 @cindex parent process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11 @cindex subprocess
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12 @cindex process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14 In the terminology of operating systems, a @dfn{process} is a space in
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15 which a program can execute. Emacs runs in a process. Emacs Lisp
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16 programs can invoke other programs in processes of their own. These are
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17 called @dfn{subprocesses} or @dfn{child processes} of the Emacs process,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18 which is their @dfn{parent process}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20 A subprocess of Emacs may be @dfn{synchronous} or @dfn{asynchronous},
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21 depending on how it is created. When you create a synchronous
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22 subprocess, the Lisp program waits for the subprocess to terminate
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
23 before continuing execution. When you create an asynchronous
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
24 subprocess, it can run in parallel with the Lisp program. This kind of
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
25 subprocess is represented within Emacs by a Lisp object which is also
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
26 called a ``process.'' Lisp programs can use this object to communicate
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
27 with the subprocess or to control it. For example, you can send
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
28 signals, obtain status information, receive output from the process, or
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
29 send input to it.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
30
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
31 @defun processp object
98719
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
32 This function returns @code{t} if @var{object} represents an Emacs
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
33 subprocess, @code{nil} otherwise.
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
34 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
35
98719
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
36 In addition to subprocesses of the current Emacs session, you can
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
37 also access other processes running on your machine. @xref{System
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
38 Processes}.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
39
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
40 @menu
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
41 * Subprocess Creation:: Functions that start subprocesses.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
42 * Shell Arguments:: Quoting an argument to pass it to a shell.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
43 * Synchronous Processes:: Details of using synchronous subprocesses.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
44 * Asynchronous Processes:: Starting up an asynchronous subprocess.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
45 * Deleting Processes:: Eliminating an asynchronous subprocess.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
46 * Process Information:: Accessing run-status and other attributes.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
47 * Input to Processes:: Sending input to an asynchronous subprocess.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
48 * Signals to Processes:: Stopping, continuing or interrupting
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
49 an asynchronous subprocess.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
50 * Output from Processes:: Collecting output from an asynchronous subprocess.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
51 * Sentinels:: Sentinels run when process run-status changes.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
52 * Query Before Exit:: Whether to query if exiting will kill a process.
98719
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
53 * System Processes:: Accessing other processes running on your system.
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
54 * Transaction Queues:: Transaction-based communication with subprocesses.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
55 * Network:: Opening network connections.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
56 * Network Servers:: Network servers let Emacs accept net connections.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
57 * Datagrams:: UDP network connections.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
58 * Low-Level Network:: Lower-level but more general function
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
59 to create connections and servers.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
60 * Misc Network:: Additional relevant functions for network connections.
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
61 * Serial Ports:: Communicating with serial ports.
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
62 * Byte Packing:: Using bindat to pack and unpack binary data.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
63 @end menu
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
64
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
65 @node Subprocess Creation
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
66 @section Functions that Create Subprocesses
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
67
98877
1d1a44972ed4 (Synchronous Processes): Document `process-lines'.
Eli Zaretskii <eliz@gnu.org>
parents: 98725
diff changeset
68 There are three primitives that create a new subprocess in which to run
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
69 a program. One of them, @code{start-process}, creates an asynchronous
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
70 process and returns a process object (@pxref{Asynchronous Processes}).
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
71 The other two, @code{call-process} and @code{call-process-region},
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
72 create a synchronous process and do not return a process object
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
73 (@pxref{Synchronous Processes}).
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
74
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
75 Synchronous and asynchronous processes are explained in the following
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
76 sections. Since the three functions are all called in a similar
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
77 fashion, their common arguments are described here.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
78
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
79 @cindex execute program
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
80 @cindex @code{PATH} environment variable
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
81 @cindex @code{HOME} environment variable
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
82 In all cases, the function's @var{program} argument specifies the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
83 program to be run. An error is signaled if the file is not found or
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
84 cannot be executed. If the file name is relative, the variable
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
85 @code{exec-path} contains a list of directories to search. Emacs
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
86 initializes @code{exec-path} when it starts up, based on the value of
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
87 the environment variable @code{PATH}. The standard file name
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
88 constructs, @samp{~}, @samp{.}, and @samp{..}, are interpreted as
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
89 usual in @code{exec-path}, but environment variable substitutions
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
90 (@samp{$HOME}, etc.) are not recognized; use
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
91 @code{substitute-in-file-name} to perform them (@pxref{File Name
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
92 Expansion}). @code{nil} in this list refers to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
93 @code{default-directory}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
94
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
95 Executing a program can also try adding suffixes to the specified
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
96 name:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
97
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
98 @defvar exec-suffixes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
99 This variable is a list of suffixes (strings) to try adding to the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
100 specified program file name. The list should include @code{""} if you
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
101 want the name to be tried exactly as specified. The default value is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
102 system-dependent.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
103 @end defvar
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
104
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
105 @strong{Please note:} The argument @var{program} contains only the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
106 name of the program; it may not contain any command-line arguments. You
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
107 must use @var{args} to provide those.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
108
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
109 Each of the subprocess-creating functions has a @var{buffer-or-name}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
110 argument which specifies where the standard output from the program will
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
111 go. It should be a buffer or a buffer name; if it is a buffer name,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
112 that will create the buffer if it does not already exist. It can also
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
113 be @code{nil}, which says to discard the output unless a filter function
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
114 handles it. (@xref{Filter Functions}, and @ref{Read and Print}.)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
115 Normally, you should avoid having multiple processes send output to the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
116 same buffer because their output would be intermixed randomly.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
117
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
118 @cindex program arguments
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
119 All three of the subprocess-creating functions have a @code{&rest}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
120 argument, @var{args}. The @var{args} must all be strings, and they are
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
121 supplied to @var{program} as separate command line arguments. Wildcard
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
122 characters and other shell constructs have no special meanings in these
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
123 strings, since the strings are passed directly to the specified program.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
124
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
125 The subprocess gets its current directory from the value of
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
126 @code{default-directory} (@pxref{File Name Expansion}).
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
127
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
128 @cindex environment variables, subprocesses
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
129 The subprocess inherits its environment from Emacs, but you can
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
130 specify overrides for it with @code{process-environment}. @xref{System
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
131 Environment}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
132
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
133 @defvar exec-directory
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
134 @pindex movemail
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
135 The value of this variable is a string, the name of a directory that
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
136 contains programs that come with GNU Emacs, programs intended for Emacs
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
137 to invoke. The program @code{movemail} is an example of such a program;
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
138 Rmail uses it to fetch new mail from an inbox.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
139 @end defvar
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
140
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
141 @defopt exec-path
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
142 The value of this variable is a list of directories to search for
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
143 programs to run in subprocesses. Each element is either the name of a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
144 directory (i.e., a string), or @code{nil}, which stands for the default
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
145 directory (which is the value of @code{default-directory}).
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
146 @cindex program directories
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
147
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
148 The value of @code{exec-path} is used by @code{call-process} and
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
149 @code{start-process} when the @var{program} argument is not an absolute
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
150 file name.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
151 @end defopt
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
152
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
153 @node Shell Arguments
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
154 @section Shell Arguments
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
155 @cindex arguments for shell commands
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
156 @cindex shell command arguments
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
157
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
158 Lisp programs sometimes need to run a shell and give it a command
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
159 that contains file names that were specified by the user. These
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
160 programs ought to be able to support any valid file name. But the shell
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
161 gives special treatment to certain characters, and if these characters
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
162 occur in the file name, they will confuse the shell. To handle these
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
163 characters, use the function @code{shell-quote-argument}:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
164
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
165 @defun shell-quote-argument argument
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
166 This function returns a string which represents, in shell syntax,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
167 an argument whose actual contents are @var{argument}. It should
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
168 work reliably to concatenate the return value into a shell command
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
169 and then pass it to a shell for execution.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
170
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
171 Precisely what this function does depends on your operating system. The
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
172 function is designed to work with the syntax of your system's standard
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
173 shell; if you use an unusual shell, you will need to redefine this
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
174 function.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
175
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
176 @example
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
177 ;; @r{This example shows the behavior on GNU and Unix systems.}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
178 (shell-quote-argument "foo > bar")
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
179 @result{} "foo\\ \\>\\ bar"
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
180
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
181 ;; @r{This example shows the behavior on MS-DOS and MS-Windows.}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
182 (shell-quote-argument "foo > bar")
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
183 @result{} "\"foo > bar\""
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
184 @end example
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
185
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
186 Here's an example of using @code{shell-quote-argument} to construct
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
187 a shell command:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
188
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
189 @example
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
190 (concat "diff -c "
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
191 (shell-quote-argument oldfile)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
192 " "
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
193 (shell-quote-argument newfile))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
194 @end example
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
195 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
196
98945
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
197 @cindex quoting and unquoting shell command line
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
198 The following two functions help creating shell commands from
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
199 individual argument strings and taking shell command lines apart into
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
200 individual arguments.
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
201
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
202 @defun split-string-and-unquote string &optional separators
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
203 This function splits @var{string} into substrings at matches for the
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
204 regular expression @var{separators}, like @code{split-string} does
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
205 (@pxref{Creating Strings}), but it additionally removes quoting from
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
206 the substrings. It then makes a list of the substrings and returns
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
207 it.
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
208
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
209 If @var{separators} is omitted or nil, it defaults to @code{"\\s-+"},
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
210 which is a regular expression that matches one or more characters with
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
211 whitespace syntax (@pxref{Syntax Class Table}).
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
212
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
213 The quoting this function supports is of 2 styles: by enclosing a
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
214 whole string in double quotes @code{"@dots{}"}, or by quoting
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
215 individual characters with a backslash escape @samp{\}. The latter is
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
216 also used in Lisp strings, so this function can handle those as well.
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
217 @end defun
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
218
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
219 @defun combine-and-quote-strings list-of-strings &optional separator
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
220 This function concatenates @var{list-of-strings} into a single string,
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
221 quoting each string in the list that needs quoting as it goes. It
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
222 also sticks the @var{separator} string in between each pair of strings
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
223 in the result, and returns that result. If @var{separator} is omitted
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
224 or @code{nil}, it defaults to a blank @code{" "}.
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
225
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
226 The strings in @var{list-of-strings} that need quoting are those that
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
227 include @var{separator} as their substring. Quoting a string encloses
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
228 it in double quotes @code{"@dots{}"}. In the simplest case, if you
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
229 are consing a shell command from the individual command-line
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
230 arguments, every argument that includes embedded blanks will be
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
231 quoted.
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
232 @end defun
aaf4c3b3bb3e (Shell Arguments): Document `split-string-and-unquote' and
Eli Zaretskii <eliz@gnu.org>
parents: 98877
diff changeset
233
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
234 @node Synchronous Processes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
235 @section Creating a Synchronous Process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
236 @cindex synchronous subprocess
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
237
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
238 After a @dfn{synchronous process} is created, Emacs waits for the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
239 process to terminate before continuing. Starting Dired on GNU or
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
240 Unix@footnote{On other systems, Emacs uses a Lisp emulation of
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
241 @code{ls}; see @ref{Contents of Directories}.} is an example of this: it
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
242 runs @code{ls} in a synchronous process, then modifies the output
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
243 slightly. Because the process is synchronous, the entire directory
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
244 listing arrives in the buffer before Emacs tries to do anything with it.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
245
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
246 While Emacs waits for the synchronous subprocess to terminate, the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
247 user can quit by typing @kbd{C-g}. The first @kbd{C-g} tries to kill
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
248 the subprocess with a @code{SIGINT} signal; but it waits until the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
249 subprocess actually terminates before quitting. If during that time the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
250 user types another @kbd{C-g}, that kills the subprocess instantly with
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
251 @code{SIGKILL} and quits immediately (except on MS-DOS, where killing
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
252 other processes doesn't work). @xref{Quitting}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
253
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
254 The synchronous subprocess functions return an indication of how the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
255 process terminated.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
256
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
257 The output from a synchronous subprocess is generally decoded using a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
258 coding system, much like text read from a file. The input sent to a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
259 subprocess by @code{call-process-region} is encoded using a coding
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
260 system, much like text written into a file. @xref{Coding Systems}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
261
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
262 @defun call-process program &optional infile destination display &rest args
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
263 This function calls @var{program} in a separate process and waits for
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
264 it to finish.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
265
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
266 The standard input for the process comes from file @var{infile} if
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
267 @var{infile} is not @code{nil}, and from the null device otherwise.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
268 The argument @var{destination} says where to put the process output.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
269 Here are the possibilities:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
270
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
271 @table @asis
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
272 @item a buffer
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
273 Insert the output in that buffer, before point. This includes both the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
274 standard output stream and the standard error stream of the process.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
275
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
276 @item a string
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
277 Insert the output in a buffer with that name, before point.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
278
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
279 @item @code{t}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
280 Insert the output in the current buffer, before point.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
281
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
282 @item @code{nil}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
283 Discard the output.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
284
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
285 @item 0
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
286 Discard the output, and return @code{nil} immediately without waiting
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
287 for the subprocess to finish.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
288
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
289 In this case, the process is not truly synchronous, since it can run in
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
290 parallel with Emacs; but you can think of it as synchronous in that
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
291 Emacs is essentially finished with the subprocess as soon as this
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
292 function returns.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
293
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
294 MS-DOS doesn't support asynchronous subprocesses, so this option doesn't
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
295 work there.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
296
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
297 @item @code{(@var{real-destination} @var{error-destination})}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
298 Keep the standard output stream separate from the standard error stream;
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
299 deal with the ordinary output as specified by @var{real-destination},
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
300 and dispose of the error output according to @var{error-destination}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
301 If @var{error-destination} is @code{nil}, that means to discard the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
302 error output, @code{t} means mix it with the ordinary output, and a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
303 string specifies a file name to redirect error output into.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
304
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
305 You can't directly specify a buffer to put the error output in; that is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
306 too difficult to implement. But you can achieve this result by sending
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
307 the error output to a temporary file and then inserting the file into a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
308 buffer.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
309 @end table
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
310
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
311 If @var{display} is non-@code{nil}, then @code{call-process} redisplays
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
312 the buffer as output is inserted. (However, if the coding system chosen
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
313 for decoding output is @code{undecided}, meaning deduce the encoding
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
314 from the actual data, then redisplay sometimes cannot continue once
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
315 non-@acronym{ASCII} characters are encountered. There are fundamental
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
316 reasons why it is hard to fix this; see @ref{Output from Processes}.)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
317
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
318 Otherwise the function @code{call-process} does no redisplay, and the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
319 results become visible on the screen only when Emacs redisplays that
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
320 buffer in the normal course of events.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
321
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
322 The remaining arguments, @var{args}, are strings that specify command
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
323 line arguments for the program.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
324
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
325 The value returned by @code{call-process} (unless you told it not to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
326 wait) indicates the reason for process termination. A number gives the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
327 exit status of the subprocess; 0 means success, and any other value
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
328 means failure. If the process terminated with a signal,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
329 @code{call-process} returns a string describing the signal.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
330
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
331 In the examples below, the buffer @samp{foo} is current.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
332
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
333 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
334 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
335 (call-process "pwd" nil t)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
336 @result{} 0
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
337
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
338 ---------- Buffer: foo ----------
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
339 /usr/user/lewis/manual
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
340 ---------- Buffer: foo ----------
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
341 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
342
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
343 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
344 (call-process "grep" nil "bar" nil "lewis" "/etc/passwd")
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
345 @result{} 0
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
346
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
347 ---------- Buffer: bar ----------
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
348 lewis:5LTsHm66CSWKg:398:21:Bil Lewis:/user/lewis:/bin/csh
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
349
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
350 ---------- Buffer: bar ----------
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
351 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
352 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
353
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
354 Here is a good example of the use of @code{call-process}, which used to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
355 be found in the definition of @code{insert-directory}:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
356
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
357 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
358 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
359 (call-process insert-directory-program nil t nil @var{switches}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
360 (if full-directory-p
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
361 (concat (file-name-as-directory file) ".")
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
362 file))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
363 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
364 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
365 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
366
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
367 @defun process-file program &optional infile buffer display &rest args
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
368 This function processes files synchronously in a separate process. It
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
369 is similar to @code{call-process} but may invoke a file handler based
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
370 on the value of the variable @code{default-directory}. The current
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
371 working directory of the subprocess is @code{default-directory}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
372
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
373 The arguments are handled in almost the same way as for
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
374 @code{call-process}, with the following differences:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
375
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
376 Some file handlers may not support all combinations and forms of the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
377 arguments @var{infile}, @var{buffer}, and @var{display}. For example,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
378 some file handlers might behave as if @var{display} were @code{nil},
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
379 regardless of the value actually passed. As another example, some
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
380 file handlers might not support separating standard output and error
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
381 output by way of the @var{buffer} argument.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
382
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
383 If a file handler is invoked, it determines the program to run based
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
384 on the first argument @var{program}. For instance, consider that a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
385 handler for remote files is invoked. Then the path that is used for
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
386 searching the program might be different than @code{exec-path}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
387
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
388 The second argument @var{infile} may invoke a file handler. The file
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
389 handler could be different from the handler chosen for the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
390 @code{process-file} function itself. (For example,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
391 @code{default-directory} could be on a remote host, whereas
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
392 @var{infile} is on another remote host. Or @code{default-directory}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
393 could be non-special, whereas @var{infile} is on a remote host.)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
394
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
395 If @var{buffer} is a list of the form @code{(@var{real-destination}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
396 @var{error-destination})}, and @var{error-destination} names a file,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
397 then the same remarks as for @var{infile} apply.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
398
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
399 The remaining arguments (@var{args}) will be passed to the process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
400 verbatim. Emacs is not involved in processing file names that are
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
401 present in @var{args}. To avoid confusion, it may be best to avoid
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
402 absolute file names in @var{args}, but rather to specify all file
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
403 names as relative to @code{default-directory}. The function
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
404 @code{file-relative-name} is useful for constructing such relative
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
405 file names.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
406 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
407
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
408 @defun call-process-region start end program &optional delete destination display &rest args
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
409 This function sends the text from @var{start} to @var{end} as
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
410 standard input to a process running @var{program}. It deletes the text
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
411 sent if @var{delete} is non-@code{nil}; this is useful when
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
412 @var{destination} is @code{t}, to insert the output in the current
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
413 buffer in place of the input.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
414
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
415 The arguments @var{destination} and @var{display} control what to do
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
416 with the output from the subprocess, and whether to update the display
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
417 as it comes in. For details, see the description of
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
418 @code{call-process}, above. If @var{destination} is the integer 0,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
419 @code{call-process-region} discards the output and returns @code{nil}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
420 immediately, without waiting for the subprocess to finish (this only
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
421 works if asynchronous subprocesses are supported).
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
422
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
423 The remaining arguments, @var{args}, are strings that specify command
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
424 line arguments for the program.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
425
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
426 The return value of @code{call-process-region} is just like that of
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
427 @code{call-process}: @code{nil} if you told it to return without
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
428 waiting; otherwise, a number or string which indicates how the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
429 subprocess terminated.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
430
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
431 In the following example, we use @code{call-process-region} to run the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
432 @code{cat} utility, with standard input being the first five characters
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
433 in buffer @samp{foo} (the word @samp{input}). @code{cat} copies its
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
434 standard input into its standard output. Since the argument
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
435 @var{destination} is @code{t}, this output is inserted in the current
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
436 buffer.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
437
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
438 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
439 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
440 ---------- Buffer: foo ----------
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
441 input@point{}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
442 ---------- Buffer: foo ----------
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
443 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
444
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
445 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
446 (call-process-region 1 6 "cat" nil t)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
447 @result{} 0
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
448
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
449 ---------- Buffer: foo ----------
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
450 inputinput@point{}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
451 ---------- Buffer: foo ----------
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
452 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
453 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
454
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
455 The @code{shell-command-on-region} command uses
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
456 @code{call-process-region} like this:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
457
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
458 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
459 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
460 (call-process-region
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
461 start end
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
462 shell-file-name ; @r{Name of program.}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
463 nil ; @r{Do not delete region.}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
464 buffer ; @r{Send output to @code{buffer}.}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
465 nil ; @r{No redisplay during output.}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
466 "-c" command) ; @r{Arguments for the shell.}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
467 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
468 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
469 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
470
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
471 @defun call-process-shell-command command &optional infile destination display &rest args
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
472 This function executes the shell command @var{command} synchronously
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
473 in a separate process. The final arguments @var{args} are additional
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
474 arguments to add at the end of @var{command}. The other arguments
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
475 are handled as in @code{call-process}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
476 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
477
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
478 @defun process-file-shell-command command &optional infile destination display &rest args
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
479 This function is like @code{call-process-shell-command}, but uses
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
480 @code{process-file} internally. Depending on @code{default-directory},
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
481 @var{command} can be executed also on remote hosts.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
482 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
483
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
484 @defun shell-command-to-string command
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
485 This function executes @var{command} (a string) as a shell command,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
486 then returns the command's output as a string.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
487 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
488
98877
1d1a44972ed4 (Synchronous Processes): Document `process-lines'.
Eli Zaretskii <eliz@gnu.org>
parents: 98725
diff changeset
489 @defun process-lines program &rest args
1d1a44972ed4 (Synchronous Processes): Document `process-lines'.
Eli Zaretskii <eliz@gnu.org>
parents: 98725
diff changeset
490 This function runs @var{program} in a separate process, waits for it
1d1a44972ed4 (Synchronous Processes): Document `process-lines'.
Eli Zaretskii <eliz@gnu.org>
parents: 98725
diff changeset
491 to finish, and returns its output as a list of strings. Each string
1d1a44972ed4 (Synchronous Processes): Document `process-lines'.
Eli Zaretskii <eliz@gnu.org>
parents: 98725
diff changeset
492 in the list holds a single line of text output by the program; the
1d1a44972ed4 (Synchronous Processes): Document `process-lines'.
Eli Zaretskii <eliz@gnu.org>
parents: 98725
diff changeset
493 end-of-line characters are stripped from each line. The arguments
1d1a44972ed4 (Synchronous Processes): Document `process-lines'.
Eli Zaretskii <eliz@gnu.org>
parents: 98725
diff changeset
494 beyond @var{program}, @var{args}, are strings that specify
1d1a44972ed4 (Synchronous Processes): Document `process-lines'.
Eli Zaretskii <eliz@gnu.org>
parents: 98725
diff changeset
495 command-line arguments with which to run the program.
1d1a44972ed4 (Synchronous Processes): Document `process-lines'.
Eli Zaretskii <eliz@gnu.org>
parents: 98725
diff changeset
496
1d1a44972ed4 (Synchronous Processes): Document `process-lines'.
Eli Zaretskii <eliz@gnu.org>
parents: 98725
diff changeset
497 If @var{program} exits with a non-zero exit status, this function
1d1a44972ed4 (Synchronous Processes): Document `process-lines'.
Eli Zaretskii <eliz@gnu.org>
parents: 98725
diff changeset
498 signals an error.
1d1a44972ed4 (Synchronous Processes): Document `process-lines'.
Eli Zaretskii <eliz@gnu.org>
parents: 98725
diff changeset
499
1d1a44972ed4 (Synchronous Processes): Document `process-lines'.
Eli Zaretskii <eliz@gnu.org>
parents: 98725
diff changeset
500 This function works by calling @code{call-process}, so program output
1d1a44972ed4 (Synchronous Processes): Document `process-lines'.
Eli Zaretskii <eliz@gnu.org>
parents: 98725
diff changeset
501 is decoded in the same way as for @code{call-process}.
1d1a44972ed4 (Synchronous Processes): Document `process-lines'.
Eli Zaretskii <eliz@gnu.org>
parents: 98725
diff changeset
502 @end defun
1d1a44972ed4 (Synchronous Processes): Document `process-lines'.
Eli Zaretskii <eliz@gnu.org>
parents: 98725
diff changeset
503
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
504 @node Asynchronous Processes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
505 @section Creating an Asynchronous Process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
506 @cindex asynchronous subprocess
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
507
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
508 After an @dfn{asynchronous process} is created, Emacs and the subprocess
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
509 both continue running immediately. The process thereafter runs
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
510 in parallel with Emacs, and the two can communicate with each other
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
511 using the functions described in the following sections. However,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
512 communication is only partially asynchronous: Emacs sends data to the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
513 process only when certain functions are called, and Emacs accepts data
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
514 from the process only when Emacs is waiting for input or for a time
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
515 delay.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
516
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
517 Here we describe how to create an asynchronous process.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
518
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
519 @defun start-process name buffer-or-name program &rest args
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
520 This function creates a new asynchronous subprocess and starts the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
521 program @var{program} running in it. It returns a process object that
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
522 stands for the new subprocess in Lisp. The argument @var{name}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
523 specifies the name for the process object; if a process with this name
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
524 already exists, then @var{name} is modified (by appending @samp{<1>},
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
525 etc.) to be unique. The buffer @var{buffer-or-name} is the buffer to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
526 associate with the process.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
527
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
528 The remaining arguments, @var{args}, are strings that specify command
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
529 line arguments for the program.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
530
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
531 In the example below, the first process is started and runs (rather,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
532 sleeps) for 100 seconds. Meanwhile, the second process is started, and
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
533 given the name @samp{my-process<1>} for the sake of uniqueness. It
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
534 inserts the directory listing at the end of the buffer @samp{foo},
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
535 before the first process finishes. Then it finishes, and a message to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
536 that effect is inserted in the buffer. Much later, the first process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
537 finishes, and another message is inserted in the buffer for it.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
538
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
539 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
540 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
541 (start-process "my-process" "foo" "sleep" "100")
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
542 @result{} #<process my-process>
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
543 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
544
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
545 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
546 (start-process "my-process" "foo" "ls" "-l" "/user/lewis/bin")
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
547 @result{} #<process my-process<1>>
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
548
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
549 ---------- Buffer: foo ----------
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
550 total 2
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
551 lrwxrwxrwx 1 lewis 14 Jul 22 10:12 gnuemacs --> /emacs
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
552 -rwxrwxrwx 1 lewis 19 Jul 30 21:02 lemon
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
553
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
554 Process my-process<1> finished
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
555
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
556 Process my-process finished
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
557 ---------- Buffer: foo ----------
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
558 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
559 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
560 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
561
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
562 @defun start-file-process name buffer-or-name program &rest args
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
563 Like @code{start-process}, this function starts a new asynchronous
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
564 subprocess running @var{program} in it, and returns its process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
565 object---when @code{default-directory} is not a magic file name.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
566
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
567 If @code{default-directory} is magic, the function invokes its file
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
568 handler instead. This handler ought to run @var{program}, perhaps on
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
569 the local host, perhaps on a remote host that corresponds to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
570 @code{default-directory}. In the latter case, the local part of
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
571 @code{default-directory} becomes the working directory of the process.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
572
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
573 This function does not try to invoke file name handlers for
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
574 @var{program} or for the @var{program-args}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
575
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
576 Depending on the implementation of the file handler, it might not be
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
577 possible to apply @code{process-filter} or @code{process-sentinel} to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
578 the resulting process object (@pxref{Filter Functions}, @pxref{Sentinels}).
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
579
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
580 Some file handlers may not support @code{start-file-process} (for
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
581 example @code{ange-ftp-hook-function}). In such cases, the function
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
582 does nothing and returns @code{nil}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
583 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
584
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
585 @defun start-process-shell-command name buffer-or-name command &rest command-args
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
586 This function is like @code{start-process} except that it uses a shell
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
587 to execute the specified command. The argument @var{command} is a shell
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
588 command name, and @var{command-args} are the arguments for the shell
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
589 command. The variable @code{shell-file-name} specifies which shell to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
590 use.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
591
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
592 The point of running a program through the shell, rather than directly
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
593 with @code{start-process}, is so that you can employ shell features such
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
594 as wildcards in the arguments. It follows that if you include an
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
595 arbitrary user-specified arguments in the command, you should quote it
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
596 with @code{shell-quote-argument} first, so that any special shell
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
597 characters do @emph{not} have their special shell meanings. @xref{Shell
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
598 Arguments}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
599 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
600
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
601 @defun start-file-process-shell-command name buffer-or-name command &rest command-args
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
602 This function is like @code{start-process-shell-command}, but uses
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
603 @code{start-file-process} internally. By this, @var{command} can be
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
604 executed also on remote hosts, depending on @code{default-directory}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
605 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
606
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
607 @defvar process-connection-type
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
608 @cindex pipes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
609 @cindex @acronym{PTY}s
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
610 This variable controls the type of device used to communicate with
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
611 asynchronous subprocesses. If it is non-@code{nil}, then @acronym{PTY}s are
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
612 used, when available. Otherwise, pipes are used.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
613
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
614 @acronym{PTY}s are usually preferable for processes visible to the user, as
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
615 in Shell mode, because they allow job control (@kbd{C-c}, @kbd{C-z},
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
616 etc.) to work between the process and its children, whereas pipes do
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
617 not. For subprocesses used for internal purposes by programs, it is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
618 often better to use a pipe, because they are more efficient. In
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
619 addition, the total number of @acronym{PTY}s is limited on many systems and
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
620 it is good not to waste them.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
621
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
622 The value of @code{process-connection-type} takes effect when
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
623 @code{start-process} is called. So you can specify how to communicate
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
624 with one subprocess by binding the variable around the call to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
625 @code{start-process}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
626
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
627 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
628 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
629 (let ((process-connection-type nil)) ; @r{Use a pipe.}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
630 (start-process @dots{}))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
631 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
632 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
633
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
634 To determine whether a given subprocess actually got a pipe or a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
635 @acronym{PTY}, use the function @code{process-tty-name} (@pxref{Process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
636 Information}).
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
637 @end defvar
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
638
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
639 @node Deleting Processes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
640 @section Deleting Processes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
641 @cindex deleting processes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
642
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
643 @dfn{Deleting a process} disconnects Emacs immediately from the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
644 subprocess. Processes are deleted automatically after they terminate,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
645 but not necessarily right away. You can delete a process explicitly
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
646 at any time. If you delete a terminated process explicitly before it
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
647 is deleted automatically, no harm results. Deleting a running
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
648 process sends a signal to terminate it (and its child processes if
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
649 any), and calls the process sentinel if it has one. @xref{Sentinels}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
650
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
651 When a process is deleted, the process object itself continues to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
652 exist as long as other Lisp objects point to it. All the Lisp
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
653 primitives that work on process objects accept deleted processes, but
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
654 those that do I/O or send signals will report an error. The process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
655 mark continues to point to the same place as before, usually into a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
656 buffer where output from the process was being inserted.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
657
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
658 @defopt delete-exited-processes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
659 This variable controls automatic deletion of processes that have
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
660 terminated (due to calling @code{exit} or to a signal). If it is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
661 @code{nil}, then they continue to exist until the user runs
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
662 @code{list-processes}. Otherwise, they are deleted immediately after
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
663 they exit.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
664 @end defopt
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
665
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
666 @defun delete-process process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
667 This function deletes a process, killing it with a @code{SIGKILL}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
668 signal. The argument may be a process, the name of a process, a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
669 buffer, or the name of a buffer. (A buffer or buffer-name stands for
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
670 the process that @code{get-buffer-process} returns.) Calling
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
671 @code{delete-process} on a running process terminates it, updates the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
672 process status, and runs the sentinel (if any) immediately. If the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
673 process has already terminated, calling @code{delete-process} has no
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
674 effect on its status, or on the running of its sentinel (which will
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
675 happen sooner or later).
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
676
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
677 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
678 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
679 (delete-process "*shell*")
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
680 @result{} nil
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
681 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
682 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
683 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
684
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
685 @node Process Information
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
686 @section Process Information
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
687
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
688 Several functions return information about processes.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
689 @code{list-processes} is provided for interactive use.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
690
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
691 @deffn Command list-processes &optional query-only
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
692 This command displays a listing of all living processes. In addition,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
693 it finally deletes any process whose status was @samp{Exited} or
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
694 @samp{Signaled}. It returns @code{nil}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
695
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
696 If @var{query-only} is non-@code{nil} then it lists only processes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
697 whose query flag is non-@code{nil}. @xref{Query Before Exit}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
698 @end deffn
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
699
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
700 @defun process-list
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
701 This function returns a list of all processes that have not been deleted.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
702
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
703 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
704 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
705 (process-list)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
706 @result{} (#<process display-time> #<process shell>)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
707 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
708 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
709 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
710
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
711 @defun get-process name
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
712 This function returns the process named @var{name}, or @code{nil} if
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
713 there is none. An error is signaled if @var{name} is not a string.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
714
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
715 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
716 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
717 (get-process "shell")
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
718 @result{} #<process shell>
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
719 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
720 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
721 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
722
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
723 @defun process-command process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
724 This function returns the command that was executed to start
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
725 @var{process}. This is a list of strings, the first string being the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
726 program executed and the rest of the strings being the arguments that
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
727 were given to the program.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
728
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
729 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
730 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
731 (process-command (get-process "shell"))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
732 @result{} ("/bin/csh" "-i")
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
733 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
734 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
735 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
736
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
737 @defun process-contact process &optional key
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
738
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
739 This function returns information about how a network or serial
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
740 process was set up. For a network process, when @var{key} is
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
741 @code{nil}, it returns @code{(@var{hostname} @var{service})} which
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
742 specifies what you connected to. For a serial process, when @var{key}
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
743 is @code{nil}, it returns @code{(@var{port} @var{speed})}. For an
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
744 ordinary child process, this function always returns @code{t}.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
745
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
746 If @var{key} is @code{t}, the value is the complete status information
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
747 for the connection, server, or serial port; that is, the list of
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
748 keywords and values specified in @code{make-network-process} or
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
749 @code{make-serial-process}, except that some of the values represent
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
750 the current status instead of what you specified.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
751
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
752 For a network process:
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
753
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
754 @table @code
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
755 @item :buffer
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
756 The associated value is the process buffer.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
757 @item :filter
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
758 The associated value is the process filter function.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
759 @item :sentinel
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
760 The associated value is the process sentinel function.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
761 @item :remote
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
762 In a connection, the address in internal format of the remote peer.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
763 @item :local
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
764 The local address, in internal format.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
765 @item :service
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
766 In a server, if you specified @code{t} for @var{service},
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
767 this value is the actual port number.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
768 @end table
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
769
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
770 @code{:local} and @code{:remote} are included even if they were not
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
771 specified explicitly in @code{make-network-process}.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
772
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
773 For a serial process, see @code{make-serial-process} and
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
774 @code{serial-process-configure} for a list of keys.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
775
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
776 If @var{key} is a keyword, the function returns the value corresponding
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
777 to that keyword.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
778 @end defun
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
779
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
780 @defun process-id process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
781 This function returns the @acronym{PID} of @var{process}. This is an
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
782 integer that distinguishes the process @var{process} from all other
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
783 processes running on the same computer at the current time. The
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
784 @acronym{PID} of a process is chosen by the operating system kernel when the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
785 process is started and remains constant as long as the process exists.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
786 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
787
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
788 @defun process-name process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
789 This function returns the name of @var{process}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
790 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
791
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
792 @defun process-status process-name
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
793 This function returns the status of @var{process-name} as a symbol.
99195
524aa1296742 (Process Information): Note that process-status does not accept buffer
Chong Yidong <cyd@stupidchicken.com>
parents: 98997
diff changeset
794 The argument @var{process-name} must be a process, a buffer, or a
524aa1296742 (Process Information): Note that process-status does not accept buffer
Chong Yidong <cyd@stupidchicken.com>
parents: 98997
diff changeset
795 process name (a string).
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
796
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
797 The possible values for an actual subprocess are:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
798
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
799 @table @code
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
800 @item run
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
801 for a process that is running.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
802 @item stop
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
803 for a process that is stopped but continuable.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
804 @item exit
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
805 for a process that has exited.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
806 @item signal
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
807 for a process that has received a fatal signal.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
808 @item open
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
809 for a network connection that is open.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
810 @item closed
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
811 for a network connection that is closed. Once a connection
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
812 is closed, you cannot reopen it, though you might be able to open
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
813 a new connection to the same place.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
814 @item connect
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
815 for a non-blocking connection that is waiting to complete.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
816 @item failed
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
817 for a non-blocking connection that has failed to complete.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
818 @item listen
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
819 for a network server that is listening.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
820 @item nil
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
821 if @var{process-name} is not the name of an existing process.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
822 @end table
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
823
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
824 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
825 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
826 (process-status (get-buffer "*shell*"))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
827 @result{} run
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
828 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
829 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
830 x
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
831 @result{} #<process xx<1>>
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
832 (process-status x)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
833 @result{} exit
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
834 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
835 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
836
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
837 For a network connection, @code{process-status} returns one of the symbols
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
838 @code{open} or @code{closed}. The latter means that the other side
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
839 closed the connection, or Emacs did @code{delete-process}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
840 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
841
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
842 @defun process-type process
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
843 This function returns the symbol @code{network} for a network
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
844 connection or server, @code{serial} for a serial port connection, or
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
845 @code{real} for a real subprocess.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
846 @end defun
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
847
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
848 @defun process-exit-status process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
849 This function returns the exit status of @var{process} or the signal
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
850 number that killed it. (Use the result of @code{process-status} to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
851 determine which of those it is.) If @var{process} has not yet
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
852 terminated, the value is 0.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
853 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
854
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
855 @defun process-tty-name process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
856 This function returns the terminal name that @var{process} is using for
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
857 its communication with Emacs---or @code{nil} if it is using pipes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
858 instead of a terminal (see @code{process-connection-type} in
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
859 @ref{Asynchronous Processes}).
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
860 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
861
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
862 @defun process-coding-system process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
863 @anchor{Coding systems for a subprocess}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
864 This function returns a cons cell describing the coding systems in use
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
865 for decoding output from @var{process} and for encoding input to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
866 @var{process} (@pxref{Coding Systems}). The value has this form:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
867
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
868 @example
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
869 (@var{coding-system-for-decoding} . @var{coding-system-for-encoding})
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
870 @end example
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
871 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
872
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
873 @defun set-process-coding-system process &optional decoding-system encoding-system
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
874 This function specifies the coding systems to use for subsequent output
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
875 from and input to @var{process}. It will use @var{decoding-system} to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
876 decode subprocess output, and @var{encoding-system} to encode subprocess
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
877 input.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
878 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
879
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
880 Every process also has a property list that you can use to store
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
881 miscellaneous values associated with the process.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
882
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
883 @defun process-get process propname
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
884 This function returns the value of the @var{propname} property
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
885 of @var{process}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
886 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
887
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
888 @defun process-put process propname value
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
889 This function sets the value of the @var{propname} property
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
890 of @var{process} to @var{value}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
891 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
892
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
893 @defun process-plist process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
894 This function returns the process plist of @var{process}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
895 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
896
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
897 @defun set-process-plist process plist
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
898 This function sets the process plist of @var{process} to @var{plist}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
899 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
900
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
901 @node Input to Processes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
902 @section Sending Input to Processes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
903 @cindex process input
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
904
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
905 Asynchronous subprocesses receive input when it is sent to them by
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
906 Emacs, which is done with the functions in this section. You must
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
907 specify the process to send input to, and the input data to send. The
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
908 data appears on the ``standard input'' of the subprocess.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
909
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
910 Some operating systems have limited space for buffered input in a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
911 @acronym{PTY}. On these systems, Emacs sends an @acronym{EOF}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
912 periodically amidst the other characters, to force them through. For
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
913 most programs, these @acronym{EOF}s do no harm.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
914
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
915 Subprocess input is normally encoded using a coding system before the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
916 subprocess receives it, much like text written into a file. You can use
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
917 @code{set-process-coding-system} to specify which coding system to use
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
918 (@pxref{Process Information}). Otherwise, the coding system comes from
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
919 @code{coding-system-for-write}, if that is non-@code{nil}; or else from
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
920 the defaulting mechanism (@pxref{Default Coding Systems}).
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
921
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
922 Sometimes the system is unable to accept input for that process,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
923 because the input buffer is full. When this happens, the send functions
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
924 wait a short while, accepting output from subprocesses, and then try
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
925 again. This gives the subprocess a chance to read more of its pending
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
926 input and make space in the buffer. It also allows filters, sentinels
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
927 and timers to run---so take account of that in writing your code.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
928
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
929 In these functions, the @var{process} argument can be a process or
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
930 the name of a process, or a buffer or buffer name (which stands
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
931 for a process via @code{get-buffer-process}). @code{nil} means
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
932 the current buffer's process.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
933
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
934 @defun process-send-string process string
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
935 This function sends @var{process} the contents of @var{string} as
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
936 standard input. If it is @code{nil}, the current buffer's process is used.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
937
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
938 The function returns @code{nil}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
939
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
940 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
941 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
942 (process-send-string "shell<1>" "ls\n")
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
943 @result{} nil
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
944 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
945
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
946
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
947 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
948 ---------- Buffer: *shell* ----------
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
949 ...
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
950 introduction.texi syntax-tables.texi~
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
951 introduction.texi~ text.texi
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
952 introduction.txt text.texi~
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
953 ...
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
954 ---------- Buffer: *shell* ----------
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
955 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
956 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
957 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
958
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
959 @defun process-send-region process start end
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
960 This function sends the text in the region defined by @var{start} and
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
961 @var{end} as standard input to @var{process}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
962
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
963 An error is signaled unless both @var{start} and @var{end} are
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
964 integers or markers that indicate positions in the current buffer. (It
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
965 is unimportant which number is larger.)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
966 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
967
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
968 @defun process-send-eof &optional process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
969 This function makes @var{process} see an end-of-file in its
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
970 input. The @acronym{EOF} comes after any text already sent to it.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
971
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
972 The function returns @var{process}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
973
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
974 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
975 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
976 (process-send-eof "shell")
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
977 @result{} "shell"
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
978 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
979 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
980 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
981
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
982 @defun process-running-child-p process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
983 This function will tell you whether a subprocess has given control of
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
984 its terminal to its own child process. The value is @code{t} if this is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
985 true, or if Emacs cannot tell; it is @code{nil} if Emacs can be certain
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
986 that this is not so.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
987 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
988
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
989 @node Signals to Processes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
990 @section Sending Signals to Processes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
991 @cindex process signals
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
992 @cindex sending signals
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
993 @cindex signals
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
994
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
995 @dfn{Sending a signal} to a subprocess is a way of interrupting its
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
996 activities. There are several different signals, each with its own
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
997 meaning. The set of signals and their names is defined by the operating
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
998 system. For example, the signal @code{SIGINT} means that the user has
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
999 typed @kbd{C-c}, or that some analogous thing has happened.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1000
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1001 Each signal has a standard effect on the subprocess. Most signals
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1002 kill the subprocess, but some stop or resume execution instead. Most
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1003 signals can optionally be handled by programs; if the program handles
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1004 the signal, then we can say nothing in general about its effects.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1005
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1006 You can send signals explicitly by calling the functions in this
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1007 section. Emacs also sends signals automatically at certain times:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1008 killing a buffer sends a @code{SIGHUP} signal to all its associated
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1009 processes; killing Emacs sends a @code{SIGHUP} signal to all remaining
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1010 processes. (@code{SIGHUP} is a signal that usually indicates that the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1011 user hung up the phone.)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1012
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1013 Each of the signal-sending functions takes two optional arguments:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1014 @var{process} and @var{current-group}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1015
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1016 The argument @var{process} must be either a process, a process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1017 name, a buffer, a buffer name, or @code{nil}. A buffer or buffer name
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1018 stands for a process through @code{get-buffer-process}. @code{nil}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1019 stands for the process associated with the current buffer. An error
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1020 is signaled if @var{process} does not identify a process.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1021
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1022 The argument @var{current-group} is a flag that makes a difference
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1023 when you are running a job-control shell as an Emacs subprocess. If it
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1024 is non-@code{nil}, then the signal is sent to the current process-group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1025 of the terminal that Emacs uses to communicate with the subprocess. If
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1026 the process is a job-control shell, this means the shell's current
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1027 subjob. If it is @code{nil}, the signal is sent to the process group of
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1028 the immediate subprocess of Emacs. If the subprocess is a job-control
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1029 shell, this is the shell itself.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1030
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1031 The flag @var{current-group} has no effect when a pipe is used to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1032 communicate with the subprocess, because the operating system does not
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1033 support the distinction in the case of pipes. For the same reason,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1034 job-control shells won't work when a pipe is used. See
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1035 @code{process-connection-type} in @ref{Asynchronous Processes}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1036
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1037 @defun interrupt-process &optional process current-group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1038 This function interrupts the process @var{process} by sending the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1039 signal @code{SIGINT}. Outside of Emacs, typing the ``interrupt
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1040 character'' (normally @kbd{C-c} on some systems, and @code{DEL} on
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1041 others) sends this signal. When the argument @var{current-group} is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1042 non-@code{nil}, you can think of this function as ``typing @kbd{C-c}''
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1043 on the terminal by which Emacs talks to the subprocess.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1044 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1045
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1046 @defun kill-process &optional process current-group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1047 This function kills the process @var{process} by sending the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1048 signal @code{SIGKILL}. This signal kills the subprocess immediately,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1049 and cannot be handled by the subprocess.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1050 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1051
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1052 @defun quit-process &optional process current-group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1053 This function sends the signal @code{SIGQUIT} to the process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1054 @var{process}. This signal is the one sent by the ``quit
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1055 character'' (usually @kbd{C-b} or @kbd{C-\}) when you are not inside
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1056 Emacs.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1057 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1058
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1059 @defun stop-process &optional process current-group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1060 This function stops the process @var{process} by sending the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1061 signal @code{SIGTSTP}. Use @code{continue-process} to resume its
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1062 execution.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1063
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1064 Outside of Emacs, on systems with job control, the ``stop character''
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1065 (usually @kbd{C-z}) normally sends this signal. When
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1066 @var{current-group} is non-@code{nil}, you can think of this function as
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1067 ``typing @kbd{C-z}'' on the terminal Emacs uses to communicate with the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1068 subprocess.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1069 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1070
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1071 @defun continue-process &optional process current-group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1072 This function resumes execution of the process @var{process} by sending
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1073 it the signal @code{SIGCONT}. This presumes that @var{process} was
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1074 stopped previously.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1075 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1076
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1077 @c Emacs 19 feature
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1078 @defun signal-process process signal
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1079 This function sends a signal to process @var{process}. The argument
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1080 @var{signal} specifies which signal to send; it should be an integer.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1081
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1082 The @var{process} argument can be a system process @acronym{ID}; that
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1083 allows you to send signals to processes that are not children of
98719
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1084 Emacs. @xref{System Processes}.
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1085 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1086
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1087 @node Output from Processes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1088 @section Receiving Output from Processes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1089 @cindex process output
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1090 @cindex output from processes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1091
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1092 There are two ways to receive the output that a subprocess writes to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1093 its standard output stream. The output can be inserted in a buffer,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1094 which is called the associated buffer of the process, or a function
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1095 called the @dfn{filter function} can be called to act on the output. If
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1096 the process has no buffer and no filter function, its output is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1097 discarded.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1098
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1099 When a subprocess terminates, Emacs reads any pending output,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1100 then stops reading output from that subprocess. Therefore, if the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1101 subprocess has children that are still live and still producing
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1102 output, Emacs won't receive that output.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1103
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1104 Output from a subprocess can arrive only while Emacs is waiting: when
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1105 reading terminal input, in @code{sit-for} and @code{sleep-for}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1106 (@pxref{Waiting}), and in @code{accept-process-output} (@pxref{Accepting
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1107 Output}). This minimizes the problem of timing errors that usually
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1108 plague parallel programming. For example, you can safely create a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1109 process and only then specify its buffer or filter function; no output
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1110 can arrive before you finish, if the code in between does not call any
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1111 primitive that waits.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1112
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1113 @defvar process-adaptive-read-buffering
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1114 On some systems, when Emacs reads the output from a subprocess, the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1115 output data is read in very small blocks, potentially resulting in
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1116 very poor performance. This behavior can be remedied to some extent
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1117 by setting the variable @var{process-adaptive-read-buffering} to a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1118 non-@code{nil} value (the default), as it will automatically delay reading
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1119 from such processes, thus allowing them to produce more output before
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1120 Emacs tries to read it.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1121 @end defvar
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1122
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1123 It is impossible to separate the standard output and standard error
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1124 streams of the subprocess, because Emacs normally spawns the subprocess
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1125 inside a pseudo-TTY, and a pseudo-TTY has only one output channel. If
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1126 you want to keep the output to those streams separate, you should
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1127 redirect one of them to a file---for example, by using an appropriate
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1128 shell command.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1129
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1130 @menu
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1131 * Process Buffers:: If no filter, output is put in a buffer.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1132 * Filter Functions:: Filter functions accept output from the process.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1133 * Decoding Output:: Filters can get unibyte or multibyte strings.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1134 * Accepting Output:: How to wait until process output arrives.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1135 @end menu
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1136
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1137 @node Process Buffers
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1138 @subsection Process Buffers
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1139
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1140 A process can (and usually does) have an @dfn{associated buffer},
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1141 which is an ordinary Emacs buffer that is used for two purposes: storing
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1142 the output from the process, and deciding when to kill the process. You
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1143 can also use the buffer to identify a process to operate on, since in
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1144 normal practice only one process is associated with any given buffer.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1145 Many applications of processes also use the buffer for editing input to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1146 be sent to the process, but this is not built into Emacs Lisp.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1147
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1148 Unless the process has a filter function (@pxref{Filter Functions}),
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1149 its output is inserted in the associated buffer. The position to insert
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1150 the output is determined by the @code{process-mark}, which is then
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1151 updated to point to the end of the text just inserted. Usually, but not
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1152 always, the @code{process-mark} is at the end of the buffer.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1153
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1154 @defun process-buffer process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1155 This function returns the associated buffer of the process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1156 @var{process}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1157
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1158 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1159 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1160 (process-buffer (get-process "shell"))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1161 @result{} #<buffer *shell*>
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1162 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1163 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1164 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1165
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1166 @defun process-mark process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1167 This function returns the process marker for @var{process}, which is the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1168 marker that says where to insert output from the process.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1169
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1170 If @var{process} does not have a buffer, @code{process-mark} returns a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1171 marker that points nowhere.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1172
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1173 Insertion of process output in a buffer uses this marker to decide where
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1174 to insert, and updates it to point after the inserted text. That is why
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1175 successive batches of output are inserted consecutively.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1176
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1177 Filter functions normally should use this marker in the same fashion
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1178 as is done by direct insertion of output in the buffer. A good
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1179 example of a filter function that uses @code{process-mark} is found at
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1180 the end of the following section.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1181
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1182 When the user is expected to enter input in the process buffer for
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1183 transmission to the process, the process marker separates the new input
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1184 from previous output.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1185 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1186
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1187 @defun set-process-buffer process buffer
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1188 This function sets the buffer associated with @var{process} to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1189 @var{buffer}. If @var{buffer} is @code{nil}, the process becomes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1190 associated with no buffer.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1191 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1192
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1193 @defun get-buffer-process buffer-or-name
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1194 This function returns a nondeleted process associated with the buffer
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1195 specified by @var{buffer-or-name}. If there are several processes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1196 associated with it, this function chooses one (currently, the one most
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1197 recently created, but don't count on that). Deletion of a process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1198 (see @code{delete-process}) makes it ineligible for this function to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1199 return.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1200
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1201 It is usually a bad idea to have more than one process associated with
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1202 the same buffer.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1203
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1204 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1205 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1206 (get-buffer-process "*shell*")
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1207 @result{} #<process shell>
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1208 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1209 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1210
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1211 Killing the process's buffer deletes the process, which kills the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1212 subprocess with a @code{SIGHUP} signal (@pxref{Signals to Processes}).
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1213 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1214
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1215 @node Filter Functions
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1216 @subsection Process Filter Functions
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1217 @cindex filter function
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1218 @cindex process filter
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1219
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1220 A process @dfn{filter function} is a function that receives the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1221 standard output from the associated process. If a process has a filter,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1222 then @emph{all} output from that process is passed to the filter. The
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1223 process buffer is used directly for output from the process only when
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1224 there is no filter.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1225
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1226 The filter function can only be called when Emacs is waiting for
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1227 something, because process output arrives only at such times. Emacs
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1228 waits when reading terminal input, in @code{sit-for} and
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1229 @code{sleep-for} (@pxref{Waiting}), and in @code{accept-process-output}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1230 (@pxref{Accepting Output}).
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1231
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1232 A filter function must accept two arguments: the associated process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1233 and a string, which is output just received from it. The function is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1234 then free to do whatever it chooses with the output.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1235
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1236 Quitting is normally inhibited within a filter function---otherwise,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1237 the effect of typing @kbd{C-g} at command level or to quit a user
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1238 command would be unpredictable. If you want to permit quitting inside
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1239 a filter function, bind @code{inhibit-quit} to @code{nil}. In most
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1240 cases, the right way to do this is with the macro
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1241 @code{with-local-quit}. @xref{Quitting}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1242
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1243 If an error happens during execution of a filter function, it is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1244 caught automatically, so that it doesn't stop the execution of whatever
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1245 program was running when the filter function was started. However, if
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1246 @code{debug-on-error} is non-@code{nil}, the error-catching is turned
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1247 off. This makes it possible to use the Lisp debugger to debug the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1248 filter function. @xref{Debugger}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1249
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1250 Many filter functions sometimes or always insert the text in the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1251 process's buffer, mimicking the actions of Emacs when there is no
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1252 filter. Such filter functions need to use @code{set-buffer} in order to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1253 be sure to insert in that buffer. To avoid setting the current buffer
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1254 semipermanently, these filter functions must save and restore the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1255 current buffer. They should also update the process marker, and in some
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1256 cases update the value of point. Here is how to do these things:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1257
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1258 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1259 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1260 (defun ordinary-insertion-filter (proc string)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1261 (with-current-buffer (process-buffer proc)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1262 (let ((moving (= (point) (process-mark proc))))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1263 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1264 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1265 (save-excursion
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1266 ;; @r{Insert the text, advancing the process marker.}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1267 (goto-char (process-mark proc))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1268 (insert string)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1269 (set-marker (process-mark proc) (point)))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1270 (if moving (goto-char (process-mark proc))))))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1271 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1272 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1273
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1274 @noindent
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1275 The reason to use @code{with-current-buffer}, rather than using
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1276 @code{save-excursion} to save and restore the current buffer, is so as
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1277 to preserve the change in point made by the second call to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1278 @code{goto-char}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1279
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1280 To make the filter force the process buffer to be visible whenever new
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1281 text arrives, insert the following line just before the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1282 @code{with-current-buffer} construct:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1283
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1284 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1285 (display-buffer (process-buffer proc))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1286 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1287
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1288 To force point to the end of the new output, no matter where it was
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1289 previously, eliminate the variable @code{moving} and call
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1290 @code{goto-char} unconditionally.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1291
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1292 In earlier Emacs versions, every filter function that did regular
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1293 expression searching or matching had to explicitly save and restore the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1294 match data. Now Emacs does this automatically for filter functions;
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1295 they never need to do it explicitly. @xref{Match Data}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1296
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1297 A filter function that writes the output into the buffer of the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1298 process should check whether the buffer is still alive. If it tries to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1299 insert into a dead buffer, it will get an error. The expression
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1300 @code{(buffer-name (process-buffer @var{process}))} returns @code{nil}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1301 if the buffer is dead.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1302
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1303 The output to the function may come in chunks of any size. A program
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1304 that produces the same output twice in a row may send it as one batch of
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1305 200 characters one time, and five batches of 40 characters the next. If
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1306 the filter looks for certain text strings in the subprocess output, make
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1307 sure to handle the case where one of these strings is split across two
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1308 or more batches of output.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1309
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1310 @defun set-process-filter process filter
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1311 This function gives @var{process} the filter function @var{filter}. If
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1312 @var{filter} is @code{nil}, it gives the process no filter.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1313 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1314
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1315 @defun process-filter process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1316 This function returns the filter function of @var{process}, or @code{nil}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1317 if it has none.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1318 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1319
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1320 Here is an example of use of a filter function:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1321
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1322 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1323 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1324 (defun keep-output (process output)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1325 (setq kept (cons output kept)))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1326 @result{} keep-output
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1327 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1328 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1329 (setq kept nil)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1330 @result{} nil
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1331 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1332 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1333 (set-process-filter (get-process "shell") 'keep-output)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1334 @result{} keep-output
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1335 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1336 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1337 (process-send-string "shell" "ls ~/other\n")
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1338 @result{} nil
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1339 kept
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1340 @result{} ("lewis@@slug[8] % "
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1341 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1342 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1343 "FINAL-W87-SHORT.MSS backup.otl kolstad.mss~
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1344 address.txt backup.psf kolstad.psf
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1345 backup.bib~ david.mss resume-Dec-86.mss~
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1346 backup.err david.psf resume-Dec.psf
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1347 backup.mss dland syllabus.mss
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1348 "
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1349 "#backups.mss# backup.mss~ kolstad.mss
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1350 ")
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1351 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1352 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1353
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1354 @ignore @c The code in this example doesn't show the right way to do things.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1355 Here is another, more realistic example, which demonstrates how to use
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1356 the process mark to do insertion in the same fashion as is done when
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1357 there is no filter function:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1358
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1359 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1360 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1361 ;; @r{Insert input in the buffer specified by @code{my-shell-buffer}}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1362 ;; @r{and make sure that buffer is shown in some window.}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1363 (defun my-process-filter (proc str)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1364 (let ((cur (selected-window))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1365 (pop-up-windows t))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1366 (pop-to-buffer my-shell-buffer)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1367 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1368 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1369 (goto-char (point-max))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1370 (insert str)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1371 (set-marker (process-mark proc) (point-max))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1372 (select-window cur)))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1373 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1374 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1375 @end ignore
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1376
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1377 @node Decoding Output
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1378 @subsection Decoding Process Output
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1379 @cindex decode process output
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1380
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1381 When Emacs writes process output directly into a multibyte buffer,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1382 it decodes the output according to the process output coding system.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1383 If the coding system is @code{raw-text} or @code{no-conversion}, Emacs
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1384 converts the unibyte output to multibyte using
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1385 @code{string-to-multibyte}, and inserts the resulting multibyte text.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1386
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1387 You can use @code{set-process-coding-system} to specify which coding
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1388 system to use (@pxref{Process Information}). Otherwise, the coding
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1389 system comes from @code{coding-system-for-read}, if that is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1390 non-@code{nil}; or else from the defaulting mechanism (@pxref{Default
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1391 Coding Systems}).
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1392
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1393 @strong{Warning:} Coding systems such as @code{undecided} which
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1394 determine the coding system from the data do not work entirely
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1395 reliably with asynchronous subprocess output. This is because Emacs
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1396 has to process asynchronous subprocess output in batches, as it
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1397 arrives. Emacs must try to detect the proper coding system from one
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1398 batch at a time, and this does not always work. Therefore, if at all
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1399 possible, specify a coding system that determines both the character
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1400 code conversion and the end of line conversion---that is, one like
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1401 @code{latin-1-unix}, rather than @code{undecided} or @code{latin-1}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1402
93202
81cc0380dd95 (Decoding Output): Remove process-filter-multibyte functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 87649
diff changeset
1403 @c Let's keep the index entries that were there for
81cc0380dd95 (Decoding Output): Remove process-filter-multibyte functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 87649
diff changeset
1404 @c set-process-filter-multibyte and process-filter-multibyte-p,
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1405 @cindex filter multibyte flag, of process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1406 @cindex process filter multibyte flag
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1407 When Emacs calls a process filter function, it provides the process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1408 output as a multibyte string or as a unibyte string according to the
93202
81cc0380dd95 (Decoding Output): Remove process-filter-multibyte functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 87649
diff changeset
1409 process's filter coding system. Emacs
81cc0380dd95 (Decoding Output): Remove process-filter-multibyte functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 87649
diff changeset
1410 decodes the output according to the process output coding system,
81cc0380dd95 (Decoding Output): Remove process-filter-multibyte functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 87649
diff changeset
1411 which usually produces a multibyte string, except for coding systems
81cc0380dd95 (Decoding Output): Remove process-filter-multibyte functions.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 87649
diff changeset
1412 such as @code{binary} and @code{raw-text}
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1413
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1414 @node Accepting Output
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1415 @subsection Accepting Output from Processes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1416 @cindex accept input from processes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1417
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1418 Output from asynchronous subprocesses normally arrives only while
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1419 Emacs is waiting for some sort of external event, such as elapsed time
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1420 or terminal input. Occasionally it is useful in a Lisp program to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1421 explicitly permit output to arrive at a specific point, or even to wait
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1422 until output arrives from a process.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1423
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1424 @defun accept-process-output &optional process seconds millisec just-this-one
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1425 This function allows Emacs to read pending output from processes. The
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1426 output is inserted in the associated buffers or given to their filter
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1427 functions. If @var{process} is non-@code{nil} then this function does
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1428 not return until some output has been received from @var{process}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1429
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1430 @c Emacs 19 feature
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1431 The arguments @var{seconds} and @var{millisec} let you specify timeout
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1432 periods. The former specifies a period measured in seconds and the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1433 latter specifies one measured in milliseconds. The two time periods
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1434 thus specified are added together, and @code{accept-process-output}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1435 returns after that much time, whether or not there has been any
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1436 subprocess output.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1437
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1438 The argument @var{millisec} is semi-obsolete nowadays because
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1439 @var{seconds} can be a floating point number to specify waiting a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1440 fractional number of seconds. If @var{seconds} is 0, the function
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1441 accepts whatever output is pending but does not wait.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1442
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1443 @c Emacs 22.1 feature
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1444 If @var{process} is a process, and the argument @var{just-this-one} is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1445 non-@code{nil}, only output from that process is handled, suspending output
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1446 from other processes until some output has been received from that
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1447 process or the timeout expires. If @var{just-this-one} is an integer,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1448 also inhibit running timers. This feature is generally not
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1449 recommended, but may be necessary for specific applications, such as
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1450 speech synthesis.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1451
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1452 The function @code{accept-process-output} returns non-@code{nil} if it
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1453 did get some output, or @code{nil} if the timeout expired before output
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1454 arrived.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1455 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1456
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1457 @node Sentinels
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1458 @section Sentinels: Detecting Process Status Changes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1459 @cindex process sentinel
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1460 @cindex sentinel (of process)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1461
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1462 A @dfn{process sentinel} is a function that is called whenever the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1463 associated process changes status for any reason, including signals
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1464 (whether sent by Emacs or caused by the process's own actions) that
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1465 terminate, stop, or continue the process. The process sentinel is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1466 also called if the process exits. The sentinel receives two
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1467 arguments: the process for which the event occurred, and a string
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1468 describing the type of event.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1469
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1470 The string describing the event looks like one of the following:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1471
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1472 @itemize @bullet
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1473 @item
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1474 @code{"finished\n"}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1475
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1476 @item
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1477 @code{"exited abnormally with code @var{exitcode}\n"}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1478
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1479 @item
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1480 @code{"@var{name-of-signal}\n"}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1481
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1482 @item
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1483 @code{"@var{name-of-signal} (core dumped)\n"}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1484 @end itemize
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1485
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1486 A sentinel runs only while Emacs is waiting (e.g., for terminal
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1487 input, or for time to elapse, or for process output). This avoids the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1488 timing errors that could result from running them at random places in
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1489 the middle of other Lisp programs. A program can wait, so that
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1490 sentinels will run, by calling @code{sit-for} or @code{sleep-for}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1491 (@pxref{Waiting}), or @code{accept-process-output} (@pxref{Accepting
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1492 Output}). Emacs also allows sentinels to run when the command loop is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1493 reading input. @code{delete-process} calls the sentinel when it
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1494 terminates a running process.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1495
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1496 Emacs does not keep a queue of multiple reasons to call the sentinel
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1497 of one process; it records just the current status and the fact that
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1498 there has been a change. Therefore two changes in status, coming in
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1499 quick succession, can call the sentinel just once. However, process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1500 termination will always run the sentinel exactly once. This is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1501 because the process status can't change again after termination.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1502
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1503 Emacs explicitly checks for output from the process before running
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1504 the process sentinel. Once the sentinel runs due to process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1505 termination, no further output can arrive from the process.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1506
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1507 A sentinel that writes the output into the buffer of the process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1508 should check whether the buffer is still alive. If it tries to insert
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1509 into a dead buffer, it will get an error. If the buffer is dead,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1510 @code{(buffer-name (process-buffer @var{process}))} returns @code{nil}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1511
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1512 Quitting is normally inhibited within a sentinel---otherwise, the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1513 effect of typing @kbd{C-g} at command level or to quit a user command
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1514 would be unpredictable. If you want to permit quitting inside a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1515 sentinel, bind @code{inhibit-quit} to @code{nil}. In most cases, the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1516 right way to do this is with the macro @code{with-local-quit}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1517 @xref{Quitting}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1518
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1519 If an error happens during execution of a sentinel, it is caught
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1520 automatically, so that it doesn't stop the execution of whatever
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1521 programs was running when the sentinel was started. However, if
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1522 @code{debug-on-error} is non-@code{nil}, the error-catching is turned
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1523 off. This makes it possible to use the Lisp debugger to debug the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1524 sentinel. @xref{Debugger}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1525
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1526 While a sentinel is running, the process sentinel is temporarily
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1527 set to @code{nil} so that the sentinel won't run recursively.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1528 For this reason it is not possible for a sentinel to specify
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1529 a new sentinel.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1530
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1531 In earlier Emacs versions, every sentinel that did regular expression
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1532 searching or matching had to explicitly save and restore the match data.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1533 Now Emacs does this automatically for sentinels; they never need to do
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1534 it explicitly. @xref{Match Data}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1535
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1536 @defun set-process-sentinel process sentinel
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1537 This function associates @var{sentinel} with @var{process}. If
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1538 @var{sentinel} is @code{nil}, then the process will have no sentinel.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1539 The default behavior when there is no sentinel is to insert a message in
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1540 the process's buffer when the process status changes.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1541
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1542 Changes in process sentinel take effect immediately---if the sentinel
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1543 is slated to be run but has not been called yet, and you specify a new
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1544 sentinel, the eventual call to the sentinel will use the new one.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1545
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1546 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1547 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1548 (defun msg-me (process event)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1549 (princ
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1550 (format "Process: %s had the event `%s'" process event)))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1551 (set-process-sentinel (get-process "shell") 'msg-me)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1552 @result{} msg-me
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1553 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1554 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1555 (kill-process (get-process "shell"))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1556 @print{} Process: #<process shell> had the event `killed'
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1557 @result{} #<process shell>
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1558 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1559 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1560 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1561
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1562 @defun process-sentinel process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1563 This function returns the sentinel of @var{process}, or @code{nil} if it
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1564 has none.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1565 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1566
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1567 @defun waiting-for-user-input-p
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1568 While a sentinel or filter function is running, this function returns
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1569 non-@code{nil} if Emacs was waiting for keyboard input from the user at
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1570 the time the sentinel or filter function was called, @code{nil} if it
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1571 was not.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1572 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1573
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1574 @node Query Before Exit
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1575 @section Querying Before Exit
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1576
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1577 When Emacs exits, it terminates all its subprocesses by sending them
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1578 the @code{SIGHUP} signal. Because subprocesses may be doing
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1579 valuable work, Emacs normally asks the user to confirm that it is ok
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1580 to terminate them. Each process has a query flag which, if
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1581 non-@code{nil}, says that Emacs should ask for confirmation before
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1582 exiting and thus killing that process. The default for the query flag
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1583 is @code{t}, meaning @emph{do} query.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1584
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1585 @defun process-query-on-exit-flag process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1586 This returns the query flag of @var{process}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1587 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1588
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1589 @defun set-process-query-on-exit-flag process flag
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1590 This function sets the query flag of @var{process} to @var{flag}. It
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1591 returns @var{flag}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1592
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1593 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1594 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1595 ;; @r{Don't query about the shell process}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1596 (set-process-query-on-exit-flag (get-process "shell") nil)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1597 @result{} t
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1598 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1599 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1600 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1601
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1602 @defun process-kill-without-query process &optional do-query
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1603 This function clears the query flag of @var{process}, so that
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1604 Emacs will not query the user on account of that process.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1605
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1606 Actually, the function does more than that: it returns the old value of
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1607 the process's query flag, and sets the query flag to @var{do-query}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1608 Please don't use this function to do those things any more---please
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1609 use the newer, cleaner functions @code{process-query-on-exit-flag} and
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1610 @code{set-process-query-on-exit-flag} in all but the simplest cases.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1611 The only way you should use @code{process-kill-without-query} nowadays
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1612 is like this:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1613
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1614 @smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1615 @group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1616 ;; @r{Don't query about the shell process}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1617 (process-kill-without-query (get-process "shell"))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1618 @end group
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1619 @end smallexample
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1620 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1621
98719
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1622 @node System Processes
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1623 @section Accessing Other Processes
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1624 @cindex system processes
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1625
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1626 In addition to accessing and manipulating processes that are
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1627 subprocesses of the current Emacs session, Emacs Lisp programs can
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1628 also access other processes running on the same machine. We call
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1629 these @dfn{system processes}, to distinguish between them and Emacs
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1630 subprocesses.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1631
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1632 Emacs provides several primitives for accessing system processes.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1633 Not all platforms support these primitives; on those which don't,
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1634 these primitives return @code{nil}.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1635
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1636 @defun list-system-processes
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1637 This function returns a list of all the processes running on the
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1638 system. Each process is identified by its @acronym{PID}, a numerical
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1639 process ID that is assigned by the OS and distinguishes the process
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1640 from all the other processes running on the same machine at the same
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1641 time.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1642 @end defun
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1643
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1644 @defun system-process-attributes pid
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1645 This function returns an alist of attributes for the process specified
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1646 by its process ID @var{pid}. Each association in the alist is of the
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1647 form @code{(@var{key} . @var{value})}, where @var{key} designates the
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1648 attribute and @var{value} is the value of that attribute. The various
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1649 attribute @var{key}'s that this function can return are listed below.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1650 Not all platforms support all of these attributes; if an attribute is
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1651 not supported, its association will not appear in the returned alist.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1652 Values that are numbers can be either integer or floating-point,
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1653 depending on the magnitude of the value.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1654
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1655 @table @code
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1656 @item euid
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1657 The effective user ID of the user who invoked the process. The
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1658 corresponding @var{value} is a number. If the process was invoked by
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1659 the same user who runs the current Emacs session, the value is
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1660 identical to what @code{user-uid} returns (@pxref{User
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1661 Identification}).
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1662
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1663 @item user
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1664 User name corresponding to the process's effective user ID, a string.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1665
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1666 @item egid
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1667 The group ID of the effective user ID, a number.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1668
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1669 @item group
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1670 Group name corresponding to the effective user's group ID, a string.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1671
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1672 @item comm
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1673 The name of the command that runs in the process. This is a string
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1674 that usually specifies the name of the executable file of the process,
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1675 without the leading directories. However, some special system
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1676 processes can report strings that do not correspond to an executable
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1677 file of a program.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1678
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1679 @item state
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1680 The state code of the process. This is a short string that encodes
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1681 the scheduling state of the process. Here's a list of the most
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1682 frequently seen codes:
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1683
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1684 @table @code
98725
2bded667b0a1 (System Processes): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 98719
diff changeset
1685 @item "D"
98719
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1686 uninterruptible sleep (usually I/O)
98725
2bded667b0a1 (System Processes): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 98719
diff changeset
1687 @item "R"
98719
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1688 running
98725
2bded667b0a1 (System Processes): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 98719
diff changeset
1689 @item "S"
98719
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1690 interruptible sleep (waiting for some event)
98725
2bded667b0a1 (System Processes): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 98719
diff changeset
1691 @item "T"
98719
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1692 stopped, e.g., by a job control signal
98725
2bded667b0a1 (System Processes): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 98719
diff changeset
1693 @item "Z"
2bded667b0a1 (System Processes): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 98719
diff changeset
1694 ``zombie'': a process that terminated, but was not reaped by its parent
98719
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1695 @end table
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1696
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1697 @noindent
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1698 For the full list of the possible states, see the manual page of the
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1699 @command{ps} command.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1700
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1701 @item ppid
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1702 The process ID of the parent process, a number.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1703
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1704 @item pgrp
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1705 The process group ID of the process, a number.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1706
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1707 @item sess
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1708 The session ID of the process. This is a number that is the process
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1709 ID of the process's @dfn{session leader}.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1710
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1711 @item ttname
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1712 A string that is the name of the process's controlling terminal. On
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1713 Unix and GNU systems, this is normally the file name of the
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1714 corresponding terminal device, such as @file{/dev/pts65}.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1715
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1716 @item tpgid
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1717 The numerical process group ID of the foreground process group that
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1718 uses the process's terminal.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1719
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1720 @item minflt
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1721 The number of minor page faults caused by the process since its
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1722 beginning. (Minor page faults are those that don't involve reading
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1723 from disk.)
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1724
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1725 @item majflt
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1726 The number of major page faults caused by the process since its
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1727 beginning. (Major page faults require a disk to be read, and are thus
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1728 more expensive than minor page faults.)
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1729
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1730 @item cminflt
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1731 @itemx cmajflt
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1732 Like @code{minflt} and @code{majflt}, but include the number of page
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1733 faults for all the child processes of the given process.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1734
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1735 @item utime
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1736 Time spent by the process in the user context, for running the
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1737 application's code. The corresponding @var{value} is in the
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1738 @w{@code{(@var{high} @var{low} @var{microsec})}} format, the same
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1739 format used by functions @code{current-time} (@pxref{Time of Day,
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1740 current-time}) and @code{file-attributes} (@pxref{File Attributes}).
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1741
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1742 @item stime
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1743 Time spent by the process in the system (kernel) context, for
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1744 processing system calls. The corresponding @var{value} is in the same
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1745 format as for @code{utime}.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1746
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1747 @item cutime
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1748 @itemx cstime
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1749 Like @code{utime} and @code{stime}, but includes the times of all the
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1750 child processes of the given process.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1751
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1752 @item pri
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1753 The numerical priority of the process.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1754
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1755 @item nice
98725
2bded667b0a1 (System Processes): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 98719
diff changeset
1756 The @dfn{nice value} of the process, a number. (Processes with smaller
2bded667b0a1 (System Processes): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents: 98719
diff changeset
1757 nice values get scheduled more favorably.)
98719
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1758
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1759 @item thcount
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1760 The number of threads in the process.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1761
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1762 @item start
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1763 The time the process was started, in the @w{@code{(@var{high}
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1764 @var{low} @var{microsec})}} format used by @code{current-time} and
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1765 @code{file-attributes}.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1766
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1767 @item etime
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1768 The time elapsed since the process started, in the @w{@code{(@var{high}
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1769 @var{low} @var{microsec})}} format.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1770
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1771 @item vsize
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1772 The virtual memory size of the process, measured in kilobytes.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1773
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1774 @item rss
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1775 The size of the process's @dfn{resident set}, the number of kilobytes
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1776 occupied by the process in the machine's physical memory.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1777
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1778 @item pcpu
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1779 The percentage of the CPU time used by the process since it started.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1780 The corresponding @var{value} is a floating-point number between 0 and
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1781 100.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1782
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1783 @item pmem
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1784 The percentage of the total physical memory installed on the machine
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1785 used by the process's resident set. The value is a floating-point
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1786 number between 0 and 100.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1787
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1788 @item args
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1789 The command-line with which the process was invoked. This is a string
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1790 in which individual command-line arguments are separated by blanks;
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1791 whitespace characters that are embedded in the arguments are quoted as
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1792 appropriate for the system's shell: escaped by backslash characters on
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1793 GNU and Unix, and enclosed in double quote characters on Windows.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1794 Thus, this command-line string can be directly used in primitives such
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1795 as @code{shell-command}.
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1796 @end table
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1797
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1798 @end defun
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1799
1276ed04542b (System Processes): New section.
Eli Zaretskii <eliz@gnu.org>
parents: 95881
diff changeset
1800
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1801 @node Transaction Queues
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1802 @section Transaction Queues
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1803 @cindex transaction queue
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1804
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1805 You can use a @dfn{transaction queue} to communicate with a subprocess
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1806 using transactions. First use @code{tq-create} to create a transaction
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1807 queue communicating with a specified process. Then you can call
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1808 @code{tq-enqueue} to send a transaction.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1809
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1810 @defun tq-create process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1811 This function creates and returns a transaction queue communicating with
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1812 @var{process}. The argument @var{process} should be a subprocess
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1813 capable of sending and receiving streams of bytes. It may be a child
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1814 process, or it may be a TCP connection to a server, possibly on another
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1815 machine.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1816 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1817
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1818 @defun tq-enqueue queue question regexp closure fn &optional delay-question
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1819 This function sends a transaction to queue @var{queue}. Specifying the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1820 queue has the effect of specifying the subprocess to talk to.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1821
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1822 The argument @var{question} is the outgoing message that starts the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1823 transaction. The argument @var{fn} is the function to call when the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1824 corresponding answer comes back; it is called with two arguments:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1825 @var{closure}, and the answer received.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1826
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1827 The argument @var{regexp} is a regular expression that should match
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1828 text at the end of the entire answer, but nothing before; that's how
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1829 @code{tq-enqueue} determines where the answer ends.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1830
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1831 If the argument @var{delay-question} is non-nil, delay sending this
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1832 question until the process has finished replying to any previous
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1833 questions. This produces more reliable results with some processes.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1834
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1835 The return value of @code{tq-enqueue} itself is not meaningful.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1836 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1837
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1838 @defun tq-close queue
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1839 Shut down transaction queue @var{queue}, waiting for all pending transactions
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1840 to complete, and then terminate the connection or child process.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1841 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1842
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1843 Transaction queues are implemented by means of a filter function.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1844 @xref{Filter Functions}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1845
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1846 @node Network
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1847 @section Network Connections
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1848 @cindex network connection
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1849 @cindex TCP
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1850 @cindex UDP
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1851
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1852 Emacs Lisp programs can open stream (TCP) and datagram (UDP) network
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1853 connections to other processes on the same machine or other machines.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1854 A network connection is handled by Lisp much like a subprocess, and is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1855 represented by a process object. However, the process you are
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1856 communicating with is not a child of the Emacs process, so it has no
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1857 process @acronym{ID}, and you can't kill it or send it signals. All you
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1858 can do is send and receive data. @code{delete-process} closes the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1859 connection, but does not kill the program at the other end; that
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1860 program must decide what to do about closure of the connection.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1861
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1862 Lisp programs can listen for connections by creating network
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1863 servers. A network server is also represented by a kind of process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1864 object, but unlike a network connection, the network server never
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1865 transfers data itself. When it receives a connection request, it
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1866 creates a new network connection to represent the connection just
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1867 made. (The network connection inherits certain information, including
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1868 the process plist, from the server.) The network server then goes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1869 back to listening for more connection requests.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1870
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1871 Network connections and servers are created by calling
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1872 @code{make-network-process} with an argument list consisting of
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1873 keyword/argument pairs, for example @code{:server t} to create a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1874 server process, or @code{:type 'datagram} to create a datagram
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1875 connection. @xref{Low-Level Network}, for details. You can also use
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1876 the @code{open-network-stream} function described below.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1877
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
1878 To distinguish the different types of processes, the
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
1879 @code{process-type} function returns the symbol @code{network} for a
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
1880 network connection or server, @code{serial} for a serial port
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
1881 connection, or @code{real} for a real subprocess.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
1882
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
1883 The @code{process-status} function returns @code{open},
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
1884 @code{closed}, @code{connect}, and @code{failed} for network
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
1885 connections. For a network server, the status is always
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1886 @code{listen}. None of those values is possible for a real
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1887 subprocess. @xref{Process Information}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1888
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1889 You can stop and resume operation of a network process by calling
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1890 @code{stop-process} and @code{continue-process}. For a server
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1891 process, being stopped means not accepting new connections. (Up to 5
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1892 connection requests will be queued for when you resume the server; you
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1893 can increase this limit, unless it is imposed by the operating
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1894 system.) For a network stream connection, being stopped means not
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1895 processing input (any arriving input waits until you resume the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1896 connection). For a datagram connection, some number of packets may be
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1897 queued but input may be lost. You can use the function
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1898 @code{process-command} to determine whether a network connection or
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1899 server is stopped; a non-@code{nil} value means yes.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1900
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1901 @defun open-network-stream name buffer-or-name host service
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1902 This function opens a TCP connection, and returns a process object
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1903 that represents the connection.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1904
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1905 The @var{name} argument specifies the name for the process object. It
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1906 is modified as necessary to make it unique.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1907
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1908 The @var{buffer-or-name} argument is the buffer to associate with the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1909 connection. Output from the connection is inserted in the buffer,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1910 unless you specify a filter function to handle the output. If
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1911 @var{buffer-or-name} is @code{nil}, it means that the connection is not
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1912 associated with any buffer.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1913
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1914 The arguments @var{host} and @var{service} specify where to connect to;
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1915 @var{host} is the host name (a string), and @var{service} is the name of
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1916 a defined network service (a string) or a port number (an integer).
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1917 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1918
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1919 @node Network Servers
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1920 @section Network Servers
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1921 @cindex network servers
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1922
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1923 You create a server by calling @code{make-network-process} with
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1924 @code{:server t}. The server will listen for connection requests from
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1925 clients. When it accepts a client connection request, that creates a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1926 new network connection, itself a process object, with the following
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1927 parameters:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1928
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1929 @itemize @bullet
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1930 @item
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1931 The connection's process name is constructed by concatenating the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1932 server process' @var{name} with a client identification string. The
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1933 client identification string for an IPv4 connection looks like
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1934 @samp{<@var{a}.@var{b}.@var{c}.@var{d}:@var{p}>}. Otherwise, it is a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1935 unique number in brackets, as in @samp{<@var{nnn}>}. The number
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1936 is unique for each connection in the Emacs session.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1937
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1938 @item
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1939 If the server's filter is non-@code{nil}, the connection process does
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1940 not get a separate process buffer; otherwise, Emacs creates a new
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1941 buffer for the purpose. The buffer name is the server's buffer name
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1942 or process name, concatenated with the client identification string.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1943
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1944 The server's process buffer value is never used directly by Emacs, but
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1945 it is passed to the log function, which can log connections by
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1946 inserting text there.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1947
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1948 @item
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1949 The communication type and the process filter and sentinel are
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1950 inherited from those of the server. The server never directly
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1951 uses its filter and sentinel; their sole purpose is to initialize
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1952 connections made to the server.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1953
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1954 @item
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1955 The connection's process contact info is set according to the client's
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1956 addressing information (typically an IP address and a port number).
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1957 This information is associated with the @code{process-contact}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1958 keywords @code{:host}, @code{:service}, @code{:remote}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1959
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1960 @item
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1961 The connection's local address is set up according to the port
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1962 number used for the connection.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1963
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1964 @item
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1965 The client process' plist is initialized from the server's plist.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1966 @end itemize
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1967
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1968 @node Datagrams
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1969 @section Datagrams
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1970 @cindex datagrams
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1971
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1972 A datagram connection communicates with individual packets rather
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1973 than streams of data. Each call to @code{process-send} sends one
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1974 datagram packet (@pxref{Input to Processes}), and each datagram
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1975 received results in one call to the filter function.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1976
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1977 The datagram connection doesn't have to talk with the same remote
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1978 peer all the time. It has a @dfn{remote peer address} which specifies
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1979 where to send datagrams to. Each time an incoming datagram is passed
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1980 to the filter function, the peer address is set to the address that
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1981 datagram came from; that way, if the filter function sends a datagram,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1982 it will go back to that place. You can specify the remote peer
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1983 address when you create the datagram connection using the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1984 @code{:remote} keyword. You can change it later on by calling
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1985 @code{set-process-datagram-address}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1986
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1987 @defun process-datagram-address process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1988 If @var{process} is a datagram connection or server, this function
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1989 returns its remote peer address.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1990 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1991
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1992 @defun set-process-datagram-address process address
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1993 If @var{process} is a datagram connection or server, this function
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1994 sets its remote peer address to @var{address}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1995 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1996
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1997 @node Low-Level Network
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1998 @section Low-Level Network Access
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1999
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2000 You can also create network connections by operating at a lower
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2001 level than that of @code{open-network-stream}, using
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2002 @code{make-network-process}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2003
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2004 @menu
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2005 * Proc: Network Processes. Using @code{make-network-process}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2006 * Options: Network Options. Further control over network connections.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2007 * Features: Network Feature Testing.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2008 Determining which network features work on
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2009 the machine you are using.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2010 @end menu
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2011
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2012 @node Network Processes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2013 @subsection @code{make-network-process}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2014
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2015 The basic function for creating network connections and network
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2016 servers is @code{make-network-process}. It can do either of those
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2017 jobs, depending on the arguments you give it.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2018
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2019 @defun make-network-process &rest args
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2020 This function creates a network connection or server and returns the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2021 process object that represents it. The arguments @var{args} are a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2022 list of keyword/argument pairs. Omitting a keyword is always
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2023 equivalent to specifying it with value @code{nil}, except for
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2024 @code{:coding}, @code{:filter-multibyte}, and @code{:reuseaddr}. Here
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2025 are the meaningful keywords:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2026
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2027 @table @asis
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2028 @item :name @var{name}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2029 Use the string @var{name} as the process name. It is modified if
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2030 necessary to make it unique.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2031
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2032 @item :type @var{type}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2033 Specify the communication type. A value of @code{nil} specifies a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2034 stream connection (the default); @code{datagram} specifies a datagram
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2035 connection. Both connections and servers can be of either type.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2036
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2037 @item :server @var{server-flag}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2038 If @var{server-flag} is non-@code{nil}, create a server. Otherwise,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2039 create a connection. For a stream type server, @var{server-flag} may
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2040 be an integer which then specifies the length of the queue of pending
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2041 connections to the server. The default queue length is 5.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2042
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2043 @item :host @var{host}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2044 Specify the host to connect to. @var{host} should be a host name or
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2045 Internet address, as a string, or the symbol @code{local} to specify
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2046 the local host. If you specify @var{host} for a server, it must
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2047 specify a valid address for the local host, and only clients
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2048 connecting to that address will be accepted.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2049
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2050 @item :service @var{service}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2051 @var{service} specifies a port number to connect to, or, for a server,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2052 the port number to listen on. It should be a service name that
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2053 translates to a port number, or an integer specifying the port number
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2054 directly. For a server, it can also be @code{t}, which means to let
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2055 the system select an unused port number.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2056
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2057 @item :family @var{family}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2058 @var{family} specifies the address (and protocol) family for
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2059 communication. @code{nil} means determine the proper address family
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2060 automatically for the given @var{host} and @var{service}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2061 @code{local} specifies a Unix socket, in which case @var{host} is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2062 ignored. @code{ipv4} and @code{ipv6} specify to use IPv4 and IPv6
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2063 respectively.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2064
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2065 @item :local @var{local-address}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2066 For a server process, @var{local-address} is the address to listen on.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2067 It overrides @var{family}, @var{host} and @var{service}, and you
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2068 may as well not specify them.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2069
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2070 @item :remote @var{remote-address}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2071 For a connection, @var{remote-address} is the address to connect to.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2072 It overrides @var{family}, @var{host} and @var{service}, and you
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2073 may as well not specify them.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2074
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2075 For a datagram server, @var{remote-address} specifies the initial
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2076 setting of the remote datagram address.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2077
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2078 The format of @var{local-address} or @var{remote-address} depends on
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2079 the address family:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2080
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2081 @itemize -
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2082 @item
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2083 An IPv4 address is represented as a five-element vector of four 8-bit
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2084 integers and one 16-bit integer
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2085 @code{[@var{a} @var{b} @var{c} @var{d} @var{p}]} corresponding to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2086 numeric IPv4 address @var{a}.@var{b}.@var{c}.@var{d} and port number
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2087 @var{p}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2088
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2089 @item
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2090 An IPv6 address is represented as a nine-element vector of 16-bit
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2091 integers @code{[@var{a} @var{b} @var{c} @var{d} @var{e} @var{f}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2092 @var{g} @var{h} @var{p}]} corresponding to numeric IPv6 address
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2093 @var{a}:@var{b}:@var{c}:@var{d}:@var{e}:@var{f}:@var{g}:@var{h} and
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2094 port number @var{p}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2096 @item
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2097 A local address is represented as a string which specifies the address
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2098 in the local address space.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2099
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2100 @item
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2101 An ``unsupported family'' address is represented by a cons
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2102 @code{(@var{f} . @var{av})}, where @var{f} is the family number and
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2103 @var{av} is a vector specifying the socket address using one element
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2104 per address data byte. Do not rely on this format in portable code,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2105 as it may depend on implementation defined constants, data sizes, and
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2106 data structure alignment.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2107 @end itemize
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2108
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2109 @item :nowait @var{bool}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2110 If @var{bool} is non-@code{nil} for a stream connection, return
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2111 without waiting for the connection to complete. When the connection
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2112 succeeds or fails, Emacs will call the sentinel function, with a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2113 second argument matching @code{"open"} (if successful) or
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2114 @code{"failed"}. The default is to block, so that
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2115 @code{make-network-process} does not return until the connection
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2116 has succeeded or failed.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2117
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2118 @item :stop @var{stopped}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2119 Start the network connection or server in the `stopped' state if
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2120 @var{stopped} is non-@code{nil}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2121
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2122 @item :buffer @var{buffer}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2123 Use @var{buffer} as the process buffer.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2124
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2125 @item :coding @var{coding}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2126 Use @var{coding} as the coding system for this process. To specify
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2127 different coding systems for decoding data from the connection and for
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2128 encoding data sent to it, specify @code{(@var{decoding} .
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2129 @var{encoding})} for @var{coding}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2130
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2131 If you don't specify this keyword at all, the default
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2132 is to determine the coding systems from the data.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2133
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2134 @item :noquery @var{query-flag}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2135 Initialize the process query flag to @var{query-flag}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2136 @xref{Query Before Exit}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2137
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2138 @item :filter @var{filter}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2139 Initialize the process filter to @var{filter}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2140
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2141 @item :filter-multibyte @var{bool}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2142 If @var{bool} is non-@code{nil}, strings given to the process filter
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2143 are multibyte, otherwise they are unibyte. If you don't specify this
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2144 keyword at all, the default is that the strings are multibyte if
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2145 @code{default-enable-multibyte-characters} is non-@code{nil}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2146
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2147 @item :sentinel @var{sentinel}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2148 Initialize the process sentinel to @var{sentinel}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2149
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2150 @item :log @var{log}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2151 Initialize the log function of a server process to @var{log}. The log
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2152 function is called each time the server accepts a network connection
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2153 from a client. The arguments passed to the log function are
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2154 @var{server}, @var{connection}, and @var{message}, where @var{server}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2155 is the server process, @var{connection} is the new process for the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2156 connection, and @var{message} is a string describing what has
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2157 happened.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2158
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2159 @item :plist @var{plist}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2160 Initialize the process plist to @var{plist}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2161 @end table
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2162
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2163 The original argument list, modified with the actual connection
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2164 information, is available via the @code{process-contact} function.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2165 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2166
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2167 @node Network Options
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2168 @subsection Network Options
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2169
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2170 The following network options can be specified when you create a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2171 network process. Except for @code{:reuseaddr}, you can also set or
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2172 modify these options later, using @code{set-network-process-option}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2173
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2174 For a server process, the options specified with
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2175 @code{make-network-process} are not inherited by the client
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2176 connections, so you will need to set the necessary options for each
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2177 child connection as it is created.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2178
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2179 @table @asis
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2180 @item :bindtodevice @var{device-name}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2181 If @var{device-name} is a non-empty string identifying a network
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2182 interface name (see @code{network-interface-list}), only handle
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2183 packets received on that interface. If @var{device-name} is @code{nil}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2184 (the default), handle packets received on any interface.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2185
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2186 Using this option may require special privileges on some systems.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2187
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2188 @item :broadcast @var{broadcast-flag}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2189 If @var{broadcast-flag} is non-@code{nil} for a datagram process, the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2190 process will receive datagram packet sent to a broadcast address, and
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2191 be able to send packets to a broadcast address. Ignored for a stream
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2192 connection.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2193
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2194 @item :dontroute @var{dontroute-flag}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2195 If @var{dontroute-flag} is non-@code{nil}, the process can only send
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2196 to hosts on the same network as the local host.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2197
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2198 @item :keepalive @var{keepalive-flag}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2199 If @var{keepalive-flag} is non-@code{nil} for a stream connection,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2200 enable exchange of low-level keep-alive messages.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2201
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2202 @item :linger @var{linger-arg}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2203 If @var{linger-arg} is non-@code{nil}, wait for successful
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2204 transmission of all queued packets on the connection before it is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2205 deleted (see @code{delete-process}). If @var{linger-arg} is an
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2206 integer, it specifies the maximum time in seconds to wait for queued
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2207 packets to be sent before closing the connection. Default is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2208 @code{nil} which means to discard unsent queued packets when the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2209 process is deleted.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2210
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2211 @item :oobinline @var{oobinline-flag}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2212 If @var{oobinline-flag} is non-@code{nil} for a stream connection,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2213 receive out-of-band data in the normal data stream. Otherwise, ignore
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2214 out-of-band data.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2215
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2216 @item :priority @var{priority}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2217 Set the priority for packets sent on this connection to the integer
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2218 @var{priority}. The interpretation of this number is protocol
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2219 specific, such as setting the TOS (type of service) field on IP
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2220 packets sent on this connection. It may also have system dependent
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2221 effects, such as selecting a specific output queue on the network
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2222 interface.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2223
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2224 @item :reuseaddr @var{reuseaddr-flag}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2225 If @var{reuseaddr-flag} is non-@code{nil} (the default) for a stream
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2226 server process, allow this server to reuse a specific port number (see
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2227 @code{:service}) unless another process on this host is already
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2228 listening on that port. If @var{reuseaddr-flag} is @code{nil}, there
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2229 may be a period of time after the last use of that port (by any
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2230 process on the host), where it is not possible to make a new server on
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2231 that port.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2232 @end table
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2233
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2234 @defun set-network-process-option process option value
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2235 This function sets or modifies a network option for network process
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2236 @var{process}. See @code{make-network-process} for details of options
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2237 @var{option} and their corresponding values @var{value}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2238
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2239 The current setting of an option is available via the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2240 @code{process-contact} function.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2241 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2242
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2243 @node Network Feature Testing
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2244 @subsection Testing Availability of Network Features
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2245
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2246 To test for the availability of a given network feature, use
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2247 @code{featurep} like this:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2248
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2249 @example
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2250 (featurep 'make-network-process '(@var{keyword} @var{value}))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2251 @end example
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2252
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2253 @noindent
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2254 The result of the first form is @code{t} if it works to specify
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2255 @var{keyword} with value @var{value} in @code{make-network-process}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2256 The result of the second form is @code{t} if @var{keyword} is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2257 supported by @code{make-network-process}. Here are some of the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2258 @var{keyword}---@var{value} pairs you can test in
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2259 this way.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2260
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2261 @table @code
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2262 @item (:nowait t)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2263 Non-@code{nil} if non-blocking connect is supported.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2264 @item (:type datagram)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2265 Non-@code{nil} if datagrams are supported.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2266 @item (:family local)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2267 Non-@code{nil} if local (a.k.a.@: ``UNIX domain'') sockets are supported.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2268 @item (:family ipv6)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2269 Non-@code{nil} if IPv6 is supported.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2270 @item (:service t)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2271 Non-@code{nil} if the system can select the port for a server.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2272 @end table
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2273
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2274 To test for the availability of a given network option, use
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2275 @code{featurep} like this:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2276
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2277 @example
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2278 (featurep 'make-network-process '@var{keyword})
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2279 @end example
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2280
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2281 @noindent
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2282 Here are some of the options you can test in this way.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2283
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2284 @table @code
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2285 @item :bindtodevice
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2286 @itemx :broadcast
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2287 @itemx :dontroute
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2288 @itemx :keepalive
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2289 @itemx :linger
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2290 @itemx :oobinline
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2291 @itemx :priority
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2292 @itemx :reuseaddr
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2293 That particular network option is supported by
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2294 @code{make-network-process} and @code{set-network-process-option}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2295 @end table
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2296
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2297 @node Misc Network
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2298 @section Misc Network Facilities
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2299
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2300 These additional functions are useful for creating and operating
85114
5039706521c9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
2301 on network connections. Note that they are supported only on some
5039706521c9 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84116
diff changeset
2302 systems.
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2303
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2304 @defun network-interface-list
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2305 This function returns a list describing the network interfaces
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2306 of the machine you are using. The value is an alist whose
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2307 elements have the form @code{(@var{name} . @var{address})}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2308 @var{address} has the same form as the @var{local-address}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2309 and @var{remote-address} arguments to @code{make-network-process}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2310 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2311
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2312 @defun network-interface-info ifname
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2313 This function returns information about the network interface named
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2314 @var{ifname}. The value is a list of the form
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2315 @code{(@var{addr} @var{bcast} @var{netmask} @var{hwaddr} @var{flags})}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2316
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2317 @table @var
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2318 @item addr
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2319 The Internet protocol address.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2320 @item bcast
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2321 The broadcast address.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2322 @item netmask
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2323 The network mask.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2324 @item hwaddr
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2325 The layer 2 address (Ethernet MAC address, for instance).
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2326 @item flags
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2327 The current flags of the interface.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2328 @end table
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2329 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2330
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2331 @defun format-network-address address &optional omit-port
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2332 This function converts the Lisp representation of a network address to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2333 a string.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2334
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2335 A five-element vector @code{[@var{a} @var{b} @var{c} @var{d} @var{p}]}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2336 represents an IPv4 address @var{a}.@var{b}.@var{c}.@var{d} and port
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2337 number @var{p}. @code{format-network-address} converts that to the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2338 string @code{"@var{a}.@var{b}.@var{c}.@var{d}:@var{p}"}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2339
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2340 A nine-element vector @code{[@var{a} @var{b} @var{c} @var{d} @var{e}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2341 @var{f} @var{g} @var{h} @var{p}]} represents an IPv6 address along
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2342 with a port number. @code{format-network-address} converts that to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2343 the string
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2344 @code{"[@var{a}:@var{b}:@var{c}:@var{d}:@var{e}:@var{f}:@var{g}:@var{h}]:@var{p}"}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2345
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2346 If the vector does not include the port number, @var{p}, or if
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2347 @var{omit-port} is non-@code{nil}, the result does not include the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2348 @code{:@var{p}} suffix.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2349 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2350
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2351 @node Serial Ports
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2352 @section Communicating with Serial Ports
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2353 @cindex @file{/dev/tty}
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2354 @cindex @file{COM1}
98997
4660d5e01148 (Serial Ports): Wording fixes.
Eli Zaretskii <eliz@gnu.org>
parents: 98985
diff changeset
2355 @cindex serial connections
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2356
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2357 Emacs can communicate with serial ports. For interactive use,
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2358 @kbd{M-x serial-term} opens a terminal window. In a Lisp program,
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2359 @code{make-serial-process} creates a process object.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2360
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2361 The serial port can be configured at run-time, without having to
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2362 close and re-open it. The function @code{serial-process-configure}
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2363 lets you change the speed, bytesize, and other parameters. In a
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2364 terminal window created by @code{serial-term}, you can click on the
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2365 mode line for configuration.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2366
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2367 A serial connection is represented by a process object which can be
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2368 used similar to a subprocess or network process. You can send and
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2369 receive data and configure the serial port. A serial process object
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2370 has no process ID, you can't send signals to it, and the status codes
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2371 are different from other types of processes.
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2372 @code{delete-process} on the process object or @code{kill-buffer} on
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2373 the process buffer close the connection, but this does not affect the
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2374 device connected to the serial port.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2375
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2376 The function @code{process-type} returns the symbol @code{serial}
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2377 for a process object representing a serial port connection.
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2378
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2379 Serial ports are available on GNU/Linux, Unix, and Windows systems.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2380
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2381 @deffn Command serial-term port speed
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2382 Start a terminal-emulator for a serial port in a new buffer.
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2383 @var{port} is the name of the serial port to which to connect. For
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2384 example, this could be @file{/dev/ttyS0} on Unix. On Windows, this
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2385 could be @file{COM1}, or @file{\\.\COM10} (double the backslashes in
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2386 Lisp strings).
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2387
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2388 @var{speed} is the speed of the serial port in bits per second. 9600
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2389 is a common value. The buffer is in Term mode; see @ref{Term Mode,,,
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2390 emacs, The GNU Emacs Manual}, for the commands to use in that buffer.
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2391 You can change the speed and the configuration in the mode line menu.
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2392 @end deffn
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2393
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2394 @defun make-serial-process &rest args
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2395 This function creates a process and a buffer. Arguments are specified
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2396 as keyword/argument pairs. Here's the list of the meaningful keywords:
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2397
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2398 @table @code
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2399 @item :port @var{port}@r{ (mandatory)}
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2400 This is the name of the serial port. On Unix and GNU systems, this is
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2401 a file name such as @file{/dev/ttyS0}. On Windows, this could be
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2402 @file{COM1}, or @file{\\.\COM10} for ports higher than @file{COM9}
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2403 (double the backslashes in Lisp strings).
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2404
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2405 @item :speed @var{speed}@r{ (mandatory)}
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2406 The speed of the serial port in bits per second. This function calls
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2407 @code{serial-process-configure} to handle the speed.
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2408
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2409 @item :name @var{name}
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2410 The name of the process. If @var{name} is not given, @var{port} will
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2411 serve as the process name as well.
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2412
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2413 @item :buffer @var{buffer}
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2414 The buffer to associate with the process. The value could be either a
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2415 buffer or a string that names a buffer. Process output goes at the
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2416 end of that buffer, unless you specify an output stream or filter
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2417 function to handle the output. If @var{buffer} is not given, the
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2418 process buffer's name is taken from the value of the @code{:name}
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2419 keyword.
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2420
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2421 @item :coding @var{coding}
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2422 If @var{coding} is a symbol, it specifies the coding system used for
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2423 both reading and writing for this process. If @var{coding} is a cons
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2424 @code{(decoding . encoding)}, @var{decoding} is used for reading, and
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2425 @var{encoding} is used for writing. If not specified, the default is
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2426 to determine the coding systems from data itself.
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2427
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2428 @item :noquery @var{query-flag}
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2429 Initialize the process query flag to @var{query-flag}. @xref{Query
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2430 Before Exit}. The flags defaults to @code{nil} if unspecified.
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2431
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2432 @item :stop @var{bool}
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2433 Start process in the @code{stopped} state if @var{bool} is
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2434 non-@code{nil}. In the stopped state, a serial process does not
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2435 accept incoming data, but you can send outgoing data. The stopped
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2436 state is cleared by @code{continue-process} and set by
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2437 @code{stop-process}.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2438
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2439 @item :filter @var{filter}
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2440 Install @var{filter} as the process filter.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2441
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2442 @item :sentinel @var{sentinel}
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2443 Install @var{sentinel} as the process sentinel.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2444
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2445 @item :plist @var{plist}
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2446 Install @var{plist} as the initial plist of the process.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2447
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2448 @item :speed
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2449 @itemx :bytesize
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2450 @itemx :parity
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2451 @itemx :stopbits
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2452 @itemx :flowcontrol
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2453 These arguments are handled by @code{serial-process-configure}, which
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2454 is called by @code{make-serial-process}.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2455 @end table
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2456
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2457 The original argument list, possibly modified by later configuration,
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2458 is available via the function @code{process-contact}.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2459
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2460 Examples:
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2461
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2462 @example
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2463 (make-serial-process :port "/dev/ttyS0" :speed 9600)
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2464
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2465 (make-serial-process :port "COM1" :speed 115200 :stopbits 2)
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2466
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2467 (make-serial-process :port "\\\\.\\COM13" :speed 1200
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2468 :bytesize 7 :parity 'odd)
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2469
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2470 (make-serial-process :port "/dev/tty.BlueConsole-SPP-1" :speed nil)
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2471 @end example
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2472 @end defun
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2473
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2474 @defun serial-process-configure &rest args
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2475 @cindex baud, in serial connections
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2476 @cindex bytesize, in serial connections
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2477 @cindex parity, in serial connections
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2478 @cindex stopbits, in serial connections
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2479 @cindex flowcontrol, in serial connections
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2480
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2481 This functions configures a serial port connection. Arguments are
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2482 specified as keyword/argument pairs. Attributes that are not given
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2483 are re-initialized from the process's current configuration (available
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2484 via the function @code{process-contact}) or set to reasonable default
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2485 values. The following arguments are defined:
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2486
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2487 @table @code
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2488 @item :process @var{process}
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2489 @itemx :name @var{name}
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2490 @itemx :buffer @var{buffer}
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2491 @itemx :port @var{port}
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2492 Any of these arguments can be given to identify the process that is to
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2493 be configured. If none of these arguments is given, the current
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2494 buffer's process is used.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2495
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2496 @item :speed @var{speed}
98997
4660d5e01148 (Serial Ports): Wording fixes.
Eli Zaretskii <eliz@gnu.org>
parents: 98985
diff changeset
2497 The speed of the serial port in bits per second, a.k.a.@: @dfn{baud
4660d5e01148 (Serial Ports): Wording fixes.
Eli Zaretskii <eliz@gnu.org>
parents: 98985
diff changeset
2498 rate}. The value can be any number, but most serial ports work only
4660d5e01148 (Serial Ports): Wording fixes.
Eli Zaretskii <eliz@gnu.org>
parents: 98985
diff changeset
2499 at a few defined values between 1200 and 115200, with 9600 being the
4660d5e01148 (Serial Ports): Wording fixes.
Eli Zaretskii <eliz@gnu.org>
parents: 98985
diff changeset
2500 most common value. If @var{speed} is @code{nil}, the function ignores
4660d5e01148 (Serial Ports): Wording fixes.
Eli Zaretskii <eliz@gnu.org>
parents: 98985
diff changeset
2501 all other arguments and does not configure the port. This may be
4660d5e01148 (Serial Ports): Wording fixes.
Eli Zaretskii <eliz@gnu.org>
parents: 98985
diff changeset
2502 useful for special serial ports such as Bluetooth-to-serial converters
4660d5e01148 (Serial Ports): Wording fixes.
Eli Zaretskii <eliz@gnu.org>
parents: 98985
diff changeset
2503 which can only be configured through AT commands sent through the
4660d5e01148 (Serial Ports): Wording fixes.
Eli Zaretskii <eliz@gnu.org>
parents: 98985
diff changeset
2504 connection. You can use the value of @code{nil} for @var{speed} only
4660d5e01148 (Serial Ports): Wording fixes.
Eli Zaretskii <eliz@gnu.org>
parents: 98985
diff changeset
2505 for connections that are already open by a previous call to
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2506 @code{make-serial-process} or @code{serial-term}.
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2507
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2508 @item :bytesize @var{bytesize}
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2509 The number of bits per byte, which can be 7 or 8. If @var{bytesize}
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2510 is not given or @code{nil}, it defaults to 8.
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2511
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2512 @item :parity @var{parity}
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2513 The value can be @code{nil} (don't use parity), the symbol
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2514 @code{odd} (use odd parity), or the symbol @code{even} (use even
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2515 parity). If @var{parity} is not given, it defaults to no parity.
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2516
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2517 @item :stopbits @var{stopbits}
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2518 The number of stopbits used to terminate a transmission
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2519 of each byte. @var{stopbits} can be 1 or 2. If @var{stopbits} is not
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2520 given or @code{nil}, it defaults to 1.
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2521
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2522 @item :flowcontrol @var{flowcontrol}
98985
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2523 The type of flow control to use for this connection, which is either
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2524 @code{nil} (don't use flow control), the symbol @code{hw} (use RTS/CTS
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2525 hardware flow control), or the symbol @code{sw} (use XON/XOFF software
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2526 flow control). If @var{flowcontrol} is not given, it defaults to no
52a022405809 (Serial Ports): Fix wording and improve markup.
Eli Zaretskii <eliz@gnu.org>
parents: 98945
diff changeset
2527 flow control.
95881
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2528 @end table
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2529
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2530 @code{serial-process-configure} is called by @code{make-serial-process} for the
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2531 initial configuration of the serial port.
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2532
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2533 Examples:
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2534
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2535 @example
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2536 (serial-process-configure :process "/dev/ttyS0" :speed 1200)
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2537
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2538 (serial-process-configure :buffer "COM1" :stopbits 1 :parity 'odd :flowcontrol 'hw)
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2539
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2540 (serial-process-configure :port "\\\\.\\COM13" :bytesize 7)
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2541 @end example
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2542 @end defun
17f08c967105 Daniel Engeler <engeler at gmail.com>
Glenn Morris <rgm@gnu.org>
parents: 93202
diff changeset
2543
84095
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2544 @node Byte Packing
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2545 @section Packing and Unpacking Byte Arrays
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2546 @cindex byte packing and unpacking
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2547
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2548 This section describes how to pack and unpack arrays of bytes,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2549 usually for binary network protocols. These functions convert byte arrays
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2550 to alists, and vice versa. The byte array can be represented as a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2551 unibyte string or as a vector of integers, while the alist associates
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2552 symbols either with fixed-size objects or with recursive sub-alists.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2553
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2554 @cindex serializing
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2555 @cindex deserializing
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2556 @cindex packing
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2557 @cindex unpacking
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2558 Conversion from byte arrays to nested alists is also known as
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2559 @dfn{deserializing} or @dfn{unpacking}, while going in the opposite
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2560 direction is also known as @dfn{serializing} or @dfn{packing}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2561
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2562 @menu
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2563 * Bindat Spec:: Describing data layout.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2564 * Bindat Functions:: Doing the unpacking and packing.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2565 * Bindat Examples:: Samples of what bindat.el can do for you!
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2566 @end menu
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2567
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2568 @node Bindat Spec
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2569 @subsection Describing Data Layout
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2570
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2571 To control unpacking and packing, you write a @dfn{data layout
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2572 specification}, a special nested list describing named and typed
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2573 @dfn{fields}. This specification controls length of each field to be
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2574 processed, and how to pack or unpack it. We normally keep bindat specs
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2575 in variables whose names end in @samp{-bindat-spec}; that kind of name
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2576 is automatically recognized as ``risky.''
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2577
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2578 @cindex endianness
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2579 @cindex big endian
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2580 @cindex little endian
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2581 @cindex network byte ordering
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2582 A field's @dfn{type} describes the size (in bytes) of the object
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2583 that the field represents and, in the case of multibyte fields, how
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2584 the bytes are ordered within the field. The two possible orderings
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2585 are ``big endian'' (also known as ``network byte ordering'') and
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2586 ``little endian.'' For instance, the number @code{#x23cd} (decimal
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2587 9165) in big endian would be the two bytes @code{#x23} @code{#xcd};
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2588 and in little endian, @code{#xcd} @code{#x23}. Here are the possible
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2589 type values:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2590
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2591 @table @code
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2592 @item u8
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2593 @itemx byte
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2594 Unsigned byte, with length 1.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2595
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2596 @item u16
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2597 @itemx word
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2598 @itemx short
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2599 Unsigned integer in network byte order, with length 2.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2600
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2601 @item u24
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2602 Unsigned integer in network byte order, with length 3.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2603
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2604 @item u32
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2605 @itemx dword
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2606 @itemx long
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2607 Unsigned integer in network byte order, with length 4.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2608 Note: These values may be limited by Emacs' integer implementation limits.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2609
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2610 @item u16r
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2611 @itemx u24r
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2612 @itemx u32r
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2613 Unsigned integer in little endian order, with length 2, 3 and 4, respectively.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2614
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2615 @item str @var{len}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2616 String of length @var{len}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2617
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2618 @item strz @var{len}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2619 Zero-terminated string, in a fixed-size field with length @var{len}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2620
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2621 @item vec @var{len} [@var{type}]
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2622 Vector of @var{len} elements of type @var{type}, or bytes if not
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2623 @var{type} is specified.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2624 The @var{type} is any of the simple types above, or another vector
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2625 specified as a list @code{(vec @var{len} [@var{type}])}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2626
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2627 @item ip
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2628 Four-byte vector representing an Internet address. For example:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2629 @code{[127 0 0 1]} for localhost.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2630
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2631 @item bits @var{len}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2632 List of set bits in @var{len} bytes. The bytes are taken in big
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2633 endian order and the bits are numbered starting with @code{8 *
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2634 @var{len} @minus{} 1} and ending with zero. For example: @code{bits
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2635 2} unpacks @code{#x28} @code{#x1c} to @code{(2 3 4 11 13)} and
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2636 @code{#x1c} @code{#x28} to @code{(3 5 10 11 12)}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2637
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2638 @item (eval @var{form})
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2639 @var{form} is a Lisp expression evaluated at the moment the field is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2640 unpacked or packed. The result of the evaluation should be one of the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2641 above-listed type specifications.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2642 @end table
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2643
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2644 For a fixed-size field, the length @var{len} is given as an integer
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2645 specifying the number of bytes in the field.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2646
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2647 When the length of a field is not fixed, it typically depends on the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2648 value of a preceding field. In this case, the length @var{len} can be
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2649 given either as a list @code{(@var{name} ...)} identifying a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2650 @dfn{field name} in the format specified for @code{bindat-get-field}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2651 below, or by an expression @code{(eval @var{form})} where @var{form}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2652 should evaluate to an integer, specifying the field length.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2653
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2654 A field specification generally has the form @code{([@var{name}]
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2655 @var{handler})}. The square braces indicate that @var{name} is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2656 optional. (Don't use names that are symbols meaningful as type
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2657 specifications (above) or handler specifications (below), since that
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2658 would be ambiguous.) @var{name} can be a symbol or the expression
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2659 @code{(eval @var{form})}, in which case @var{form} should evaluate to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2660 a symbol.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2661
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2662 @var{handler} describes how to unpack or pack the field and can be one
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2663 of the following:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2664
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2665 @table @code
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2666 @item @var{type}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2667 Unpack/pack this field according to the type specification @var{type}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2668
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2669 @item eval @var{form}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2670 Evaluate @var{form}, a Lisp expression, for side-effect only. If the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2671 field name is specified, the value is bound to that field name.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2672
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2673 @item fill @var{len}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2674 Skip @var{len} bytes. In packing, this leaves them unchanged,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2675 which normally means they remain zero. In unpacking, this means
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2676 they are ignored.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2677
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2678 @item align @var{len}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2679 Skip to the next multiple of @var{len} bytes.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2680
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2681 @item struct @var{spec-name}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2682 Process @var{spec-name} as a sub-specification. This describes a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2683 structure nested within another structure.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2684
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2685 @item union @var{form} (@var{tag} @var{spec})@dots{}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2686 @c ??? I don't see how one would actually use this.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2687 @c ??? what kind of expression would be useful for @var{form}?
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2688 Evaluate @var{form}, a Lisp expression, find the first @var{tag}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2689 that matches it, and process its associated data layout specification
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2690 @var{spec}. Matching can occur in one of three ways:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2691
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2692 @itemize
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2693 @item
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2694 If a @var{tag} has the form @code{(eval @var{expr})}, evaluate
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2695 @var{expr} with the variable @code{tag} dynamically bound to the value
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2696 of @var{form}. A non-@code{nil} result indicates a match.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2697
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2698 @item
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2699 @var{tag} matches if it is @code{equal} to the value of @var{form}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2700
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2701 @item
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2702 @var{tag} matches unconditionally if it is @code{t}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2703 @end itemize
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2704
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2705 @item repeat @var{count} @var{field-specs}@dots{}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2706 Process the @var{field-specs} recursively, in order, then repeat
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2707 starting from the first one, processing all the specs @var{count}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2708 times overall. The @var{count} is given using the same formats as a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2709 field length---if an @code{eval} form is used, it is evaluated just once.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2710 For correct operation, each spec in @var{field-specs} must include a name.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2711 @end table
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2712
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2713 For the @code{(eval @var{form})} forms used in a bindat specification,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2714 the @var{form} can access and update these dynamically bound variables
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2715 during evaluation:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2716
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2717 @table @code
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2718 @item last
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2719 Value of the last field processed.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2720
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2721 @item bindat-raw
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2722 The data as a byte array.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2723
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2724 @item bindat-idx
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2725 Current index (within @code{bindat-raw}) for unpacking or packing.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2726
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2727 @item struct
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2728 The alist containing the structured data that have been unpacked so
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2729 far, or the entire structure being packed. You can use
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2730 @code{bindat-get-field} to access specific fields of this structure.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2731
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2732 @item count
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2733 @itemx index
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2734 Inside a @code{repeat} block, these contain the maximum number of
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2735 repetitions (as specified by the @var{count} parameter), and the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2736 current repetition number (counting from 0). Setting @code{count} to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2737 zero will terminate the inner-most repeat block after the current
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2738 repetition has completed.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2739 @end table
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2740
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2741 @node Bindat Functions
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2742 @subsection Functions to Unpack and Pack Bytes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2743
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2744 In the following documentation, @var{spec} refers to a data layout
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2745 specification, @code{bindat-raw} to a byte array, and @var{struct} to an
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2746 alist representing unpacked field data.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2747
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2748 @defun bindat-unpack spec bindat-raw &optional bindat-idx
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2749 This function unpacks data from the unibyte string or byte
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2750 array @code{bindat-raw}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2751 according to @var{spec}. Normally this starts unpacking at the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2752 beginning of the byte array, but if @var{bindat-idx} is non-@code{nil}, it
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2753 specifies a zero-based starting position to use instead.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2754
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2755 The value is an alist or nested alist in which each element describes
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2756 one unpacked field.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2757 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2758
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2759 @defun bindat-get-field struct &rest name
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2760 This function selects a field's data from the nested alist
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2761 @var{struct}. Usually @var{struct} was returned by
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2762 @code{bindat-unpack}. If @var{name} corresponds to just one argument,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2763 that means to extract a top-level field value. Multiple @var{name}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2764 arguments specify repeated lookup of sub-structures. An integer name
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2765 acts as an array index.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2766
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2767 For example, if @var{name} is @code{(a b 2 c)}, that means to find
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2768 field @code{c} in the third element of subfield @code{b} of field
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2769 @code{a}. (This corresponds to @code{struct.a.b[2].c} in C.)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2770 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2771
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2772 Although packing and unpacking operations change the organization of
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2773 data (in memory), they preserve the data's @dfn{total length}, which is
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2774 the sum of all the fields' lengths, in bytes. This value is not
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2775 generally inherent in either the specification or alist alone; instead,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2776 both pieces of information contribute to its calculation. Likewise, the
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2777 length of a string or array being unpacked may be longer than the data's
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2778 total length as described by the specification.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2779
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2780 @defun bindat-length spec struct
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2781 This function returns the total length of the data in @var{struct},
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2782 according to @var{spec}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2783 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2784
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2785 @defun bindat-pack spec struct &optional bindat-raw bindat-idx
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2786 This function returns a byte array packed according to @var{spec} from
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2787 the data in the alist @var{struct}. Normally it creates and fills a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2788 new byte array starting at the beginning. However, if @var{bindat-raw}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2789 is non-@code{nil}, it specifies a pre-allocated unibyte string or vector to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2790 pack into. If @var{bindat-idx} is non-@code{nil}, it specifies the starting
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2791 offset for packing into @code{bindat-raw}.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2792
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2793 When pre-allocating, you should make sure @code{(length @var{bindat-raw})}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2794 meets or exceeds the total length to avoid an out-of-range error.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2795 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2796
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2797 @defun bindat-ip-to-string ip
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2798 Convert the Internet address vector @var{ip} to a string in the usual
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2799 dotted notation.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2800
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2801 @example
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2802 (bindat-ip-to-string [127 0 0 1])
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2803 @result{} "127.0.0.1"
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2804 @end example
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2805 @end defun
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2806
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2807 @node Bindat Examples
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2808 @subsection Examples of Byte Unpacking and Packing
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2809
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2810 Here is a complete example of byte unpacking and packing:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2811
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2812 @lisp
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2813 (defvar fcookie-index-spec
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2814 '((:version u32)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2815 (:count u32)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2816 (:longest u32)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2817 (:shortest u32)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2818 (:flags u32)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2819 (:delim u8)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2820 (:ignored fill 3)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2821 (:offset repeat (:count)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2822 (:foo u32)))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2823 "Description of a fortune cookie index file's contents.")
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2824
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2825 (defun fcookie (cookies &optional index)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2826 "Display a random fortune cookie from file COOKIES.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2827 Optional second arg INDEX specifies the associated index
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2828 filename, which is by default constructed by appending
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2829 \".dat\" to COOKIES. Display cookie text in possibly
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2830 new buffer \"*Fortune Cookie: BASENAME*\" where BASENAME
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2831 is COOKIES without the directory part."
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2832 (interactive "fCookies file: ")
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2833 (let* ((info (with-temp-buffer
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2834 (insert-file-contents-literally
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2835 (or index (concat cookies ".dat")))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2836 (bindat-unpack fcookie-index-spec
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2837 (buffer-string))))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2838 (sel (random (bindat-get-field info :count)))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2839 (beg (cdar (bindat-get-field info :offset sel)))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2840 (end (or (cdar (bindat-get-field info
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2841 :offset (1+ sel)))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2842 (nth 7 (file-attributes cookies)))))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2843 (switch-to-buffer
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2844 (get-buffer-create
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2845 (format "*Fortune Cookie: %s*"
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2846 (file-name-nondirectory cookies))))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2847 (erase-buffer)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2848 (insert-file-contents-literally
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2849 cookies nil beg (- end 3))))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2850
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2851 (defun fcookie-create-index (cookies &optional index delim)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2852 "Scan file COOKIES, and write out its index file.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2853 Optional second arg INDEX specifies the index filename,
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2854 which is by default constructed by appending \".dat\" to
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2855 COOKIES. Optional third arg DELIM specifies the unibyte
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2856 character which, when found on a line of its own in
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2857 COOKIES, indicates the border between entries."
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2858 (interactive "fCookies file: ")
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2859 (setq delim (or delim ?%))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2860 (let ((delim-line (format "\n%c\n" delim))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2861 (count 0)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2862 (max 0)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2863 min p q len offsets)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2864 (unless (= 3 (string-bytes delim-line))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2865 (error "Delimiter cannot be represented in one byte"))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2866 (with-temp-buffer
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2867 (insert-file-contents-literally cookies)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2868 (while (and (setq p (point))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2869 (search-forward delim-line (point-max) t)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2870 (setq len (- (point) 3 p)))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2871 (setq count (1+ count)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2872 max (max max len)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2873 min (min (or min max) len)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2874 offsets (cons (1- p) offsets))))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2875 (with-temp-buffer
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2876 (set-buffer-multibyte nil)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2877 (insert
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2878 (bindat-pack
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2879 fcookie-index-spec
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2880 `((:version . 2)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2881 (:count . ,count)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2882 (:longest . ,max)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2883 (:shortest . ,min)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2884 (:flags . 0)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2885 (:delim . ,delim)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2886 (:offset . ,(mapcar (lambda (o)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2887 (list (cons :foo o)))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2888 (nreverse offsets))))))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2889 (let ((coding-system-for-write 'raw-text-unix))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2890 (write-file (or index (concat cookies ".dat")))))))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2891 @end lisp
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2892
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2893 Following is an example of defining and unpacking a complex structure.
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2894 Consider the following C structures:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2895
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2896 @example
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2897 struct header @{
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2898 unsigned long dest_ip;
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2899 unsigned long src_ip;
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2900 unsigned short dest_port;
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2901 unsigned short src_port;
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2902 @};
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2903
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2904 struct data @{
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2905 unsigned char type;
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2906 unsigned char opcode;
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2907 unsigned short length; /* In network byte order */
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2908 unsigned char id[8]; /* null-terminated string */
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2909 unsigned char data[/* (length + 3) & ~3 */];
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2910 @};
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2911
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2912 struct packet @{
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2913 struct header header;
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2914 unsigned long counters[2]; /* In little endian order */
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2915 unsigned char items;
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2916 unsigned char filler[3];
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2917 struct data item[/* items */];
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2918
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2919 @};
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2920 @end example
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2921
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2922 The corresponding data layout specification:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2923
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2924 @lisp
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2925 (setq header-spec
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2926 '((dest-ip ip)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2927 (src-ip ip)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2928 (dest-port u16)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2929 (src-port u16)))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2930
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2931 (setq data-spec
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2932 '((type u8)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2933 (opcode u8)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2934 (length u16) ;; network byte order
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2935 (id strz 8)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2936 (data vec (length))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2937 (align 4)))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2938
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2939 (setq packet-spec
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2940 '((header struct header-spec)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2941 (counters vec 2 u32r) ;; little endian order
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2942 (items u8)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2943 (fill 3)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2944 (item repeat (items)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2945 (struct data-spec))))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2946 @end lisp
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2947
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2948 A binary data representation:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2949
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2950 @lisp
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2951 (setq binary-data
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2952 [ 192 168 1 100 192 168 1 101 01 28 21 32
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2953 160 134 1 0 5 1 0 0 2 0 0 0
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2954 2 3 0 5 ?A ?B ?C ?D ?E ?F 0 0 1 2 3 4 5 0 0 0
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2955 1 4 0 7 ?B ?C ?D ?E ?F ?G 0 0 6 7 8 9 10 11 12 0 ])
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2956 @end lisp
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2957
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2958 The corresponding decoded structure:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2959
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2960 @lisp
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2961 (setq decoded (bindat-unpack packet-spec binary-data))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2962 @result{}
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2963 ((header
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2964 (dest-ip . [192 168 1 100])
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2965 (src-ip . [192 168 1 101])
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2966 (dest-port . 284)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2967 (src-port . 5408))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2968 (counters . [100000 261])
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2969 (items . 2)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2970 (item ((data . [1 2 3 4 5])
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2971 (id . "ABCDEF")
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2972 (length . 5)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2973 (opcode . 3)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2974 (type . 2))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2975 ((data . [6 7 8 9 10 11 12])
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2976 (id . "BCDEFG")
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2977 (length . 7)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2978 (opcode . 4)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2979 (type . 1))))
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2980 @end lisp
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2981
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2982 Fetching data from this structure:
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2983
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2984 @lisp
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2985 (bindat-get-field decoded 'item 1 'id)
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2986 @result{} "BCDEFG"
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2987 @end lisp
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2988
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2989 @ignore
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2990 arch-tag: ba9da253-e65f-4e7f-b727-08fba0a1df7a
888f14c01e6d Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2991 @end ignore