next up previous contents
Next: Error tolerance Up: Miscellaneous commands Previous: Logging commands into a

Getting help

 

help Read the on-line help system
[<group-name> | show help about a group of commands
<command-name> | show help about a single command
<command-name>.desc | show the description of a single command
<command-name>.ex ] show an example of the use of the command

If help is executed by itself, it lists the available command groups. If a group name is provided, an alphabetical list of the commands in that group is generated. If a command name is provided on command line, the command line switch description(s) of the requested command and probably some closely related commands are listed.

To show the description of a single command .desc needs to be appended to the name of the command. There also exist some examples of the use of the commands. The example can be requested be appending .ex to <command-name>.

The help system requires, that the NDAHOME environment variable is correctly set to point into a directory containing help.txt.



Anssi Lensu
Thu May 17 15:00:44 EET DST 2001