cmdr
Artifact Content
Not logged in

Artifact 4beb4053651c63eb34d9590551754beb0137b834:



The help information generated by various places of the framework
is a dictionary containing the following keys:

[list_begin definitions]
[def arguments]
A list of strings, the names of the command arguments, in order.
These names are keys into the [var parameters] sub-dictionary.

[def desc]
The command's description, i.e. help text.

[def opt2para]
A dictionary mapping option flags to option names.
These names are keys into the [var parameters] sub-dictionary.

[def options]
A dictionary mapping option names to their descriptions.

[def parameters]
A dictionary mapping parameter names to their definition.
Each definition is a dictionary containing the keys below.
See also package [package cmdr::parameter].

[include help_para_structure.inc]

[def sections]
A list of sections the command belongs to.
Each section name is a list itself, the path of the section and sub-sections.

[def states]
A list of strings, the names of the command's hidden state parameters.
These names are keys into the [var parameters] sub-dictionary.
[list_end]