This is the lisp-executable Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 06:38:14 2024 GMT+0.
lisp-executable/lisp-executable.asd
lisp-executable/src/packages.lisp
lisp-executable/src/program-definition.lisp
lisp-executable/src/conversion-functions.lisp
lisp-executable/src/invocation.lisp
lisp-executable/src/argument-value-manager.lisp
lisp-executable/src/gnu-style-command-line-arguments.lisp
lisp-executable/src/program-options.lisp
lisp-executable/src/creation.lisp
lisp-executable/src/creation-sbcl.lisp
lisp-executable/src/asdf-support.lisp
The main system appears first, followed by any subsystem dependency.
lisp-executable
Library for defining and creating executables that can be called from the Unix shell.
Mark Cox
Simplified BSD License variant
alexandria
(system).
src
(module).
Modules are listed depth-first from the system components tree.
lisp-executable/src
lisp-executable
(system).
packages.lisp
(file).
program-definition.lisp
(file).
conversion-functions.lisp
(file).
invocation.lisp
(file).
argument-value-manager.lisp
(file).
gnu-style-command-line-arguments.lisp
(file).
program-options.lisp
(file).
creation.lisp
(file).
creation-sbcl.lisp
(file).
asdf-support.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
lisp-executable/lisp-executable.asd
lisp-executable/src/packages.lisp
lisp-executable/src/program-definition.lisp
lisp-executable/src/conversion-functions.lisp
lisp-executable/src/invocation.lisp
lisp-executable/src/argument-value-manager.lisp
lisp-executable/src/gnu-style-command-line-arguments.lisp
lisp-executable/src/program-options.lisp
lisp-executable/src/creation.lisp
lisp-executable/src/creation-sbcl.lisp
lisp-executable/src/asdf-support.lisp
lisp-executable/lisp-executable.asd
lisp-executable
(system).
lisp-executable/src/program-definition.lisp
packages.lisp
(file).
src
(module).
append-policy
(function).
argument-name
(generic reader).
argument-parameter-name
(reader method).
argumentp
(function).
arguments
(generic reader).
command-line-program-information
(function).
(setf command-line-program-information)
(function).
conversion-function
(generic function).
conversion-function-form
(reader method).
count-policy
(function).
create-reducing-function
(function).
define-dispatcher-program
(macro).
define-program
(macro).
dispatcher-information
(class).
error-policy
(function).
identifiers
(generic reader).
no-parameter-option-argument-p
(function).
non-option-argument-p
(function).
optional-parameter-option-argument-p
(function).
others-argument-p
(function).
parameter-default-value
(reader method).
print-object
(method).
program-information
(class).
reducing-function-form
(generic reader).
required-parameter-option-argument-p
(function).
toggle-policy
(function).
use-first-policy
(function).
use-last-policy
(function).
argument
(class).
argument-declaration-p
(function).
argument-declarations/find-conversion-function-form
(function).
argument-declarations/find-identifiers
(function).
argument-declarations/find-reducing-function-form
(function).
argument-form
(generic function).
argument-let-bindings-from-alist
(generic function).
argument-parameter-type
(reader method).
argument-type
(reader method).
assemble-declarations
(function).
conversion-function-form-argument-names
(function).
conversion-function-form-for-argument-name-p
(function).
conversion-function-form-function-name
(function).
conversion-function-form-p
(function).
create-arguments-from-definitions
(function).
create-arguments-from-definitions/no-parameter-option
(function).
create-arguments-from-definitions/non-option-argument
(function).
create-arguments-from-definitions/optional-parameter-option
(function).
create-arguments-from-definitions/others-argument
(function).
create-arguments-from-definitions/required-parameter-option
(function).
create-dispatcher-information-from-definitions
(function).
create-program-information-from-definitions
(function).
deconstruct-program-body
(macro).
do-deconstruct-program-body
(function).
ensure-dispatcher-program
(function).
ensure-program
(function).
extract-from-body/body
(function).
extract-from-body/declarations
(function).
extract-from-body/documentation-string
(function).
identifiers-form-argument-name
(function).
identifiers-form-for-argument-name-p
(function).
identifiers-form-identifiers
(function).
identifiers-form-p
(function).
information-name
(reader method).
information-name
(reader method).
reducing-function-form-argument-names
(function).
reducing-function-form-for-argument-name-p
(function).
reducing-function-form-function-name
(function).
reducing-function-form-p
(function).
separate-argument-declarations
(function).
separate-body-components
(function).
string-or-character-p
(function).
value-from-alist
(function).
lisp-executable/src/conversion-functions.lisp
program-definition.lisp
(file).
src
(module).
conversion-function
(reader method).
*built-in-conversion-functions*
(special variable).
built-in-conversion-function
(class).
converter
(reader method).
(setf converter)
(writer method).
find-built-in-conversion-function
(function).
find-built-in-conversion-function/by-name
(function).
find-built-in-conversion-function/by-type
(function).
matcher
(reader method).
(setf matcher)
(writer method).
name
(reader method).
register-built-in-conversion-function
(function).
string-to-type-using-read
(function).
lisp-executable/src/invocation.lisp
conversion-functions.lisp
(file).
src
(module).
*command-line-arguments-reader*
(special variable).
process-command-line-arguments
(generic function).
program-apply
(function).
program-funcall
(function).
program-funcall-with-alist
(function).
program-funcall-with-plist
(function).
lisp-executable/src/argument-value-manager.lisp
invocation.lisp
(file).
src
(module).
argument-value
(function).
arguments
(reader method).
convert-argument-values-to-alist
(generic function).
fetch-argument-by-identifier
(function).
find-argument
(function).
find-argument-by-name
(function).
find-argument-if
(function).
initialize-instance
(method).
make-manager
(function).
update-argument
(function).
argument-reducing-function-table
(reader method).
argument-value-table
(reader method).
find-argument-by-identifier
(function).
force-argument-value
(function).
identifier=
(function).
manager
(class).
perform-type-conversion
(function).
reducing-function
(function).
(setf reducing-function)
(function).
update-argument/argument
(function).
update-argument/no-parameter-option
(function).
update-argument/optional-parameter-option
(function).
update-argument/others
(function).
update-argument/required-parameter-option
(function).
lisp-executable/src/gnu-style-command-line-arguments.lisp
argument-value-manager.lisp
(file).
src
(module).
dispatcher-command-line-arguments-processor
(function).
long-option-p
(function).
option-identifier-from-string
(function).
option-p
(function).
options-processing-terminator-p
(function).
process-command-line-arguments
(method).
process-command-line-arguments
(method).
program-command-line-arguments-processor
(function).
short-option-p
(function).
destructuring-long-option-with-parameter
(macro).
do-destructuring-long-option-with-parameter
(function).
long-option-including-parameter-p
(function).
lisp-executable/src/program-options.lisp
src
(module).
before-executable-creation-function
(function).
define-program-options
(macro).
ensure-program-options
(function).
executable-options
(function).
program-options
(function).
(setf program-options)
(function).
program-options
(class).
before-executable-creation
(function).
lisp-executable/src/creation.lisp
program-options.lisp
(file).
src
(module).
*lisp-machine-output-stream*
(special variable).
create-executable
(function).
executable-files
(generic function).
save-executable-and-die
(function).
asdf-actions
(function).
command-line-arguments
(generic function).
determine-complete-set-of-asdf-systems
(function).
do-with-control-c-handled
(generic function).
kill-lisp-machine
(generic function).
lisp-machine-exit
(generic function).
lisp-machine-input
(generic function).
remove-from-plist-unless-keys-are
(function).
save-executable-using-code-and-die
(generic function).
start-new-lisp-machine
(generic function).
sticky-beak-op
(class).
wait-for-lisp-machine
(generic function).
with-control-c-handled
(macro).
lisp-executable/src/creation-sbcl.lisp
creation.lisp
(file).
src
(module).
executable-files
(method).
command-line-arguments
(method).
do-with-control-c-handled
(method).
kill-lisp-machine
(method).
lisp-machine-exit
(method).
lisp-machine-input
(method).
save-executable-using-code-and-die
(method).
start-new-lisp-machine
(method).
wait-for-lisp-machine
(method).
lisp-executable/src/asdf-support.lisp
creation-sbcl.lisp
(file).
src
(module).
component-depends-on
(method).
create-executables-op
(class).
executable
(class).
input-files
(method).
input-files
(method).
input-files
(method).
output-files
(method).
perform
(method).
perform
(method).
perform
(method).
perform
(method).
source-file-type
(method).
program-path
(reader method).
Packages are listed by definition order.
lisp-executable.invocation
lisp-executable.argument-value-manager
lisp-executable
lisp-executable.creation
lisp-executable.definition
lisp-executable.gnu-style
lisp-executable.asdf-support
lisp-executable.invocation
common-lisp
.
lisp-executable
.
process-command-line-arguments
(generic function).
lisp-executable.argument-value-manager
common-lisp
.
lisp-executable.definition
.
argument-value
(function).
convert-argument-values-to-alist
(generic function).
fetch-argument-by-identifier
(function).
find-argument
(function).
find-argument-by-name
(function).
find-argument-if
(function).
make-manager
(function).
update-argument
(function).
argument-reducing-function-table
(generic reader).
argument-value-table
(generic reader).
find-argument-by-identifier
(function).
force-argument-value
(function).
identifier=
(function).
manager
(class).
perform-type-conversion
(function).
reducing-function
(function).
(setf reducing-function)
(function).
update-argument/argument
(function).
update-argument/no-parameter-option
(function).
update-argument/optional-parameter-option
(function).
update-argument/others
(function).
update-argument/required-parameter-option
(function).
lisp-executable
common-lisp
.
*command-line-arguments-reader*
(special variable).
*lisp-machine-output-stream*
(special variable).
append-policy
(function).
before-executable-creation-function
(function).
conversion-function
(generic function).
conversion-function
(slot).
count-policy
(function).
create-executable
(function).
create-executables-op
(class).
define-dispatcher-program
(macro).
define-program
(macro).
define-program-options
(macro).
ensure-program-options
(function).
error-policy
(function).
executable
(class).
executable-files
(generic function).
executable-options
(function).
identifiers
(generic reader).
identifiers
(slot).
program-apply
(function).
program-funcall
(function).
program-funcall-with-alist
(function).
program-funcall-with-plist
(function).
program-options
(function).
(setf program-options)
(function).
program-options
(class).
toggle-policy
(function).
use-first-policy
(function).
use-last-policy
(function).
lisp-executable.creation
common-lisp
.
lisp-executable
.
save-executable-and-die
(function).
asdf-actions
(function).
before-executable-creation
(function).
command-line-arguments
(generic function).
determine-complete-set-of-asdf-systems
(function).
do-with-control-c-handled
(generic function).
kill-lisp-machine
(generic function).
lisp-machine-exit
(generic function).
lisp-machine-input
(generic function).
remove-from-plist-unless-keys-are
(function).
save-executable-using-code-and-die
(generic function).
start-new-lisp-machine
(generic function).
sticky-beak-op
(class).
wait-for-lisp-machine
(generic function).
with-control-c-handled
(macro).
lisp-executable.definition
common-lisp
.
lisp-executable
.
argument-name
(generic reader).
argument-parameter-name
(generic reader).
argumentp
(function).
arguments
(slot).
arguments
(generic reader).
command-line-program-information
(function).
(setf command-line-program-information)
(function).
conversion-function-form
(generic reader).
create-reducing-function
(function).
dispatcher-information
(class).
no-parameter-option-argument-p
(function).
non-option-argument-p
(function).
optional-parameter-option-argument-p
(function).
others-argument-p
(function).
parameter-default-value
(generic reader).
program-information
(class).
reducing-function-form
(generic reader).
required-parameter-option-argument-p
(function).
*built-in-conversion-functions*
(special variable).
argument
(class).
argument-declaration-p
(function).
argument-declarations/find-conversion-function-form
(function).
argument-declarations/find-identifiers
(function).
argument-declarations/find-reducing-function-form
(function).
argument-form
(generic function).
argument-let-bindings-from-alist
(generic function).
argument-parameter-type
(generic reader).
argument-type
(generic reader).
assemble-declarations
(function).
built-in-conversion-function
(class).
conversion-function-form-argument-names
(function).
conversion-function-form-for-argument-name-p
(function).
conversion-function-form-function-name
(function).
conversion-function-form-p
(function).
converter
(generic reader).
(setf converter)
(generic writer).
create-arguments-from-definitions
(function).
create-arguments-from-definitions/no-parameter-option
(function).
create-arguments-from-definitions/non-option-argument
(function).
create-arguments-from-definitions/optional-parameter-option
(function).
create-arguments-from-definitions/others-argument
(function).
create-arguments-from-definitions/required-parameter-option
(function).
create-dispatcher-information-from-definitions
(function).
create-program-information-from-definitions
(function).
deconstruct-program-body
(macro).
do-deconstruct-program-body
(function).
ensure-dispatcher-program
(function).
ensure-program
(function).
extract-from-body/body
(function).
extract-from-body/declarations
(function).
extract-from-body/documentation-string
(function).
find-built-in-conversion-function
(function).
find-built-in-conversion-function/by-name
(function).
find-built-in-conversion-function/by-type
(function).
identifiers-form-argument-name
(function).
identifiers-form-for-argument-name-p
(function).
identifiers-form-identifiers
(function).
identifiers-form-p
(function).
information-name
(generic reader).
matcher
(generic reader).
(setf matcher)
(generic writer).
name
(generic reader).
reducing-function-form-argument-names
(function).
reducing-function-form-for-argument-name-p
(function).
reducing-function-form-function-name
(function).
reducing-function-form-p
(function).
register-built-in-conversion-function
(function).
separate-argument-declarations
(function).
separate-body-components
(function).
string-or-character-p
(function).
string-to-type-using-read
(function).
value-from-alist
(function).
lisp-executable.gnu-style
common-lisp
.
lisp-executable.argument-value-manager
.
lisp-executable.definition
.
dispatcher-command-line-arguments-processor
(function).
long-option-p
(function).
option-identifier-from-string
(function).
option-p
(function).
options-processing-terminator-p
(function).
program-command-line-arguments-processor
(function).
short-option-p
(function).
destructuring-long-option-with-parameter
(macro).
do-destructuring-long-option-with-parameter
(function).
long-option-including-parameter-p
(function).
lisp-executable.asdf-support
common-lisp
.
lisp-executable
.
program
(slot).
program-path
(generic reader).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Returns the name of the argument defined in the command line program definition.
Returns the arguments used by a command line program.
manager
)) ¶automatically generated reader method
dispatcher-information
)) ¶automatically generated reader method
program-information
)) ¶automatically generated reader method
Returns the conversion function used by the argument.
Returns the identifiers used by the argument.
(eql lisp-executable:gnu-style)
) (information dispatcher-information
) strings) ¶(eql lisp-executable:gnu-style)
) (information program-information
) strings) ¶Returns the reducing function form specified for
the argument. Use the function CREATE-REDUCING-FUNCTION to
instantiate a reducing function.
create-executables-op
) (component executable
)) ¶asdf/action
.
create-executables-op
) (component executable
)) ¶asdf/action
.
load-op
) (component executable
)) ¶asdf/action
.
compile-op
) (component executable
)) ¶asdf/action
.
create-executables-op
) (component executable
)) ¶asdf/action
.
create-executables-op
) component) ¶asdf/action
.
create-executables-op
) (component executable
)) ¶asdf/action
.
load-op
) (component executable
)) ¶asdf/action
.
compile-op
) (component executable
)) ¶asdf/action
.
executable
) system) ¶asdf/component
.
downward-operation
.
:name
This slot is read-only.
component
.
:program
This slot is read-only.
:name
This slot is read-only.
Returns the function body of body
Returns the declarations found in body as a list.
Returns the documentation string found in body
Utility function that helps with implementing START-NEW-LISP-MACHINE and SAVE-EXECUTABLE-USING-FUNCTION-AND-DIE.
Returns a form that can be used to recreate the argument.
Returns the let bindings needed for the command
line program. All arguments are sourced from the alist ALIST-VAR.
dispatcher-information
) alist-var) ¶program-information
) alist-var) ¶built-in-conversion-function
)) ¶automatically generated reader method
built-in-conversion-function
)) ¶automatically generated writer method
dispatcher-information
)) ¶automatically generated reader method
name
.
program-information
)) ¶automatically generated reader method
name
.
built-in-conversion-function
)) ¶automatically generated reader method
built-in-conversion-function
)) ¶automatically generated writer method
built-in-conversion-function
)) ¶automatically generated reader method
name
.
executable
)) ¶automatically generated reader method
common-lisp
.
:type
This slot is read-only.
:name
This slot is read-only.
:parameter-type
This slot is read-only.
:parameter-name
This slot is read-only.
:parameter-default-value
This slot is read-only.
:conversion-function
This slot is read-only.
:conversion-function-form
This slot is read-only.
:identifiers
This slot is read-only.
:reducing-function-form
This slot is read-only.
:arguments
This slot is read-only.
(make-hash-table)
This slot is read-only.
(make-hash-table)
This slot is read-only.
sideway-operation
.
Jump to: | (
A B C D E F G I K L M N O P R S T U V W |
---|
Jump to: | (
A B C D E F G I K L M N O P R S T U V W |
---|
Jump to: | *
A B C E I M N P R S T |
---|
Jump to: | *
A B C E I M N P R S T |
---|
Jump to: | A B C D E F G I L M P S |
---|
Jump to: | A B C D E F G I L M P S |
---|