HP 3000 Manuals

Getting Online Help with Commands [ HP 3000 Series 9X8LX Computer Systems Task Reference ] MPE/iX 5.0 Documentation


HP 3000 Series 9X8LX Computer Systems Task Reference

Getting Online Help with Commands 

The online Help Facility provides command information, syntax,
explanations of command parameters, and examples of command use for
MPE/iX commands.  Any user can use it.

To get information about MPE/iX commands 

To get information about the system, use the Help Facility.  To begin the
Help Facility, use the HELP command.

   1.  Enter HELP at the system prompt, and press Return.

            :HELP Return 

       The following Help Facility menu, HELPMENU, appears on your
       screen:
_________________________________________________________________________
|                                                                       |
|                                                                       |
|                      This is the MPE/iX Help Facility                 |
|             -------------------------------------------------         |
|      *      Enter SUMMARY, CLASS, a command name, or HELPSTUDY      * |
|             -------------------------------------------------         |
|      SUMMARY....             A summary MPE/iX commands & HELP         |
|                                                                       |
|      CLASS......             Classes of Commands                      |
|                              SESSIONS, JOBS, FILES, SUBSYSTEMS, ETC.  |
|                                                                       |
|      <command name>          COMMAND entries, by name                 |
|      <command name><keyword> COMMAND entry with keyword               |
|                              PARMS, OPERATION, EXAMPLE                |
|                                                                       |
|      HELPSTUDY               A beginner's introduction to Help        |
|                                                                       |
|      EXIT                    To leave the Help Facility               |
|                                                                       |
|                   You can use UPPERCASE or lowercase.                 |
|                                                                       |
|      >>>>>>>>>>>  The name of this screen is HELPMENU  <<<<<<<<<<<    |
|      >                                                                |
|                                                                       |
_________________________________________________________________________

            

   2.  At the Help Facility prompt (>), type in an option from the
       HELPMENU, namely SUMMARY, CLASS, a command name, a command name
       and parameter, HELPSTUDY, or EXIT.

   3.  To leave the Help Facility, type either E or EXIT. This action
       returns you to the system prompt (:).

     >EXIT Return 
     :_

Using the Help Facility tutorial 

The Help Facility has a self-paced tutorial that instructs you on its
use.  To start the tutorial, do the following:

   1.  If you are not in the Help Facility (identified by the ">"
       prompt), enter HELP Return at the system prompt.

   2.  At the Help Facility prompt, type HELPSTUDY.

            >HELPSTUDY Return 

   3.  Press Return to scroll through the HELPSTUDY screens.

   4.  Press E Return to leave the Help Facility.

To display a specific Help Facility topic 

To display a specific topic in HELPSTUDY, list the contents and select
the topic in which you are interested.

   1.  If you are not in the Help Facility (identified by the ">"
       prompt), enter HELP Return at the system prompt.

   2.  Enter CONTENTS at the Help (>) prompt.

   3.  Enter the topic that you wish to display.

   4.  Press Return to scroll through the information displays.

   5.  Press E Return to exit the Help Facility.

To list commands by classification within the Help Facility 

The Help Facility provides lists of MPE/iX commands classified by the
type of tasks performed by the commands.

   1.  If you are not in the Help Facility (identified by the ">"
       prompt), enter HELP Return at the system prompt.

   2.  Enter CLASS to display command classifications.

   3.  Press Return to scroll through the display.

   4.  Press E Return to exit the Help Facility.

To display command information within the Help Facility 

To get information about a specific command, type HELP and the name of
the command at the system prompt.  Keywords allow you to limit the amount
of information and display only the details that are of interest to you.

   1.  If you are not in the Help Facility (identified by the ">"
       prompt), enter HELP Return at the system prompt.

   2.  Enter the command name and an optional keyword at the Help
       Facility prompt (>).

       Select the keyword from this list:

          a.  PARMS lists all parameters for the command and describes
              each one.

          b.  OPERATION provides an explanation of how the command works
              and when to use it.

          c.  EXAMPLE offers examples of the command and its parameters.

       For example, to see how the command SHOWME works, type the
       following:

            >SHOWME OPERATION Return 

   3.  Press Return to scroll through the display.

   4.  Press E Return to exit the Help Facility.

To display Help outside the Help Facility 

If you know what type of information that you are looking for, you can
access it directly from the system prompt by specifying the details in
your Help request.

   1.  From the system prompt, enter HELP followed by the command name,
       followed by an optional keyword (PARMS, OPERATION, or EXAMPLE).

   2.  Press Return.

The following uses the SHOWTIME command as an example:
_________________________________________________
|                                               |
|                                               |
|      :HELP SHOWTIME EXAMPLE Return            |
|      EXAMPLE                                  |
|                                               |
|           To display the time and date, enter |
|                                               |
|                                               |
|           SHOWTIME                            |
|           WED, JUL 24, 1993, 8:47AM           |
|                                               |
|      KEYWORDS: PARM,OPERATION,EXAMPLE         |
|      :                                        |
|                                               |
_________________________________________________

            

You are returned to the system prompt after this display.  Requesting
help directly at the system prompt provides quicker help access if you
know the command name that you want help on.

To display Help from within another program 

You do not need to leave a program to get help.  Most of HP's programs
allow Help requests from within the program.

   1.  Precede the HELP command with a colon (:).

   2.  Enter the HELP command followed by the command name and optional
       keyword.

   3.  Press Return or Enter.

   4.  Continue work within the program at the program prompt.

In the following example, the user requests a display of the SHOWJOB
command parameters from within the EDIT/3000 program.  The "/" prompt is
unique to the EDIT/3000 program.  Without including the colon (:)  before
the HELP command here, the program would expect one of its subcommands.

Example:

     /:HELP SHOWJOB PARMS Return 



MPE/iX 5.0 Documentation