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

7.5.9.1 Per option documentation attributes

These attributes are sub-attributes (sub-stanzas) of the flag stanzas.

arg-name

If an option has an argument, the argument should have a name for documentation purposes. It will default to arg-type, but it will likely be clearer with something else like, file-name instead of string (the type).

doc

First, every flag definition other than documentation definitions, must have a doc attribute defined. If the option takes an argument, then it will need an arg-name attribute as well. The doc text should be in plain sentences with minimal formatting. The Texinfo commands @code, and @var will have its enclosed text made into \fB entries in the man page, and the @file text will be made into \fI entries. The arg-name attribute is used to display the option’s argument in the man page.

Options marked with the documentation attribute are for documenting the usage text. All other options should have the doc attribute in order to document the usage of the option in the generated man pages.

Since these blocks of text are inserted into all output forms, any markup text included in these blocks must be massaged for each output format. By default, it is presumed to be ‘texi’ format.


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

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