This is the cleopter Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri May 15 12:06:22 2026 GMT+0.
The main system appears first, followed by any subsystem dependency.
cleopterMinimalist command-line parser
André A. Gomes <andremegafone@gmail.com>
MIT
0.0.1
cleopter.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cleopter/cleopter.lispcleopter (system).
*options* (special variable).
define-options (macro).
invalid-value (condition).
missing-value (condition).
name (reader).
(setf name) (writer).
parse (function).
troublesome-token (condition).
unknown-option (condition).
usage (function).
%make-option (function).
classify (function).
copy-option (function).
data (reader method).
description (reader).
(setf description) (writer).
doc (method).
find-duplicate (function).
flag-format-args (method).
flags (method).
long (reader).
(setf long) (writer).
long-flag-name-spec (function).
make-option (function).
option (structure).
option-p (function).
parser (reader method).
short (reader).
(setf short) (writer).
unbundle (function).
value-meta-var (reader).
(setf value-meta-var) (writer).
value-parser (reader).
(setf value-parser) (writer).
variadic? (reader).
(setf variadic?) (writer).
Packages are listed by definition order.
cleoptercli
common-lisp.
*options* (special variable).
define-options (macro).
invalid-value (condition).
missing-value (condition).
name (reader).
(setf name) (writer).
parse (function).
troublesome-token (condition).
unknown-option (condition).
usage (function).
%make-option (function).
classify (function).
copy-option (function).
data (generic reader).
description (reader).
(setf description) (writer).
doc (generic function).
find-duplicate (function).
flag-format-args (generic function).
flags (generic function).
long (reader).
(setf long) (writer).
long-flag-name-spec (function).
make-option (function).
option (structure).
option-p (function).
parser (generic reader).
short (reader).
(setf short) (writer).
unbundle (function).
value-meta-var (reader).
(setf value-meta-var) (writer).
value-parser (reader).
(setf value-parser) (writer).
variadic? (reader).
(setf variadic?) (writer).
Definitions are sorted by export status, category, package, and then by lexicographic order.
A list of all defined options, see ‘define-options’.
Parse command-line ARGS against predefined OPTIONS (see ‘define-options’).
Returns 2 values:
0- a plist mapping option names (as keywords) to their values;
1- a list of free arguments.
Output to STREAM the OPTIONS available for NAME.
PREFIX and SUFFIX are printed at the top and bottom, respectively.
FREE-ARGS-META-VAR defines a label for the free arguments.
When BRIEF? is non-nil, the options’ description isn’t included.
PADDING is the column where the option description starts, while FILL-COLUMN is the column that specifies the right margin.
Signaled when the option’s value can’t be parsed.
Signaled when the option’s value isn’t provided.
The parent of all conditions.
simple-error.
data.
Signaled when parsing an undefined option.
Pattern match TOKEN as value, flag, multiple-flags or double-dash.
Split TOKEN into separate short flags. E.g. "-abc=value" => ’("-a" "-b" "-c=value").
troublesome-token)) ¶data.
invalid-value)) ¶structure-object.
keyword
(error "required argument name is missing.")
name.
string
""
(or null (satisfies alpha-char-p))
(or null function)
boolean
(or null string)
| Jump to: | %
(
C D F G L M N O P S U V |
|---|
| Jump to: | %
(
C D F G L M N O P S U V |
|---|
| Jump to: | *
D L N P S V |
|---|
| Jump to: | *
D L N P S V |
|---|
| Jump to: | C F I M O P S T U |
|---|
| Jump to: | C F I M O P S T U |
|---|