GNU AutoGen - The Automated Program Generator: 7.5.5.10 Option Sectioning Comment

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

#### 7.5.5.10 Option Sectioning Comment

This attribute means the option exists for the purpose of separating option description text in the usage output. Libraries may choose to make it settable so that the library can determine which command line option is the first one that pertains to the library.

If the “`documentation`” attribute is present, then all other attributes are disabled except `settable`, `call-proc` and `flag-code`. `settable` must be and is only specified if `call-proc`, `extract-code` or `flag-code` has been specified. When present, the `descrip` attribute will be displayed only when the `--help` option has been specified. It will be displayed flush to the left hand margin and may consist of one or more lines of text. The name of the option will not be printed.

Documentation options are for clarifying the usage text and will not appear in generated man pages or in the generated invoking texinfo doc.

This document was generated by Bruce Korb on March 7, 2011 using texi2html 1.82.