[ShCommands Return to command index]

== help utility ==

'''command''': HELP [<cmds>]

Displays help information about seismic handler commands. It is possible to get a directory of all commands available ([ShHelp HELP]/DIR), a command menu with short catchwords ([ShHelp HELP]/KEY), a list of lines containing command verb and its parameters ([ShHelp HELP]/CALL) or detailed information about one or more commands specified by <cmds> (without qualifier).

=== parameters ===

 * <cmds> ''parameter type: string''[[BR]]
   Name of command or wild card expression ("*" is wild card for arbitrary text). The HELP command without parameter is equivalent to the command "[ShHelp HELP]/DIR *", it displays the directory of all help items available.

=== qualifiers ===

 * /dir[[BR]]
   Displays all command verbs matching the wild card expression <cmds>. The HELP command without any parameter is equivalent to "[ShHelp HELP]/DIR *".

 * /call[[BR]]
   Displays all commands matching the wild card expression <cmds> with their parameter lists (without description of parameters).

 * /key[[BR]]
   Displays a menu of commands matching the wild card expression <cmds> with a very short description of the command.

=== examples ===

 `help`::
 displays a list of all available command verbs

 `help FILTER`::
 displays the whole information about the FILTER command

 `help FIL*`::
 displays the whole information about all commands beginning with "FIL"

 `help/key`::
 displays a list of all available command verbs with catch words

 `help/key FIL*`::
 same as above restricted to commands beginning with "FIL"

 `help/dir FIL*`::
 list of all command verbs beginning with "FIL"

 `help/dir *`::
 equivalent to plain "HELP"

 `help/call`::
 displays all available commands with parameter list

 `help/call FIL*`::
 displays commands beginning with "FIL" with parameter list