Liking cljdoc? Tell your friends :D

clojopts.core


clojoptscljmacro

(clojopts prog-name argv & specs)

The main entry point for clojopts. Requires your program's name (for output in usage and version messages), a seq of command-line options, and any number of option specifiers. Returns a map of any options contained in the command line. Currently discards(!) all non-option arguments, but a future (pre-1.0) version will add them under the key :clojopts/more.

Options are specified in the following format: <(arg-type name+ docstring & options)>

See the README for further details.

The main entry point for clojopts. Requires your program's
name (for output in usage and version messages), a seq of command-line
options, and any number of option specifiers. Returns a map of any
options contained in the command line. Currently discards(!) all
non-option arguments, but a future (pre-1.0) version will add them
under the key :clojopts/more.

Options are specified in the following format:
<(arg-type name+ docstring & options)>

See the README for further details.
raw docstring

clojopts*clj

(clojopts* prog-name argv & specs)

desugar-specclj

(desugar-spec spec)

desugar-specscljmacro

(desugar-specs & specs)

desugar-specs*clj

(desugar-specs* specs)

no-argclj

(no-arg name+ doc specs)

optional-argclj

(optional-arg name+ doc specs)

qualified-keywordclj

(qualified-keyword sym)

read-speccljmultimethod

Clojopt specs are executable as functions, but during macro processing it can be helpful to parse them without evaluating the sexp. read-spec inspects the first argument of the sexp and calls the appropriate spec parser with the remaining args. Example use: (read-spec '(no-arg ["name"] "the program name"))

Clojopt specs are executable as functions, but during macro
processing it can be helpful to parse them without evaluating the
sexp. read-spec inspects the first argument of the sexp and calls the
appropriate spec parser with the remaining args. Example
use: (read-spec '(no-arg ["name"] "the program name"))
raw docstring

with-argclj

(with-arg name+ doc specs)

with-optionscljmacro

(with-options prog-name argv specs & body)

with-options*clj

(with-options* bindval specs & body)

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close