This is the trivial-shell Reference Manual, version 0.2.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 18:08:51 2024 GMT+0.
trivial-shell/trivial-shell.asdtrivial-shell/timeout/package.lisptrivial-shell/timeout/with-timeout.lisptrivial-shell/setup/package.lisptrivial-shell/dev/definitions.lisptrivial-shell/dev/macros.lisptrivial-shell/dev/utilities.lisptrivial-shell/dev/shell.lisptrivial-shell/port/sbcl.lispThe main system appears first, followed by any subsystem dependency.
trivial-shellOS and Implementation independent access to the shell
Gary Warren King <gwking@metabang.com>
Gary Warren King <gwking@metabang.com>
MIT Style License
0.2.0
Modules are listed depth-first from the system components tree.
trivial-shell/notestrivial-shell/timeouttrivial-shell/setuptrivial-shell/devtrivial-shell/porttrivial-shell/websitetrivial-shell/website/sourcetrivial-shell/notestrivial-shell (system).
notes.text (file).
trivial-shell/timeouttrivial-shell (system).
package.lisp (file).
with-timeout.lisp (file).
trivial-shell/setuptimeout (module).
trivial-shell (system).
package.lisp (file).
trivial-shell/devsetup (module).
trivial-shell (system).
definitions.lisp (file).
macros.lisp (file).
utilities.lisp (file).
shell.lisp (file).
trivial-shell/portdev (module).
trivial-shell (system).
sbcl.lisp (file).
trivial-shell/websitetrivial-shell (system).
source (module).
Files are sorted by type and then listed depth-first from the systems components trees.
trivial-shell/trivial-shell.asdtrivial-shell/timeout/package.lisptrivial-shell/timeout/with-timeout.lisptrivial-shell/setup/package.lisptrivial-shell/dev/definitions.lisptrivial-shell/dev/macros.lisptrivial-shell/dev/utilities.lisptrivial-shell/dev/shell.lisptrivial-shell/port/sbcl.lisptrivial-shell/timeout/with-timeout.lisppackage.lisp (file).
timeout (module).
timeout-error (condition).
with-timeout (macro).
build-with-timeout (function).
generate-platform-specific-code (function).
trivial-shell/dev/definitions.lispdev (module).
*bourne-compatible-shell* (special variable).
*shell-search-paths* (special variable).
trivial-shell/dev/macros.lispdev (module).
close-stream-specifier (generic function).
make-stream-from-specifier (generic function).
with-gensyms (macro).
with-input (macro).
with-output (macro).
with-stream-from-specifier (macro).
trivial-shell/dev/utilities.lispdev (module).
*os-alist* (special variable).
directory-pathname-p (function).
host-os (function).
trivial-shell/dev/shell.lispdefinitions.lisp (file).
macros.lisp (file).
dev (module).
exit (function).
get-env-var (function).
shell-command (method).
shell-command (method).
file-to-string-as-lines (generic function).
find-command-ending-in-string (function).
os-process-id (function).
trivial-shell/port/sbcl.lispport (module).
%exit (function).
%get-env-var (function).
%os-process-id (function).
%shell-command (function).
%shell-command-using-temporary-file (function).
create-shell-process (function).
open-temporary-file (function).
process-alive-p (function).
process-exit-code (function).
read-temporary-file (function).
symbol-if-external (function).
Packages are listed by definition order.
trivial-shellcom.metabang.trivial-shell
metashell
com.metabang.trivial-timeout.
common-lisp.
*bourne-compatible-shell* (special variable).
*shell-search-paths* (special variable).
exit (function).
get-env-var (function).
shell-command (generic function).
%exit (function).
%get-env-var (function).
%os-process-id (function).
%shell-command (function).
%shell-command-using-temporary-file (function).
*os-alist* (special variable).
close-stream-specifier (generic function).
create-shell-process (function).
directory-pathname-p (function).
file-to-string-as-lines (generic function).
find-command-ending-in-string (function).
host-os (function).
make-stream-from-specifier (generic function).
open-temporary-file (function).
os-process-id (function).
process-alive-p (function).
process-exit-code (function).
read-temporary-file (function).
symbol-if-external (function).
with-gensyms (macro).
with-input (macro).
with-output (macro).
with-stream-from-specifier (macro).
com.metabang.trivial-timeouttrivial-timeout
common-lisp.
timeout-error (condition).
with-timeout (macro).
build-with-timeout (function).
generate-platform-specific-code (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
The path to a Bourne compatible command shell in physical pathname notation.
Execute ‘body‘ for no more than ‘seconds‘ time.
If ‘seconds‘ is exceeded, then a [timeout-error][] will be signaled.
If ‘seconds‘ is nil, then the body will be run normally until it completes or is interrupted.
Exit the process. CODE is either a numeric exit code, or the special values :SUCCESS or :FAILURE, which maps to the appropriate exit codes for the operating system.
Return the value of the environment variable ‘name‘.
Synchronously execute ‘command‘ using a Bourne-compatible shell,
returns (values output error-output exit-status).
The ‘command‘ can be a full path to a shell executable binary
or just its name. In the later case, the variable ‘*shell-search-paths*‘
will be used to find the executable.
Depending on the implementation, the variable ‘*bourne-compatible-shell*‘ may be used to find a shell to use in executing ‘command‘.
pathname) &key input) ¶An error signaled when the duration specified in the [with-timeout][] is exceeded.
error.
Create an input stream from source and bind it to var within the body of the with-input form. The stream will be closed if necessary on exit.
Create an output stream from source and bind it to var within the body of the with-output form. The stream will be closed if necessary on exit.
Does ‘pathname‘ syntactically represent a directory?
A directory-pathname is a pathname _without_ a filename. The three ways that the filename components can be missing are for it to be ‘nil‘, ‘:unspecific‘ or the empty string.
Return the process-id of the currently executing OS process.
Close a stream and handle other bookkeeping as appropriate.
Create and return a stream from specifier, direction and any other argsuments
string) (direction (eql :output)) &rest args) ¶string) (direction symbol) &rest args) ¶pathname) (direction symbol) &rest args) ¶(eql :none)) (direction symbol) &rest args) ¶(eql nil)) (direction symbol) &rest args) ¶(eql t)) (direction symbol) &rest args) ¶stream) (direction symbol) &rest args) ¶| Jump to: | %
B C D E F G H M O P R S W |
|---|
| Jump to: | %
B C D E F G H M O P R S W |
|---|
| Jump to: | *
S |
|---|
| Jump to: | *
S |
|---|
| Jump to: | C D F I M N P S T U W |
|---|
| Jump to: | C D F I M N P S T U W |
|---|