commandline.core — commandline-clj 0.3.0

*columns* clj

The number of columns used by print-usage and print-help.

*options* clj

The current command line option specs as a vector of maps. Only bound within the body of with-commandline and used by print-usage and print-help.

make-parser clj

(make-parser type)

Make a new parser type, either :basic, :gnu or :posix.

option clj

(option {:keys [short long description type arg-name required]})

Convert an option map into an Option instance.

option-map clj

(option-map [short long description & [type arg-name required]])

Convert the command line option in vector form into a map.

options clj

(options option-maps)

Convert a seq of option maps into an Options instance.

parse-argument clj multimethod

Convert a command line argument to type.

parse-commandline clj

(parse-commandline option-maps arguments & [opts])

Build a command line parser from option-maps, parse the arguments and return a vector of the parsed options and any pending arguments.

print-help clj

(print-help syntax & {:keys [header footer pad-left pad-desc width]})

Print help about the program.

print-usage clj

(print-usage program & {:keys [width]})

Print the usage information of the program.

string-array clj

(string-array arguments)

Convert arguments into an array of strings.

with-columns clj macro

(with-columns size & body)

Bind *columns* to size and evaluate body.

with-commandline clj macro

(with-commandline [[options-sym arguments-sym] arguments & [parser]]
                  option-spec
                  &
                  body)

Evaluate body with the parsed commandline option-spec bound to options-sym and any pending command line arguments to arguments-sym.

Example:

(with-commandline [[options arguments] ["-a" "/tmp"]] [[a all "do not hide entries starting with ."] [A almost-all "do not list implied . and .."] [b escape "print octal escapes for nongraphic characters"] [t time "the time" :time] [nil block-size "use SIZE-byte blocks" :integer "SIZE"] [B ignore-backups "do not list implied entried ending with ~"] [c nil (str "with -lt: sort by, and show, ctime (time of last modification of file status information) " "with -l: show ctime and sort by name otherwise: sort by ctime")] [C nil "list entries by columns"] [I ids "list of integers" :integers "IDS"]] (prn "Options: " options) (prn "Pending arguments: " arguments))