# Index of values

($) [Cmdliner.Term] | `f $ v` is a term that evaluates to the result of applying the evaluation of `v` to the one of `f`.
(&) [Cmdliner.Arg] | `f & v` is `f v`, a right associative composition operator for specifying argument terms.
A
app [Cmdliner.Term] | `app` is `Cmdliner.Term.($)`.
array [Cmdliner.Arg] | `array sep c` splits the argument at each `sep` (defaults to `','`) character and converts each substring with `c`.
B
bool [Cmdliner.Arg] | `bool` converts values with `bool_of_string`.
C
char [Cmdliner.Arg] | `char` converts values by ensuring the argument has a single char.
choice_names [Cmdliner.Term] | `choice_names` is a term that evaluates to the names of the terms to choose from.
const [Cmdliner.Term] | `const v` is a term that evaluates to `v`.
D
dir [Cmdliner.Arg] | `dir` converts a value with the identity function and checks with `Sys.file_exists` and `Sys.is_directory` that a directory with that name exists.
doc_alts [Cmdliner.Arg] | `doc_alts alts` documents the alternative tokens `alts` according the number of alternatives.
doc_alts_enum [Cmdliner.Arg] | `doc_alts_enum quoted alts` is `doc_alts quoted (List.map fst alts)`.
doc_quote [Cmdliner.Arg] | `doc_quote s` quotes the string `s`.
E
enum [Cmdliner.Arg] | `enum l p` converts values such that unambiguous prefixes of string names in `l` map to the corresponding value of type `'a`.
env_var [Cmdliner.Arg] | `env_var docs doc var` is an environment variables `var`.
eval [Cmdliner.Term] | `eval help err catch argv (t,i)` is the evaluation result of `t` with command line arguments `argv` (defaults to `Sys.argv`).
eval_choice [Cmdliner.Term] | `eval_choice help err catch argv default (t,i) choices` is like `Cmdliner.Term.eval` except that if the first argument on the command line is not an option name it will look in `choices` for a term whose information has this name and evaluate it.
eval_peek_opts [Cmdliner.Term] | `eval_peek_opts version_opt argv t` evaluates `t`, a term made of optional arguments only, with the command line `argv` (defaults to `Sys.argv`).
F
file [Cmdliner.Arg] | `file` converts a value with the identity function and checks with `Sys.file_exists` that a file with that name exists.
flag [Cmdliner.Arg] | `flag i` is a `bool` argument defined by an optional flag that may appear at most once on the command line under one of the names specified by `i`.
flag_all [Cmdliner.Arg] | `flag_all` is like `Cmdliner.Arg.flag` except the flag may appear more than once.
float [Cmdliner.Arg] | `float` converts values with `float_of_string`.
I
info [Cmdliner.Arg] | `info docs docv doc env names` defines information for an argument.
info [Cmdliner.Term] | `info sdocs man docs doc version name` is a term information such that: `name` is the name of the program or the command., `version` is the version string of the program, ignored for commands., `doc` is a one line description of the program or command used for the `NAME` section of the term's man page. For commands this description is also used in the list of commands of the main term's man page., `docs`, only for commands, the title of the section of the main term's man page where it should be listed (defaults to `"COMMANDS"`)., `man` is the text of the man page for the term. In the text, the variables `"$(tname)"` and `"$(mname)"` can respectively be used to refer to the value of `name` and the main term's name. , `sdocs` defines the title of the section in which the standard `--help` and `--version` arguments are listed.
int [Cmdliner.Arg] | `int` converts values with `int_of_string`.
int32 [Cmdliner.Arg] | `int32` converts values with `Int32.of_string`.
int64 [Cmdliner.Arg] | `int64` converts values with `Int64.of_string`.
L
last [Cmdliner.Arg] | `last a` is a term that fails if `a`'s list is empty and evaluates to the value of the last element of the list otherwise.
list [Cmdliner.Arg] | `list sep c` splits the argument at each `sep` (defaults to `','`) character and converts each substrings with `c`.
M
main_name [Cmdliner.Term] | `main_name` is a term that evaluates to the "main" term's name.
man_format [Cmdliner.Term] | `man_format` is a term that defines a `--man-format` option and evaluates to a value that can be used with `Cmdliner.Manpage.print`.
N
name [Cmdliner.Term] | `name ti` is the name of the term information.
nativeint [Cmdliner.Arg] | `nativeint` converts values with `Nativeint.of_string`.
non_dir_file [Cmdliner.Arg] | `non_dir_file` converts a value with the identity function and checks with `Sys.file_exists` and `Sys.is_directory` that a non directory file with that name exists.
non_empty [Cmdliner.Arg] | `non_empty a` is term that fails if `a`'s list is empty and evaluates to `a`'s list otherwise.
O
opt [Cmdliner.Arg] | `opt vopt c v i` is an `'a` argument defined by the value of an optional argument that may appear at most once on the command line under one of the names specified by `i`.
opt_all [Cmdliner.Arg] | `opt_all vopt c v i` is like `Cmdliner.Arg.opt` except the optional argument may appear more than once.
P
pair [Cmdliner.Arg] | `pair sep c0 c1` splits the argument at the first `sep` character (defaults to `','`) and respectively converts the substrings with `c0` and `c1`.
pos [Cmdliner.Arg] | `pos rev n c v i` is an `'a` argument defined by the `n`th positional argument of the command line as converted by `c`.
pos_all [Cmdliner.Arg] | `pos_all c v i` is an `'a list` argument that holds all the positional arguments of the command line as converted by `c` or `v` if there are none.
pos_left [Cmdliner.Arg] | `pos_left rev n c v i` is an `'a list` argument that holds all the positional arguments as converted by `c` found on the left of the `n`th positional argument or `v` if there are none.
pos_right [Cmdliner.Arg] | `pos_right` is like `Cmdliner.Arg.pos_left` except it holds all the positional arguments found on the right of the specified positional argument.
print [Cmdliner.Manpage] | `print ~subst fmt ppf page` prints `page` on `ppf` in the format `fmt`.
R
required [Cmdliner.Arg] | `required a` is a term that fails if `a`'s value is `None` and evaluates to the value of `Some` otherwise.
ret [Cmdliner.Term] | `ret v` is a term whose evaluation depends on the case to which `v` evaluates.
S
some [Cmdliner.Arg] | `some none c` is like the converter `c` except it returns `Some` value.
string [Cmdliner.Arg] | `string` converts values with the identity function.
T
t2 [Cmdliner.Arg] | `Cmdliner.Arg.t2` is `Cmdliner.Arg.pair`.
t3 [Cmdliner.Arg] | `t3 sep c0 c1 c2` splits the argument at the first two `sep` characters (defaults to `','`) and respectively converts the substrings with `c0`, `c1` and `c2`.
t4 [Cmdliner.Arg] | `t4 sep c0 c1 c2 c3` splits the argument at the first three `sep` characters (defaults to `','`) respectively converts the substrings with `c0`, `c1`, `c2` and `c3`.
V
value [Cmdliner.Arg] | `value a` is a term that evaluates to `a`'s value.
vflag [Cmdliner.Arg] | `vflag v [v`0`,i`0`;...]` is an `'a` argument defined by an optional flag that may appear at most once on the command line under one of the names specified in the `i`k values.
vflag_all [Cmdliner.Arg] | `vflag_all v l` is like `Cmdliner.Arg.vflag` except the flag may appear more than once.