[ < ] [ > ]   [ << ] [ 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 and texi documentation. Without this attribute, every option is a separate node in the texi docs. With this attribute, the documentation options become texi doc nodes and the options are collected under them. Choose the name attribute carefully because it will appear in the texi documentation.

Libraries may also 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, filled to 72 columns.

The name of the option will not be printed in the help text. It will, however, be printed as section headers in the texi documentation. If the attribute is given a non-empty value, this text will be reproduced in the man page and texi doc immediately after the descrip text.


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

This document was generated by Bruce Korb on October 16, 2013 using texi2html 1.82.