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

8.9 Automated `Invoking Info' Doc

Using the option definitions for an AutoOpt client program, the `aginfo.tpl' template will produce texinfo text that documents the invocation of your program. The text emitted is designed to be included in the full texinfo document for your product. It is not a stand-alone document. The usage text for the 5.1 autogen usage help (-?), 9.5.1 getdefs usage help and 9.4.1 columns usage help (-?) programs, are included in this document and are all generated using this template.

Two files will be produced, a `.texi' file and a `.menu' file. You should include the `.menu' file in your document where you wish to reference the `invoking' chapter, section or subsection. The documentation level is selected by passing a `-DLEVEL=<level-name>' argument to AutoGen when you build the document. (See the example invocation below.)

The `.texi' file will contain an introductory paragraph, a menu and a subordinate section for the invocation usage and for each documented option. The introductory paragraph is normally the boiler plate text:

 
This chapter documents the @file{AutoOpts} generated usage text
and option meanings for the @file{your-program} program.

However, if your program's option definitions include a `prog-info-descrip' section, then that is what will be used instead.

These files are produced by invoking the following command:

 
AutoGen -L ${prefix}/share/autogen -T aginfo.tpl \
        -DLEVEL=section your-opts.def

Where `${prefix}' is the AutoGen installation prefix and `your-opts.def' is the name of your product's option definition file.



This document was generated by Davide on March, 6 2002 using texi2html