Tornado

Tornado 2.0
User’s Guide
-category
Related to the -book option, this option allows you to set the
documented routine or library category. It can be used for
example to differentiate routines available for different host
platforms.
-config configname Reads configuration information from the file configname if this
optional parameter is present; the default configuration is
C2html.
-cpp
This option specifies that the list of given files is to be treated as
C++ files. Special processing is then done to recover all the class
members.
-expath pathList
Preempts EXPANDPATH settings recorded within files with the
explicitly-supplied colon-delimited path list.
-exbase basedir
To simplify working under incomplete trees, uses basedir rather
than WIND_BASE as the root for expand-file searching.
-int
If this optional parameter is present, formats all available
documentation, even if marked INTERNAL or NOMANUAL,
and even for local routines.
-l logFile Specifies that logFile is to be used to log refgen errors. If -l
option is not specified, standard output is used.
-mg
Converts from mangen markup “on the fly” (in memory,
without saving the converted source file).
-out outputDirectoryName Saves output documentation file in outputDirectoryName.
-verbose
Prints reassuring messages to indicate something is happening.
sourceFileList
Any other parameters are taken as names of source files from
which to extract and format documentation.
EXAMPLE
INCLUDES
SEE ALSO
Generate HTML manual pages for a BSP sysLib.c file:
% cd $WIND_BASE/target/config/myBsp
% refgen -mg -book BSP_Reference -chapter myBsp -category myBsp \
-out $WIND_BASE/vxworks/bsp/myBsp sysLib.c
refLib.tcl
VxWorks Programmer’s Guide: C Coding Conventions, htmlLink, htmlBook, windHelpLib
462