7.5.1.4 User Presentation Attributes

Attributes that affect the user’s experience.

‘allow-errors’

The presence of this attribute indicates ignoring any command line option errors. This may also be turned on and off by invoking the macros ERRSKIP_OPTERR and ERRSTOP_OPTERR from the generated interface file.

‘long-opts’

Presence indicates GNU-standard long option processing. Partial name matches are accepted, if they are at least two characters long and the partial match is unique. The matching is not case sensitive, and the underscore, hyphen and carat characters are all equivalent (they match).

If any options do not have an option value (flag character) specified, and least one does specify such a value, then you must specify long-opts. If none of your options specify an option value (flag character) and you do not specify long-opts, then command line arguments are processed in "named option mode". This means that:

• Every command line argument must be a long option.
• The flag markers ‘-’ and ‘--’ are completely optional.
• The argument program attribute is disallowed.
• One of the options may be specified as the default (as long as it has a required option argument).

‘no-xlate’

Modifies when or whether option names get translated. If provided, it must be assigned one of these values:

‘opt-cfg’

to suppress option name translation for configuration file and and environment variable processing.

‘opt’

to suppress option name translation completely. The usage text will always be translated if ENABLE_NLS is defined and you have translations for that text.

‘anything’

Specifies disabling all internationalization support for option code, completely.

See also the various XLAT interface entries in the AutoOpts Programmatic Interface section (see section Programmatic Interface).

‘reorder-args’

Normally, POSIX compliant commands do not allow for options to be interleaved with operands. If this is necessary for historical reasons, there are two approaches available:

• Allow optionProcess to return the index of the operand like it normally does and process the operand(s). When an operand is encountered that starts with a hyphen, then set the AutoOpts current index with the RESTART_OPT macro (see see section RESTART_OPT( n ) - Resume Option Processing), and re-invoke optionProcess. This will also allow you to process the operands in context.
• Specify this attribute. AutoOpts will re-order the command arguments so that the operands appear (in the original order) at the end of the argument list. Differing configuration state is not possible to detect after all options have been processed.

‘resettable’

Specifies that the ‘--reset-option’ command line option is to be supported. This makes it possible to suppress any setting that might be found in a configuration file or environment variable.

This document was generated by Bruce Korb on August 21, 2015 using texi2html 1.82.