7.5.1 Program Description Attributes

The following global definitions are used to define attributes of the entire program. These generally alter the configuration or global behavior of the AutoOpts option parser. The first two are required of every program. The third is required if there are to be any left over arguments (operands) after option processing. The rest have been grouped below. Except as noted, there may be only one copy of each of these definitions:

‘prog-name’

This attribute is required. Variable names derived from this name are derived using string->c_name! (see section ‘string->c-name!’ - map non-name chars to underscore).

‘prog-title’

This attribute is required and may be any descriptive text.

‘argument’

This attribute is required if your program uses operand arguments. It specifies the syntax of the arguments that follow the options. It may not be empty, but if it is not supplied, then option processing must consume all the arguments. If it is supplied and starts with an open bracket ([), then there is no requirement on the presence or absence of command line arguments following the options. Lastly, if it is supplied and does not start with an open bracket, then option processing must not consume all of the command line arguments.

‘config-header’

If your build has a configuration header, it must be included before anything else. Specifying the configuration header file name with this attribute will cause that to happen.

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