Previous Next Chapter

HELP command

Purpose:

This command can be used to open the online help and to obtain information on the supported menus, commands and command parameters.

Format:

HELP [COMMAND <Command name>] [MENUS] [PROMPT]

Template:

HELP COMMAND/K,MENUS/S,PROMPT/S

Parameters:

COMMAND

Name of the command whose command template should be retrieved.

MENUS

Specify this parameter to retrieve a list of menu items currently available.

PROMPT

Specify this parameter to invoke the online help system.

If no parameter is provided, a list of supported commands will be returned.

Errors:

10 - If the named command is not supported by the ARexx interface. The error code will be placed in the WORKBENCH.LASTERROR variable.

Result:

RESULT

The command template, list of menu items or commands, as specified in the command parameters.

Example:

/* Retrieve the list of supported commands. */
ADDRESS workbench
OPTIONS results

HELP
SAY result

/* Retrieve the command template of the `GETATTR` command. */
HELP COMMAND getattr
SAY result

/* Retrieve the list of available menu items. */
HELP MENUS
SAY result

Top Previous Next Chapter