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.
Mutually Exclusive Group; you must specify ONE of:
OR
OR
Mutually Exclusive Group; you must specify ONE of:
OR