SUPPORT commands


PROGRAM NAME

kgenman - generate man page(s) for a software object

DESCRIPTION

This program parses a khoros public routine header for information, and generates a man 3 page for the public library routine. This routine takes a as input the library object the user wants man 3 pages for, and creates all the man 3 files for every public routine in a single file, or in the whole library. It then installs the man page in the directory of choice, or the final installation directory in $TOOLBOX/man/object_name/man.

Note, all the information stored between the lines ".SH ADDITIONAL INFO" and ".SH SIDE EFFECTS" is saved and propagated to the new man page. Thus, the user can put extra information in this section of the man page, such as an example section, if desired.

This program will detect when headers have missing fields, and recover gracefully. If a field is missing, it will indicate which field, routine, and filename the error occurred in, and continue on with that field left empty. Therefore, it is the programmers responsibility to fix the header, and re-run kgenman on that file, so that the man page will be complete.

The example field below has an example of the public header along with an explaination of each field that goes in it.

REQUIRED ARGUMENTS

-tb
type: string
desc: toolbox the library belongs to
-lib
type: string
desc: library to generate man pages for

Mutually Exclusive Group; you must specify ONE of:

-dir
type: string
desc: generate and install in the directory specified
default: .
OR
-install
type: flag
desc: Install the man pages in $TOOLBOX/man/man3
OR
-list
type: flag
desc: List the man pages rather than generate them

Mutually Exclusive Group; you must specify ONE of:

-all
type: flag
desc: create man pages for all src in the library object
OR
-i
type: string
desc: input source code file
default: {none}

OPTIONAL ARGUMENTS

-section
type: string
desc: Man section to put the man page into
default: {none}

EXAMPLES

SEE ALSO

RESTRICTIONS

REFERENCES

COPYRIGHT

Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.