[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

7.5.1.1 Usage and Version Info Display

These will affect the way usage is seen and whether or not version information gets displayed.

full-usage

If this attribute is provided, it may specify the full length usage text, or a variable name assignable to a “char const *” pointer, or it may be empty. The meanings are determined by the length.

This string should be readily translatable and provision will be made to translate it if this is provided and the source code is compiled with “ENABLE_NLS” defined.

short-usage

If this attribute is provided, it is used to specify an abbreviated version of the usage text. This text is constructed in the same way as the “full-usage”, described above.

gnu-usage

AutoOpts normaly displays usage text in a format that provides more information than the standard GNU layout, but that also means it is not the standard GNU layout. This attribute changes the default to GNU layout, with the AUTOOPTS_USAGE environment variable used to request autoopts layout. See See section Developer and User Notes.

no-misuse-usage

When there is a command line syntax error, by default AutoOpts will display the abbreviated usage text, rather than just a one line “you goofed it, ask for usage” message. You can change the default behavior for your program by supplying this attribute. The user may override this choice, again, with the AUTOOPTS_USAGE environment variable. See See section Developer and User Notes.

prog-group

The version text in the ‘getopt.tpl’ template will include this text in parentheses after the program name, when this attribute is specified. For example:

 
mumble (stumble) 1.0

says that the “mumble” program is version 1.0 and is part of the “stumble” group of programs.

version

Specifies the program version and activates the VERSION option, See section Automatically Supported Options.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

This document was generated by Bruce Korb on February 17, 2011 using texi2html 1.82.

Viewable With Any Browser   autogen Home