This is the trivial-shell Reference Manual, version 0.2.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 15:20:59 2020 GMT+0.
• Systems | The systems documentation | |
• Modules | The modules documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
The main system appears first, followed by any subsystem dependency.
• The trivial-shell system |
Gary Warren King <gwking@metabang.com>
Gary Warren King <gwking@metabang.com>
MIT Style License
OS and Implementation independent access to the shell
0.2.0
trivial-shell.asd (file)
Modules are listed depth-first from the system components tree.
Next: The trivial-shell/timeout module, Previous: Modules, Up: Modules [Contents][Index]
trivial-shell (system)
dev/
notes.text (file)
Next: The trivial-shell/setup module, Previous: The trivial-shell/notes module, Up: Modules [Contents][Index]
trivial-shell (system)
timeout/
Next: The trivial-shell/dev module, Previous: The trivial-shell/timeout module, Up: Modules [Contents][Index]
timeout (module)
trivial-shell (system)
dev/
package.lisp (file)
Next: The trivial-shell/port module, Previous: The trivial-shell/setup module, Up: Modules [Contents][Index]
setup (module)
trivial-shell (system)
dev/
Next: The trivial-shell/website module, Previous: The trivial-shell/dev module, Up: Modules [Contents][Index]
dev (module)
trivial-shell (system)
dev/
sbcl.lisp (file)
Next: The trivial-shell/website/source module, Previous: The trivial-shell/port module, Up: Modules [Contents][Index]
trivial-shell (system)
website/
source (module)
Previous: The trivial-shell/website module, Up: Modules [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files | ||
• Static files |
Next: Static files, Previous: Files, Up: Files [Contents][Index]
Next: The trivial-shell/timeout/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
trivial-shell.asd
trivial-shell (system)
Next: The trivial-shell/timeout/with-timeout․lisp file, Previous: The trivial-shell․asd file, Up: Lisp files [Contents][Index]
timeout (module)
timeout/package.lisp
Next: The trivial-shell/setup/package․lisp file, Previous: The trivial-shell/timeout/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
timeout (module)
timeout/with-timeout.lisp
Next: The trivial-shell/dev/definitions․lisp file, Previous: The trivial-shell/timeout/with-timeout․lisp file, Up: Lisp files [Contents][Index]
setup (module)
dev/package.lisp
Next: The trivial-shell/dev/macros․lisp file, Previous: The trivial-shell/setup/package․lisp file, Up: Lisp files [Contents][Index]
dev (module)
dev/definitions.lisp
Next: The trivial-shell/dev/utilities․lisp file, Previous: The trivial-shell/dev/definitions․lisp file, Up: Lisp files [Contents][Index]
dev (module)
dev/macros.lisp
Next: The trivial-shell/dev/shell․lisp file, Previous: The trivial-shell/dev/macros․lisp file, Up: Lisp files [Contents][Index]
dev (module)
dev/utilities.lisp
Next: The trivial-shell/port/sbcl․lisp file, Previous: The trivial-shell/dev/utilities․lisp file, Up: Lisp files [Contents][Index]
dev (module)
dev/shell.lisp
Previous: The trivial-shell/dev/shell․lisp file, Up: Lisp files [Contents][Index]
port (module)
dev/sbcl.lisp
Previous: Lisp files, Up: Files [Contents][Index]
• The trivial-shell/notes/notes.text file | ||
• The trivial-shell/website/source/index.md file |
Next: The trivial-shell/website/source/index․md file, Previous: Static files, Up: Static files [Contents][Index]
notes (module)
dev/notes.text
Previous: The trivial-shell/notes/notes․text file, Up: Static files [Contents][Index]
source (module)
/home/quickref/quicklisp/dists/quicklisp/software/trivial-shell-20180228-git/website/source/index.md (not found)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The com.metabang.trivial-timeout package | ||
• The trivial-shell package |
Next: The trivial-shell package, Previous: Packages, Up: Packages [Contents][Index]
package.lisp (file)
trivial-timeout
common-lisp
Previous: The com․metabang․trivial-timeout package, Up: Packages [Contents][Index]
package.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported special variables | ||
• Exported macros | ||
• Exported functions | ||
• Exported generic functions | ||
• Exported conditions |
Next: Exported macros, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
The path to a Bourne compatible command shell in physical pathname notation.
definitions.lisp (file)
definitions.lisp (file)
Next: Exported functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
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.
with-timeout.lisp (file)
Next: Exported generic functions, Previous: Exported macros, Up: Exported definitions [Contents][Index]
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.
shell.lisp (file)
Return the value of the environment variable ‘name‘.
shell.lisp (file)
Next: Exported conditions, Previous: Exported functions, Up: Exported definitions [Contents][Index]
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‘.
shell.lisp (file)
shell.lisp (file)
Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
An error signaled when the duration specified in the [with-timeout][] is exceeded.
with-timeout.lisp (file)
error (condition)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal special variables | ||
• Internal macros | ||
• Internal functions | ||
• Internal generic functions |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
utilities.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
macros.lisp (file)
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.
macros.lisp (file)
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.
macros.lisp (file)
macros.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
sbcl.lisp (file)
sbcl.lisp (file)
sbcl.lisp (file)
sbcl.lisp (file)
sbcl.lisp (file)
with-timeout.lisp (file)
sbcl.lisp (file)
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.
utilities.lisp (file)
shell.lisp (file)
with-timeout.lisp (file)
utilities.lisp (file)
sbcl.lisp (file)
Return the process-id of the currently executing OS process.
shell.lisp (file)
sbcl.lisp (file)
sbcl.lisp (file)
sbcl.lisp (file)
sbcl.lisp (file)
Previous: Internal functions, Up: Internal definitions [Contents][Index]
Close a stream and handle other bookkeeping as appropriate.
macros.lisp (file)
shell.lisp (file)
Create and return a stream from specifier, direction and any other argsuments
macros.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | F L M S T |
---|
Jump to: | F L M S T |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
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 |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
S |
---|
Jump to: | *
S |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | C P S T |
---|
Jump to: | C P S T |
---|