Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the command-line-arguments Reference Manual, version 1.0.2, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:37:45 2018 GMT+0.
| • Introduction: | What command-line-arguments is all about | |
| • Systems: | The systems documentation | |
| • Files: | The files documentation | |
| • Packages: | The packages documentation | |
| • Definitions: | The symbols documentation | |
| • Indexes: | Concepts, functions, variables and data types |
A library for parsing command-line arguments.
Use it in conjunction with asdf:program-op or cl-launch for portable processing of command-line arguments.
This library is woefully under-documented. See the examples below, and read the source code for details. Here is what a prototypical use looks like:
(defparameter +command-line-spec+
'(((#\b) :type boolean :optional t :documentation "what optional -b flag does")
(("check" #\c) :type string :optional t :documentation "a --check or -c flag that takes a string")
(("verbose") :type boolean :optional t :documentation "only a verbose --verbose is accepted")
(("warn" "warning" #\w) :type boolean :optional t :documentation "multiple spellings possible")
(("help" #\h #\?) :type boolean :optional t :documentation "--help -h -?, good practice to have")
(("version" #\V) :type boolean :optional t :documentation "--version or -V, you get the idea")))
;; for the positional arguments, see below :positional-arity and :rest-arity
(defun my-program-function (arg1 arg2 rest-args &key b check verbose warn help version)
(when help (show-option-help +command-line-spec+ :sort-names t) (uiop:quit))
(when version (show-version) (uiop:quit))
...)
(defun main (args)
(handle-command-line
;; the spec as above, or prepared with prepare-command-line-options-specification
+command-line-spec+
;; the function to call with the arguments as parsed
'my-program-function
;; the arguments to parse
:command-line args
;; the program name to use in case of an error message
:name "my-program"
;; the number of mandatory positional arguments for this command (default: 0)
:positional-arity 2
;; What to do with the rest of the positional arguments.
;; T means pass the list of the rest of the command-line-arguments as one lisp argument.
;; NIL means ignore it. A keyword means pass this rest as a keyword argument.
:rest-arity t))
For very simple examples of actual uses, see my tthsum clone in Lisp or my workout-timer.
For a much more elaborate use, see xcvb — unhappily, XCVB has gone mostly unmaintained since 2012, so the example might not be usefully runnable.
http://common-lisp.net/project/qitab/
For a fancier take on the same general idea, see Didier Verna's CLON:
http://www.lrde.epita.fr/~didier/software/lisp/clon.php
CLON has much more features than this library, but is much more complex and slighly less portable
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The command-line-arguments system: |
Francois-Rene Rideau
Francois-Rene Rideau
MIT
small library to deal with command-line arguments
A library to abstract away the parsing of Unix-style command-line arguments
1.0.2
command-line-arguments.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files: |
Next: The command-line-arguments/pkgdcl<dot>lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
command-line-arguments.asd
command-line-arguments (system)
Next: The command-line-arguments/argv<dot>lisp file, Previous: The command-line-arguments<dot>asd file, Up: Lisp files [Contents][Index]
command-line-arguments (system)
pkgdcl.lisp
Next: The command-line-arguments/parse<dot>lisp file, Previous: The command-line-arguments/pkgdcl<dot>lisp file, Up: Lisp files [Contents][Index]
pkgdcl.lisp (file)
command-line-arguments (system)
argv.lisp
invoke-command-line-handler (function)
Next: The command-line-arguments/help<dot>lisp file, Previous: The command-line-arguments/argv<dot>lisp file, Up: Lisp files [Contents][Index]
pkgdcl.lisp (file)
command-line-arguments (system)
parse.lisp
Previous: The command-line-arguments/parse<dot>lisp file, Up: Lisp files [Contents][Index]
pkgdcl.lisp (file)
command-line-arguments (system)
help.lisp
show-option-help (function)
split-sequence (function)
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The command-line-arguments package: |
pkgdcl.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 functions: |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
the (prepared) specification for how to parse command-line options
parse.lisp (file)
command-line options as parsed into a plist
parse.lisp (file)
Previous: Exported special variables, Up: Exported definitions [Contents][Index]
argv.lisp (file)
argv.lisp (file)
argv.lisp (file)
SPECIFICATION is a list as described above.
COMMAND-LINE is the list of tokens to be parsed.
Return two values:
a list of alternating actions and values, and
a list of the arguments remaining after the various specified options.
parse.lisp (file)
help.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal functions: |
Previous: Internal definitions, Up: Internal definitions [Contents][Index]
parse.lisp (file)
Given a STRING option argument and a TYPE of argument,
return the argument value as a Lisp object.
OPTION is the name of the option to which the argument is to be passed,
for the sake of error messages.
parse.lisp (file)
parse.lisp (file)
parse.lisp (file)
parse.lisp (file)
Remove all the options and values from *COMMAND-LINE-ARGUMENTS*. Process each option.
parse.lisp (file)
parse.lisp (file)
parse.lisp (file)
argv.lisp (file)
ARG is a string. Is it like –XXX ?
parse.lisp (file)
parse.lisp (file)
This is called for each option specification when preparing for parsing, and
computes the action function to call (with optional value if provided)
when the option is found on a command-line.
P is the hash-table of actions.
NAME is the first name of this option, a string or a character.
The keywords are option options for this option specification.
parse.lisp (file)
ARG is a string. Is it like +X ?
parse.lisp (file)
parse.lisp (file)
parse.lisp (file)
parse.lisp (file)
Given a SPECIFICATION, return a hash-table mapping
option names to a vector of
the action function to call when encountering the option,
the type of option arguments accepted, and
whether the option is optional.
parse.lisp (file)
parse.lisp (file)
parse.lisp (file)
parse.lisp (file)
ARG is a string. Is it like -X, but not – ?
parse.lisp (file)
help.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: | C F L |
|---|
| Jump to: | C F L |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | A C D F G H I L M N O P S |
|---|
| Jump to: | A C D F G H I L M N O P S |
|---|
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 |
|---|
| Jump to: | C P S |
|---|