Chapter 4 287
Command Definition F-K
HELP
HELP
Accesses the help subsystem (Native Mode)
Syntax
Direct access:
HELP[{ udcname commandname[{ keyword ,ALL } ] commandfilename errormessage
programfilename function name variable name SUMMARY CLASS HELPSTUDY
EXPRESSIONS| VARIABLES | OPERATORS | FUNCTIONS } ]
Interactive (subsystem) access:
>commandname{ space or comma} [ { keyword ,ALL } ]
HELPMENU
SUMMARY
CLASS
HELP
HELPSTUDY
Parameters
<omitted> If you specify the HELP command with no parameters, you enter the help
facility subsystem in interactive mode. To return to the CI, enter E or
EXIT. Refer to "Operation Notes."
udcname Any existing UDC. To display all UDCs within a UDC file, specify the
PRINT command. Refer to commandname.
commandname Any MPE/iX command. MPE/iX displays the command name and syntax.
In addition, a list of keywords for that command is displayed.
The HELP command also provides help on UDCs, command files, or
program files. The search order is UDCs, built-in commands (MPE/iX),
command files, and then program files. The search order for UDC's is user
level, account level, and system level. The search order for command files
and program files is determined by the contents of the CI variable HPPATH.
If the user's HPPATH does not contain the name of the current group, the
user can print a command file from the current group, but cannot get help
information.
For UDCs and command files, help displays the text of the user command,
unless the file contains the NOHELP option. In those cases, the display is
suppressed. In the case of program files, help displays a header identifying
it as a program file and the fully qualified file name of the program file.
function name Any CI evaluator function, eg: FINFO
keyword One of the keywords described under the command parameter. All
commands have the following keywords:
