Every component contains one or more options. Options may be gathered into option groups to allow the GUI to give visual hints to the user about which options are related.
all options (and the groups they belong to) in the component
component, one per line. component must be the string in
the field name in the output of the
There is one line for each option and each group. First come all options that are not in any group. Then comes a line describing a group. Then come all options that belong into each group. Then comes the next group and so on. There does not need to be any group (and in this case the output will stop after the last non-grouped option).
The format of each line is:
The following flag values are only defined for options (that is, if
group flag is not used).
optional arg (2)
default desc (32)
defaultflag are mutually exclusive.
no arg desc (64)
optional argflag is set, then the option has a special meaning if no argument is given.
no change (128)
The level of a group will always be the lowest level of all options it
ldap server (33)
key fingerprint (34)
pub key (35)
sec key (36)
alias list (37)
More types will be added in the future. Please see the alt-type
field for information on how to cope with unknown types.
31are allowed. The GUI is expected to present the user the option in the format specified by type. But if the argument type type is not supported by the GUI, it can still display the option in the more generic basic type alt-type. The GUI must support all the defined basic types to be able to display all options. More basic types may be added in future versions. If the GUI encounters a basic type it doesn't support, it should report an error and abort the operation.
0. In this case it may contain a percent-escaped and localized string that gives a short name for the argument. The field may also be empty, though, in which case a short name is not known.
default descflag is set. If the
defaultflag is set, its format is that of an option argument (see Format conventions, for details). If the default value is empty, then no default is known. Otherwise, the value specifies the default value for this option. If the
default descflag is set, the field is either empty or contains a description of the effect if the option is not given.
optional argflag is set. If the
no arg descflag is not set, its format is that of an option argument (see Format conventions, for details). If the default value is empty, then no default is known. Otherwise, the value specifies the default argument for this option. If the
no arg descflag is set, the field is either empty or contains a description of the effect of this option if no argument is given.