This is the inferior-shell Reference Manual, version 2.0.5, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 05:57:31 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
inferior-shellspawn local or remote processes and shell pipes
Francois-Rene Rideau
MIT
2.0.5
asdf (system)., at least version "3.0.3"
sb-posix (system)., required, for feature :sbcl
alexandria (system).
trivia (system).
trivia.quasiquote (system).
fare-utils (system).
fare-quasiquote-extras (system).
fare-mop (system).
pkgdcl.lisp (file).
process-spec.lisp (file).
utilities.lisp (file).
macros.lisp (file).
host.lisp (file).
run.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
inferior-shell/inferior-shell.asdinferior-shell/pkgdcl.lispinferior-shell/process-spec.lispinferior-shell/utilities.lispinferior-shell/macros.lispinferior-shell/host.lispinferior-shell/run.lispinferior-shell/inferior-shell.asdinferior-shell (system).
inferior-shell/process-spec.lisppkgdcl.lisp (file).
inferior-shell (system).
and-spec (class).
close-redirection (class).
command-arguments (reader method).
command-redirections (reader method).
command-spec (class).
fd-redirection (class).
file-redirection (class).
fork-spec (class).
or-spec (class).
parse-process-spec (function).
pipe-spec (class).
print-process-spec (generic function).
process-spec (class).
progn-spec (class).
redirection (class).
simple-command-line-token (type).
token-string (function).
add-argument (generic function).
add-redirection (generic function).
check-small-fd (function).
clps-arguments-r (reader method).
(setf clps-arguments-r) (writer method).
clps-current-argument (reader method).
(setf clps-current-argument) (writer method).
clps-redirections-r (reader method).
(setf clps-redirections-r) (writer method).
command-parse (class).
command-parse-results (generic function).
ensure-argument (generic function).
extend-argument (generic function).
flush-argument (generic function).
make-close-redirection (function).
make-fd-redirection (function).
make-file-redirection (function).
new-argument (generic function).
parse-command-spec-token (function).
parse-command-spec-tokens (function).
parse-command-spec-top-token (function).
print-process-sequence-joined (function).
redirection-fd (reader method).
redirection-flags (reader method).
redirection-new-fd (reader method).
redirection-old-fd (reader method).
redirection-old-fd (reader method).
redirection-pathname (reader method).
redirection-symbol (reader method).
sequence-processes (reader method).
sequence-spec (class).
write-token-component (function).
inferior-shell/utilities.lisppkgdcl.lisp (file).
inferior-shell (system).
add-days (function).
do-stream-lines (function).
do-string-lines (function).
make-directory (function).
next-day (function).
previous-day (function).
read-line* (function).
select-from-hash (function).
setenv (function).
split-lines (function).
split-lines* (function).
inferior-shell/macros.lisppkgdcl.lisp (file).
inferior-shell (system).
with-directory (macro).
inferior-shell/host.lisppkgdcl.lisp (file).
inferior-shell (system).
*current-host-names* (special variable).
current-host-name-p (function).
initialize-current-host-names (function).
inferior-shell/run.lispprocess-spec.lisp (file).
macros.lisp (file).
inferior-shell (system).
direct-command-spec (type).
direct-command-spec-p (function).
on-host-spec (function).
run-process-spec (function).
run-spec (function).
Packages are listed by definition order.
inferior-shellalexandria.
common-lisp.
editor-hints.named-readtables.
fare-mop.
fare-utils.
trivia.level2.
uiop/driver.
and-spec (class).
close-redirection (class).
command-arguments (generic reader).
command-redirections (generic reader).
command-spec (class).
fd-redirection (class).
file-redirection (class).
fork-spec (class).
or-spec (class).
parse-process-spec (function).
pipe (macro).
pipe-spec (class).
print-process-spec (generic function).
process-spec (class).
progn-spec (class).
redirection (class).
run (function).
run/i (function).
run/interactive (function).
run/lines (function).
run/nil (function).
run/s (function).
run/ss (function).
simple-command-line-token (type).
token-string (function).
zglob (function).
zglobcmd (function).
*current-host-names* (special variable).
add-argument (generic function).
add-days (function).
add-redirection (generic function).
check-small-fd (function).
clps-arguments-r (generic reader).
(setf clps-arguments-r) (generic writer).
clps-current-argument (generic reader).
(setf clps-current-argument) (generic writer).
clps-redirections-r (generic reader).
(setf clps-redirections-r) (generic writer).
command-parse (class).
command-parse-results (generic function).
current-host-name-p (function).
direct-command-spec (type).
direct-command-spec-p (function).
do-stream-lines (function).
do-string-lines (function).
ensure-argument (generic function).
extend-argument (generic function).
flush-argument (generic function).
initialize-current-host-names (function).
make-close-redirection (function).
make-directory (function).
make-fd-redirection (function).
make-file-redirection (function).
new-argument (generic function).
next-day (function).
on-host-spec (function).
parse-command-spec-token (function).
parse-command-spec-tokens (function).
parse-command-spec-top-token (function).
previous-day (function).
print-process-sequence-joined (function).
read-line* (function).
redirection-fd (generic reader).
redirection-flags (generic reader).
redirection-new-fd (generic reader).
redirection-old-fd (generic reader).
redirection-pathname (generic reader).
redirection-symbol (generic reader).
run-process-spec (function).
run-spec (function).
select-from-hash (function).
sequence-processes (generic reader).
sequence-spec (class).
setenv (function).
split-lines (function).
split-lines* (function).
with-directory (macro).
write-token-component (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
run command CMD. Unless otherwise specified, copy the subprocess’s output to *standard-output* and its error-output to *error-output*. Return values for the output, error-output and exit-code.
The command specified by COMMAND can be a list as parsed by PARSE-PROCESS-SPEC, or a string
to execute with a shell (/bin/sh on Unix, CMD.EXE on Windows).
Signal a continuable SUBPROCESS-ERROR if the process wasn’t successful (exit-code 0),
unless ON-ERROR is specified, which if NIL means ignore the error (and return the three values).
If OUTPUT is a pathname, a string designating a pathname, or NIL designating the null device,
the file at that path is used as output.
If it’s :INTERACTIVE, output is inherited from the current process;
beware that this may be different from your *STANDARD-OUTPUT*,
and under SLIME will be on your *inferior-lisp* buffer.
If it’s T, output goes to your current *STANDARD-OUTPUT* stream.
Otherwise, OUTPUT should be a value that is a suitable first argument to
SLURP-INPUT-STREAM (qv.), or a list of such a value and keyword arguments.
In this case, RUN-PROGRAM will create a temporary stream for the program output;
the program output, in that stream, will be processed by a call to SLURP-INPUT-STREAM,
using OUTPUT as the first argument (or the first element of OUTPUT, and the rest as keywords).
The primary value resulting from that call (or NIL if no call was needed)
will be the first value returned by RUN-PROGRAM.
E.g., using :OUTPUT :STRING will have it return the entire output stream as a string.
And using :OUTPUT ’(:STRING :STRIPPED T) will have it return the same string
stripped of any ending newline.
ERROR-OUTPUT is similar to OUTPUT, except that the resulting value is returned
as the second value of RUN-PROGRAM. T designates the *ERROR-OUTPUT*.
Also :OUTPUT means redirecting the error output to the output stream,
in which case NIL is returned.
INPUT is similar to OUTPUT, except that VOMIT-OUTPUT-STREAM is used,
no value is returned, and T designates the *STANDARD-INPUT*.
Use ELEMENT-TYPE and EXTERNAL-FORMAT are passed on
to your Lisp implementation, when applicable, for creation of the output stream.
One and only one of the stream slurping or vomiting may or may not happen
in parallel with the subprocess, depending on options and implementation,
and with priority being given to output processing.
Other streams are completely produced or consumed
before or after the subprocess is spawned, using temporary files.
RUN returns 3 values:
0- the result of the OUTPUT slurping if any, or NIL
1- the result of the ERROR-OUTPUT slurping if any, or NIL
2- either 0 if the subprocess exited with success status,
or an indication of failure via the EXIT-CODE of the process
alias for run/interactive
run command CMD interactively, connecting the subprocess’s input, output and error-output
to the same file descriptors as the current process
See the documentation for INFERIOR-SHELL:RUN for other keyword arguments.
run command CMD, return its standard output results as a list of strings, one per line,
discarding line terminators. Unless otherwise specified, discard error-output.
See the documentation for INFERIOR-SHELL:RUN for other keyword arguments.
run command CMD. Unless otherwise specified, discard the subprocess’s output and error-output. See the documentation for INFERIOR-SHELL:RUN for other keyword arguments.
run command CMD, return its standard output results as a string.
Unless otherwise specified, discard its error-output.
See the documentation for INFERIOR-SHELL:RUN for other keyword arguments.
run command CMD, return its standard output results as a string like run/s,
but strips the line ending off the result string very much like ‘cmd‘ or $(cmd) at the shell
See the documentation for INFERIOR-SHELL:RUN for other keyword arguments.
command-spec)) ¶automatically generated reader method
command-spec)) ¶automatically generated reader method
Print a process specification in a way suitable for consumption by a shell
cons) &optional s) ¶string) &optional s) ¶progn-spec) &optional s) ¶command-spec) &optional s) ¶close-redirection) &optional s) ¶fd-redirection) &optional s) ¶file-redirection) &optional s) ¶integer
:old-fd
This slot is read-only.
integer
:fd
This slot is read-only.
common-lisp.
symbol
:symbol
This slot is read-only.
list
:flags
This slot is read-only.
common-lisp.
(or string pathname)
:pathname
This slot is read-only.
simple-print-object-mixin.
simple-print-object-mixin.
Similar to READ-LINE, this function also returns as additional values the state about
whether CR or LF were read. CR, LF and CR+LF are accepted only.
Partial state accepted as input, too, for parsing in chunks.
command-parse) (argument string)) ¶command-parse) redirection) ¶command-parse)) ¶automatically generated reader method
command-parse)) ¶automatically generated writer method
command-parse)) ¶automatically generated reader method
command-parse)) ¶automatically generated writer method
command-parse)) ¶automatically generated reader method
command-parse)) ¶automatically generated writer method
command-parse)) ¶command-parse)) ¶command-parse) x) ¶command-parse)) ¶command-parse)) ¶file-redirection)) ¶automatically generated reader method
fd.
file-redirection)) ¶automatically generated reader method
fd-redirection)) ¶automatically generated reader method
close-redirection)) ¶automatically generated reader method
fd-redirection)) ¶automatically generated reader method
file-redirection)) ¶automatically generated reader method
file-redirection)) ¶automatically generated reader method
sequence-spec)) ¶automatically generated reader method
list
:processes
This slot is read-only.
| Jump to: | (
A C D E F G I M N O P R S T W Z |
|---|
| Jump to: | (
A C D E F G I M N O P R S T W Z |
|---|
| Jump to: | *
A C F N O P R S |
|---|
| Jump to: | *
A C F N O P R S |
|---|
| Jump to: | A C D F H I M O P R S T U |
|---|
| Jump to: | A C D F H I M O P R S T U |
|---|