HELP

Syntax

   H[ELP] [command name [FU[NCTION] ] [FO[RMAT] [PA[RAMETERS] ] ] ]

For example:

   >HELP



   >HELP FORM FUNCTION 

Where command name = FORM

   >H DEFINE 

Where command name = DEFINE

Discussion

The HELP command provides a convenient on-line reference for QUERY commands. If you enter HELP, you receive a list of the QUERY commands followed by a brief description of the function of each command.

If you enter HELP command name, you receive information about the format, function, and parameters of the command, if any.

If you enter HELP command name followed by one or more of the parameters FUNCTION, FORMAT, or PARAMETERS, QUERY provides only the information you request.

HELP output is listed on the standard list device, unless OUTPUT=LP has been specified. In that case, the output is directed to the device equated to the QSLIST file. (Refer to the OUTPUT command for more information.)

In order to allow you plenty of time to read the command descriptions when using HELP in session mode, QUERY prints the following message after listing several lines.

**PRESS ANY KEY TO CONTINUE

When you finish reading the current display, press any terminal key and the listing will continue. You can use CONTROL Y to end the command description.

Examples

Example 1

You can abbreviate the HELP command and the command you are asking about.

      >H DATA-BASE



      FUNCTION -

         SPECIFY THE PRIMARY DATA BASE



      FORMAT -

         DATA-BASE= DATA BASE NAME



      PARAMETERS -

         DATA BASE NAME - NAME OF



      CONTROL Y

      < CONTROL Y >

Example 2

The order of FUNCTION, PARAMETERS, and FORMAT parameters can vary.

      >HELP OUTPUT PA FO



      PARAMETERS -

         TERM - INDICATES THAT OUTPUT SHOULD BE SENT

                TO THE DEVICE SPECIFIED AS $STDLIST

         LP   - INDICATES THAT OUTPUT SHOULD BE SENT

                TO THE FORMAL FILE DESIGNATOR 'QSLIST'



      FORMAT -

         OUTPUT= TERM/LP