AutoGen - The Automated Program Generator: 7.14.1 command line man pages

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

### 7.14.1 command line man pages

Using the option definitions for an AutoOpts client program, the ‘`agman1.tpl`’ template will produce an nroff document suitable for use as a ‘`man(1)`’ page document for a command line command. The description section of the document is either the ‘`prog-man-descrip`’ text, if present, or the ‘`detail`’ text.

Each option in the option definitions file is fully documented in its usage. This includes all the information documented above for each option (see section Option Attributes), plus the ‘`doc`’ attribute is appended. Since the ‘`doc`’ text is presumed to be designed for `texinfo` documentation, `sed` is used to convert some constructs from `texi` to `nroff`-for-`man`-pages. Specifically,

    convert @code, @var and @samp into \fB...\fP phrases
    convert @file into \fI...\fP phrases
    Remove the '@' prefix from curly braces
    Indent example regions
    Delete the example commands
    Replace ‘end example’ command with ".br"
    Replace the ‘@*’ command with ".br"

This document is produced by invoking the following command:

    autogen -L ${prefix}/share/autogen -T agman1.tpl options.def

Where ‘`${prefix}`’ is the AutoGen installation prefix and ‘`options.def`’ is the name of your product’s option definition file. I do not use this very much, so any feedback or improvements would be greatly appreciated.

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

This document was generated by Bruce Korb on July 25, 2010 using texi2html 1.82.