Index of values


A
allow_contracted_shorts [CmdlineArgs.Customization]
Whether "-abc" is interpreted as "-a -b -c".
allow_long_start_with_single_dash [CmdlineArgs.Customization]
Whether long forms like "-single-dash" are permitted.

C
cmdline_args [CmdlineArgs.S]
Actual command line of the running program.

D
default [CmdlineArgs.S]
default default_value take_out lst what returns what take_out lst what produces, but the option value is unwrapped, so that instead (None, remaining) this function returns (default_value, remaining).
default_long_prefix [CmdlineArgs.Customization]
Prepended to long forms if given without a leading dash.

E
empty_parsed [CmdlineArgs.S]
Neutral element for CmdlineArgs.S.join_parsed.
enforce_single_byte_shorts [CmdlineArgs.Customization]
If set, short forms made of more than one byte are rejected as invalid by the constructor functions (like oConst).
error [CmdlineArgs.S]
Join the given pieces of a message with spaces and raise CmdlineArgs.S.Error.
exec_traditional [CmdlineArgs.S]
Execute the recognized traditional options.

F
final_take_pure [CmdlineArgs.S]
Like CmdlineArgs.S.take_pure, but expects to consume all the parsed pieces.
fold [CmdlineArgs.S]
fold section initial parsed takes materialized meanings as picked by CmdlineArgs.S.recognize (let's call these meanings m1, m2, ..., mN) and applies them chained to the initial value in the following way: m1 (m2 (... (mN initial) ...)) (let's call this cumulated).
format_help [CmdlineArgs.S.PlainText]
Core part of the traditional --help string.
format_manual [CmdlineArgs.S.Nroff]
format_manual ?(manpage_section="1") raw_manual_sections usage_synopsis version_string summary generates a manpage.
format_options [CmdlineArgs.S.Nroff]
Intermediate form of the table of options.

H
help_table [CmdlineArgs.S.PlainText]
Generate --help string in a 3-column tabular form.

J
join_parsed [CmdlineArgs.S]
Put together the given processed arguments.

L
last [CmdlineArgs.S]
last take_out lst what expects take_out lst what to consume all of the lst and return empty remaining list.

M
materialize_pure [CmdlineArgs.S]
Used to handle pure arguments with given meaning.

O
oApplyBool [CmdlineArgs.S]
oApplyBoolOpt [CmdlineArgs.S]
oApplyFloat [CmdlineArgs.S]
oApplyFloatOpt [CmdlineArgs.S]
oApplyInt [CmdlineArgs.S]
oApplyIntOpt [CmdlineArgs.S]
oApplyPath [CmdlineArgs.S]
oApplyPathOpt [CmdlineArgs.S]
oApplyRawPath [CmdlineArgs.S]
oApplyRawPathOpt [CmdlineArgs.S]
oApplyRealPath [CmdlineArgs.S]
oApplyRealPathOpt [CmdlineArgs.S]
oApplyString [CmdlineArgs.S]
oApplyStringOpt [CmdlineArgs.S]
oApplySymbol [CmdlineArgs.S]
oApplySymbolOpt [CmdlineArgs.S]
oApplyUnit [CmdlineArgs.S]
oBool [CmdlineArgs.S]
oBoolOpt [CmdlineArgs.S]
oConst [CmdlineArgs.S]
oFloat [CmdlineArgs.S]
oFloatOpt [CmdlineArgs.S]
oInt [CmdlineArgs.S]
oIntOpt [CmdlineArgs.S]
oPath [CmdlineArgs.S]
oPathOpt [CmdlineArgs.S]
oRawPath [CmdlineArgs.S]
oRawPathOpt [CmdlineArgs.S]
oRealPath [CmdlineArgs.S]
oRealPathOpt [CmdlineArgs.S]
oSetBool [CmdlineArgs.S]
oSetBoolOpt [CmdlineArgs.S]
oSetFalse [CmdlineArgs.S]
oSetFloat [CmdlineArgs.S]
oSetFloatOpt [CmdlineArgs.S]
oSetInt [CmdlineArgs.S]
oSetIntOpt [CmdlineArgs.S]
oSetPath [CmdlineArgs.S]
oSetPathOpt [CmdlineArgs.S]
oSetRawPath [CmdlineArgs.S]
oSetRawPathOpt [CmdlineArgs.S]
oSetRealPath [CmdlineArgs.S]
oSetRealPathOpt [CmdlineArgs.S]
oSetString [CmdlineArgs.S]
oSetStringOpt [CmdlineArgs.S]
oSetSymbol [CmdlineArgs.S]
oSetSymbolOpt [CmdlineArgs.S]
oSetTrue [CmdlineArgs.S]
oString [CmdlineArgs.S]
oStringOpt [CmdlineArgs.S]
oSymbol [CmdlineArgs.S]
oSymbolOpt [CmdlineArgs.S]
opt [CmdlineArgs.S]
opt meaning long ?short ?importance help constructs a definition of an command-line option.

P
parameter_placement_long [CmdlineArgs.Customization]
How parameter is put after an option in long form in the command line.
parameter_placement_short [CmdlineArgs.Customization]
How parameter is put after an option in short form in the command line.
parse [CmdlineArgs.S]
First step of processing arguments.
parse_Bool [CmdlineArgs.S]
parse_Float [CmdlineArgs.S]
parse_Int [CmdlineArgs.S]
parse_Path [CmdlineArgs.S]
parse_RawPath [CmdlineArgs.S]
parse_String [CmdlineArgs.S]
parse_Symbol [CmdlineArgs.S]
parse_Symbol atoms str returns str if it is found among atoms.
parse_fold [CmdlineArgs.S]
Like CmdlineArgs.S.parse_fold_exc, but in case of CmdlineArgs.S.Error prints a message and calls exit 2.
parse_fold_exc [CmdlineArgs.S]
parse_fold_exc ?(args=cmdline_args) version_string ?usage_synopsis ?formatted_usage_synopsis definitions initial is like CmdlineArgs.S.parse_recognize_exc, but the meanings of recognized options are folded.
parse_recognize [CmdlineArgs.S]
Like CmdlineArgs.S.parse_recognize_exc, but in case of CmdlineArgs.S.Error prints a message and calls exit 2.
parse_recognize_exc [CmdlineArgs.S]
parse_recognize_exc ?(args=cmdline_args) version_string ?usage_synopsis ?formatted_usage_synopsis definitions processes the given (or current) command line arguments and translates them to their meanings (i.e.

Q
quote [CmdlineArgs.S]
Put a string in between guillemets.

R
recognize [CmdlineArgs.S]
recognize section parsed returns (materialized, others).

S
simple_help_string [CmdlineArgs.S]
simple_help_string usage_synopsis summary formats a help message that consists of the given usage synopsis and a table of options given by summary.
simple_usage_synopsis_of_string [CmdlineArgs.S.Nroff]
Guesses some formatting of lines of usage examples and translates to HSimpleDoc form.
summary [CmdlineArgs.S]
summary title definitions creates a summary of a list of options (a section).

T
take_flag_out [CmdlineArgs.S]
take_flag_out lst flag picks all ocurrences of flag in lst.
take_pure [CmdlineArgs.S]
Extracts pure arguments in a similar fashion to recognize.
take_value_out [CmdlineArgs.S]
take_value_out policy lst extract returns (extracted, remaining).
take_values_out [CmdlineArgs.S]
take_values_out lst extract returns (extracted, remaining).
traditional [CmdlineArgs.S]
Empty title and definitions of traditional switches (--help and --version).
traditional_enhanced [CmdlineArgs.S]
The traditional set enriched with the manpage generation option.