This is the external-program Reference Manual, version 0.0.6, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 05:28:53 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
external-programGreg Pfeil <greg@technomadic.org>
LLGPL
0.0.6
trivial-features (system).
external-program.lisp (file).
utilities.lisp (file).
sbcl.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
external-program/external-program.asdexternal-program/external-program.lispexternal-program/utilities.lispexternal-program/sbcl.lispexternal-program/external-program.asdexternal-program (system).
external-program/external-program.lispexternal-program (system).
process-error-stream (generic function).
process-id (generic function).
process-input-stream (generic function).
process-output-stream (generic function).
process-p (generic function).
process-status (generic function).
run (generic function).
signal-process (generic function).
start (generic function).
*signal-mapping* (special variable).
external-program/utilities.lispexternal-program.lisp (file).
external-program (system).
embed-environment (function).
make-shell-string (function).
reformat-environment (function).
rename-parameter (function).
stringify-args (function).
external-program/sbcl.lisputilities.lisp (file).
external-program (system).
process-error-stream (method).
process-id (method).
process-input-stream (method).
process-output-stream (method).
process-p (method).
process-status (method).
run (method).
signal-process (method).
signal-process (method).
start (method).
convert-environment (function).
Packages are listed by definition order.
external-programcommon-lisp.
process-error-stream (generic function).
process-id (generic function).
process-input-stream (generic function).
process-output-stream (generic function).
process-p (generic function).
process-status (generic function).
run (generic function).
signal-process (generic function).
start (generic function).
*signal-mapping* (special variable).
convert-environment (function).
embed-environment (function).
make-shell-string (function).
reformat-environment (function).
rename-parameter (function).
stringify-args (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Returns the stream created when the error argument to ‘START‘ is specified as ‘:STREAM‘.
Returns the process id assigned to the external
process by the operating system. This is typically a positive,
16-bit number.
Returns the stream created when the input argument to ‘START‘ is specified as ‘:STREAM‘.
Returns the stream created when the output argument to ‘START‘ is specified as ‘:STREAM‘.
‘T‘ if object is a process, ‘NIL‘ otherwise.
Returns, as multiple values, a keyword denoting the
status of the external process (one of ‘:RUNNING‘, ‘:STOPPED‘,
‘:SIGNALED‘, or ‘:EXITED‘), and the exit code or terminating signal
if the first value is other than ‘:RUNNING‘.
Runs the specified program similarly to ‘START‘,
however it blocks and returns the external process status once the
program exits.
‘:STREAM‘ is not a valid argument to ‘INPUT‘, ‘OUTPUT‘, or ‘ERROR‘ for this function.
Sends the specified unix signal to the specified
external process. Signals an error if unsuccessful. The signal may
be either an integer, or one of the keywords in
‘EXTERNAL-PROGRAM::*SIGNAL-MAPPING*‘.
Runs the specified program in an external (Unix) process,
returning a process object if successful.
‘INPUT‘, ‘OUTPUT‘, and ‘ERROR‘ all behave similarly, accepting one of
the following values:
* ‘NIL‘, specifying that a null stream (e.g., ‘/dev/null‘) should be
used;
* ‘T‘, specifying that the ‘EXTERNAL-PROCESS‘ should use the source or
destination with which the Lisp was invoked;
* a stream;
* a pathname designator, to redirect to/from a file;
* ‘:STREAM‘, which creates a new stream opened for character input or
output (accessible via the ‘EXTERNAL-PROCESS-*-STREAM‘ functions);
or
* ‘:OUTPUT‘, (only available for ‘ERROR‘) which directs the error
output to the same destination as the standard output.
‘ENVIRONMENT‘ contains an alist mapping vars to values.
‘REPLACE-ENVIRONMENT-P‘ indicates whether the argument passed as ‘ENVIRONMENT‘
should replace or extend the current environment. The default is ‘NIL‘ (to
extend the environment).
‘STATUS-HOOK‘ is a function the system calls whenever the status of
the process changes. The function takes the process as an argument.
SBCL accepts vars as either ("FOO=meh" ...) or ((:foo . "meh") ...), but not (("FOO" . "meh") ...), so we build up the first kind (since the second kind is potentially lossy).
| Jump to: | C E F G M P R S |
|---|
| Jump to: | C E F G M P R S |
|---|
| Jump to: | *
S |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| * | |||
*signal-mapping*: | Private special variables | ||
| | |||
| S | |||
Special Variable, *signal-mapping*: | Private special variables | ||
| | |||
| Jump to: | *
S |
|---|
| Jump to: | E F P S U |
|---|
| Jump to: | E F P S U |
|---|