khelp

The khelp utility is used to generate a cross reference by function across a whole system.

Before running the utility you must first generate the raw help data by add the -m command line switch to your normal full build using kmake. This will generate an XML file with a common base name at the same directory level for each .kbin file built. It does slow down the build process significantly.

Then you can run the khelp utility which will create a temporary subdirectory of the $KBIN output directory called help containing graphics and scripts. Each of the XML files built in the compile is converted to a corresponding HTML file, at the same level, the HTML file itself broken up internally by function. Also in the $KBIN directory are some system.hh? support files for the Microsoft HtmlHelp compiler. You can then run the Microsoft help compiler hhc inside this directory to produce an indexed .CHM help file. If this file is copied to the same directory as the KCML reference manual then it will be visible from the KCML help files contents window.

The Microsoft help compiler and SDK can be downloaded from the Microsoft MSDN website, currently at this link. Assuming the install directory is on the path and that the current directory is the $KBIN directory:

kmake -b K8-ORA-7 -a -i -k -m
khelp -b K8-ORA-7
hhc system.hhp

This will build a system.chm help file in this directory. If copied to the same directory as the kcmlrefman.chm you are reading now and the other KCML developer help files, then they should all interlink and share a common contents and index. The help compiler can take a long time to index a typical system. Any errors during the build will be listed in a system.log file.

Command line switches

Exit codes

If khelp encounters an error situation it will terminate setting its exit code to one of the following:

See also:

kmake