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

7.4.6 Example option documentation

The doc clauses are used in the flag stanzas for man pages and texinfo invoking documentation. With the definition file described above, the two following commands will produce the two documentation files ‘check.1’ and ‘invoke-check.texi’. The latter file will be generated as a chapter, rather than a section or subsection.

autogen -Tagman-cmd check.def
autogen -DLEVEL=chapter -Tagtexi-cmd -binvoke-check.texi check.def

The result of which is left as an exercise for the reader.

A lot of magic happens to make this happen. The rest of this chapter will describe the myriad of option attributes supported by AutoOpts. However, keep in mind that, in general, you won’t need much more than what was described in this "quick start" section.

This document was generated by Bruce Korb on August 21, 2015 using texi2html 1.82.