The Khoros manual file must be written in a roff format. There are some special roff commands that kgenmanual will search for and process. The resulting roff file must then be processed by eqn, tbl and Xroff, where Xroff might be groff, psroff, eroff, etc. Khoros has a complete make system for formatting and printing documentation.
Special roff Commands
.so
The .so command is a normal roff command, but kgenmanual will expand the
path so that the correct file is included. It is recommended that a full
path is not specified It is recommended that a full
path is not specified.
Syntax: .so {filename}, where the filename can be of the form
$TOOLBOX_NAME/path/file, or ../path/file or ./file.
.function
The .function command will include a library function
description in the document. This is real handy for documenting libray. To
include the appropriate function headers within the document, it is
necessary to specify the library object name, and the fuction to include.
Syntax: .function {library object name} {function name}
.help
The .help command is used to include online help files into a printed
manual. This is a nice function for reuse of documentation. The starting
section number must be specified and the path to the file to include
must be specified. Since the convention when writing documentation
is to use the .NH {section level} macro, it is important to have the
ability to set the starting {section level} when including an online help.
For example, in the online help page the section levels specified are
probably level 1. In the written documentation the online might need
to be included as a level 2. The .help command allows this to be specified.
Syntax: .help {section level} {filename}, where the filename can be of the form
$TOOLBOX_NAME/path/file, or ../path/file.
.PSPIC
The .PSPIC command will allow the inclusion of postscript files into the
document. Note, this function only works with groff. The postscript file
that will be included must be encapsulated postscript. The filename and
optionally the width and height in inches can be specified.
Syntax: .PSPIC {filename} {width} {height}, where the filename can be
of the form $TOOLBOX_NAME/path/file, or ../path/file, and width and
height are specifed in inches.
look at one of the chapters in $KHOROS/manual/ToolboxProg for an example and consult the Programmer's Volume, Chapter 6, Writing Documetation.