AutoGen: 7.12 Automated Info Docs

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

## 7.12 Automated Info Docs

AutoOpts provides two templates for producing ``.texi'` documentation. ``aginfo.tpl'` for the invoking section, and ``aginfo3.tpl'` for describing exported library functions and macros.

For both types of documents, the documentation level is selected by passing a ``-DLEVEL=<level-name>'` argument to AutoGen when you build the document. (See the example invocation below.)

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 ``.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, along the lines of:

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

or:

    These are the publicly exported procedures from the libname library.
    Any other functions mentioned in the header file are for the private use
    of the library.

This document was generated by Bruce Korb on January, 8 2006 using texi2html 1.76.