Skip to content

ZHelp

ZHelp

The ZHELP command accesses the help information from the GTM help library or from any help library specified in the command argument.

The format of the ZHELP command is:

ZH[ELP][:tvexpr] [expr1[:expr2],...]
  • The optional truth-valued expression immediately following the command is a command postconditional that controls whether or not GT.M executes the command.
  • The optional first expression specifies the help topic.
  • If ZHELP has no argument or expr1="", ZHELP invokes base level help; at least two (2) spaces must follow a ZHELP command with no argument to separate it from the next command on the line.
  • The optional second expression specifies the name of a Global Directory containing ^HELP.
  • If ZHELP does not specify the second expression, the Global Directory defaults to $gtm_dist/gtmhelp.gld.
  • An indirection operator and an expression atom evaluating to a list of one or more ZHELP arguments form a legal argument for a ZHELP

Examples of ZHELP

Example:

GTM>zhelp "func $data"

This lists the help for function $DATA, which is a subtopic of functions topic.

Example:

GTM>zhelp

This uses ZHELP to list all the keywords in the help library.

Example:

GTM>zhelp "ZSHOW"

This lists the help for command ZSHOW.