next up previous contents
Next: Hyper text references Up: Help for the whole module Previous: Help for the whole module

Compiling the help file

To use the help file, you have to compile it, which is done with the command makeHelp, which is located in the Generator directory. It takes two arguments, which is the Generator directory, and your source file.

Example:
If The Dotfile Generator is installed in /usr/local, and you file is called help.html, write the following to compile it:
/usr/local/lib/Generator/makeHelp /usr/local/lib/Generator help.html
while you are standing in your modules directory. This will generate the file called generatedHelp, which is the file The Dotfile Generator is using for help.

A temporary file called helpfile.data is also generated, which is The Dotfile Generator's help file concated with your help file. You may need this file in case there's a problem with you help file, since it is due to this file, the error report is given.



Jesper Kjær Pedersen <blackie@imada.ou.dk>
Wed Oct 2 13:29:53 MET DST 1996