doctext(1) doctext(1)

doctext - Generate documentation pages from source files

doctext [ -mpath path ] [ -ext n ] [ -I filename ] [ -latex ]
[ -html ] [ -index filename ] [ -indexdir filename ]
[ -jumpfile filename ] [ -outfile filename ]
[ -mapref filename ] [ -nolocation ] [ -location ]
[ -defn defnfile ] [ -dosnl ] [ -skipprefix name ]
[ -ignore string ] [ -oldargstyle ]
[ -heading string ] [ -basedir dirname ] filenames
[ -Wargdesc ] [ -Wnone ]

- Sets the path where the man pages will be written
- Sets the extension (1-9,l, etc)
- Don't give the filename where the man page info was
- Filename contains the public includes needed by these routines
- Generate latex output rather than man format files
- Generate html (WWW) output rather than man format files
- Generate man (nroff) output (default)
- Generate a index file appropriate for tohtml (for generating WWW files)
- Read commands from this file after loading the default commands
- Read hyperlink database and apply to output
- Sets the root directory for the index file entries. For example
-index foo.cit -indexdir \"http://www.mcs.anl.gov/foo/man\"
- Put the manpages in the indicated file
- Name for the heading (middle of top line)
- support '\\tt' and `\\em`
- Allow multiple '. ' for an argument list, instead of using '+ .... -' for argument lists with multiple entries.
- skip 'name' at the beginning of each line. This may be used for Fortran or Shell sources
- skip 'name' in a function synopsis. This can be used to remove special keywords needed to build the routine but not needed by the user (e.g., special export keywords when building DLLs)
- Place keyword entries at the end of the specified file
- Uses directory in the Location: field
- Generate DOS style files (return-newline instead of newline)
- Names of the files from which documents are to be extracted
- Warn about arguments with no description
- Turn off warnings

doctext.cc

6/23/2019