This is the clesh Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:57:56 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cleshClesh is a very short program that provides
mechanisms for running and composing Unix shell commands and
constructs from Common Lisp.
Essentially, it provides a ’!’ syntax that you can use to run commands
and a ’[]’ embedded mode where you can enter bash scripts and obtain
the standard output as a lisp string, and some other features.
Lisp expressions can be included in any command or script using a ’?’
syntax.
Clesh works on every implementation of Common Lisp that is supported by trivial-shell.
Christian von Essen <christian@mvonessen.de>
FreeBSD (see LICENSE)
trivial-shell (system).
named-readtables (system).
clesh.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
clesh/clesh.lispclesh (system).
*shell* (special variable).
lines-to-list (function).
script (function).
embedded-shell-escape-reader (function).
enter-shell-mode (function).
mixed-script (function).
mixed-template (function).
read-escapes (function).
read-interpolated-string (function).
simple-shell-escape-reader (function).
storable-template-escape-reader (function).
template-escape-reader (function).
Packages are listed by definition order.
cleshclsh
common-lisp.
editor-hints.named-readtables.
trivial-shell.
*shell* (special variable).
lines-to-list (function).
script (function).
embedded-shell-escape-reader (function).
enter-shell-mode (function).
mixed-script (function).
mixed-template (function).
read-escapes (function).
read-interpolated-string (function).
simple-shell-escape-reader (function).
storable-template-escape-reader (function).
template-escape-reader (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Program to use to execute shell commands.
Transform the string TEXT into a list of strings, each representing
on line of TEXT. This is suitable to postprocessing the standard output
of many Unix commands (such as find or df) that return one result
per line.
Execute the STR string as a standard input of the program.
Returns three values.
1. Standard output of the program
2. Standard error of the program
3. Exit code of the program
Read and execute successive shell commands, with any
lisp expressions embedded. Expressions are evaluated at
read time, as soon as a line is delivered. Implements the !! reader macro.
Concatenate arguments like MIXED-TEMPLATE, execute result like SCRIPT.
Returns three values.
1. Standard output of the program
2. Standard error of the program
3. Exit code of the program
Concatenate list of arguments into a string.
Turns any argument that is not a string already into string using format’s ~A.
Read escapes, push the appropriate number of escapes onto the buffer. If the last character is special and not escaped, then this character is returned. Otherwise we return nil.
Read from a stream until a delimiter is found and interpolate.
The delimiter is
- the character END-CHAR1 if END-CHAR2 is nil
- the sequence END-CHAR2 END-CHAR1 if END-CHAR2 is not nil.
Interpolation starts with ?, and the next form (i.e., lisp form)
is interpolated. If EVAL-AT-READ is not NIL, then the form will
be evaluated and converted into a string immediately.
Otherwise the form will be returned as is.
Returns a list. In this list, normal strings and interpolations alternate.
For example the string "asd foo ?(+ 2 2) bar ?(+ 3 3)"
will be read as ("asd foo " (+ 2 2) " bar " (+ 3 3)).
| Jump to: | E F L M R S T |
|---|
| Jump to: | E F L M R S T |
|---|
| Jump to: | *
S |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| * | |||
*shell*: | Public special variables | ||
| | |||
| S | |||
Special Variable, *shell*: | Public special variables | ||
| | |||
| Jump to: | *
S |
|---|
| Jump to: | C F P S |
|---|
| Jump to: | C F P S |
|---|