This is the cl-getopt Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 04:08:45 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-getoptCFFI wrapper to the libc getopt_long function
Gary Hollis
Public Domain
cffi-grovel (system).
cffi (system).
package.lisp (file).
grovel.lisp (file).
cl-getopt.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-getopt/grovel.lisppackage.lisp (file).
cl-getopt (system).
cl-getopt/cl-getopt.lispgrovel.lisp (file).
cl-getopt (system).
getopt (function).
option-descriptions (function).
->optionstr (function).
->shortchar (function).
c-getopt-long (function).
option (class).
option-shortarg (function).
options->shortargs (function).
short-char (function).
with-foreign-args (macro).
with-foreign-longopts (macro).
with-foreign-shortopts (macro).
Packages are listed by definition order.
cl-getoptcffi.
common-lisp.
getopt (function).
option-descriptions (function).
->optionstr (function).
->shortchar (function).
c-getopt-long (function).
option (class).
option-shortarg (function).
options->shortargs (function).
short-char (function).
with-foreign-args (macro).
with-foreign-longopts (macro).
with-foreign-shortopts (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Returns the values
* option-values
* remaining-arguments
given the list of input arguments and options specification.
option-values is hash-table of the short or long argument name
string (short if present) and the list of all supplied values of that
option in the order they were given. remaining-arguments is a list of
the remaining arguments after processing the options.
Note that if no argument is supplied to an option, whether because the
argspec is :none or :optional, there will still be a list of NIL
elements for each time the option was supplied without an argument.
When the argspec is :required, some kind of value must be in the
argument list for each time that option was supplied.
options should be a list of plists, each plist of the form (&key long
short argspec description) where
* long is a symbol, string or character naming the long argument name.
* short is a symbol, string or character naming the short argument name.
* argspec is one of the values :none, :required, :optional.
* description is a string to be used in an automatically generated argument description message.
command-arg-present-p should be T whenever the argument list includes
the command as the first element, and NIL when it’s not included. For
general scripting use it should be present, but this option is
included to allow easier use of getopt for parsing argument lists
without the command being present.
Generates a description string for the list of options supplied.
column-width controls the width in characters of each option column. column-minspace controls the minimum space to pad between columns.
Converts a Lisp list of strings denoting the arguments supplied to
a command into two values:
* argc: number of argument strings
* argv: array of argument strings
These are bound to the symbols supplied in the (argc argv) list.
foreign-struct-type.
translatable-foreign-type.
| Jump to: | -
C F G M O S W |
|---|
| Jump to: | -
C F G M O S W |
|---|
| Jump to: | C F G O P S |
|---|
| Jump to: | C F G O P S |
|---|