-HELP [ MPE Segmenter Reference Manual ] MPE/iX 5.0 Documentation
MPE Segmenter Reference Manual
-HELP
Accesses the Help subsystem.
SYNTAX
-HELP [HELP ]
[tablecontents ]
[command[,keyword] ]
[ALL ]
[EXIT ]
PARAMETERS
HELP Displays information for the HELP command. Treated the
same as entering -HELP with any other command (because
HELP is a command).
tablecontents Any of several items for which information may be
obtained. These items are:
HELPMENU
USLS
RLS
SLS
SHOW
TERMINATE
Thus, if you want information on managing USL files, you
would enter:
-HELP USLS
command Any Segmenter command. Segmenter displays the command
name and syntax. In addition, a list of keywords for
that command is displayed. Keywords for all commands
are:
PARMS
EXAMPLE
Where:
PARMS Lists all parameters of the specified
command.
EXAMPLE Displays an example showing usage of
the specified command.
Entering the command -HELP, ALL causes MPE to display
all information for that command (syntax, parameters,
and example).
keyword One of the keywords described under the command
parameter. The keyword parameter can be entered with a
command as in -HELP LISTSL,PARMS. In this case, PARMS is
a keyword and must be separated from the command with a
comma.
The keyword parameter also can be entered alone if you
are running the Help subsystem in "subsystem" mode and
have accessed a command, then received the prompt (>)
from Help.
For example,
-HELP AUXUSL
-AUXUSL
opens an auxiliary USL file for management.
SYNTAX
-AUXUSL filereference
KEYWORDS: PARMS,EXAMPLE
>PARMS (keyword entered by itself in response to prompt)
ALL Displays entire table of contents for -HELP command. If
entered with a command, as in
-HELP LISTSL,ALL
displays all information for that command.
EXIT Exits Help subsystem.
OPERATION
The -HELP command accesses the Help subsystem. If entered with no
parameters, as in:
-HELP
Help enters the "subsystem" mode, displays a table of contents, a
"greater than" (>) prompt, and awaits your input. Entering any table of
contents item such as SESSIONS produces a listing of all the commands
used in running sessions. Entering any command name produces the syntax
for that command and a list of keywords. Entering a keyword, such as
PARMS produces a listing of all items for that keyword (all parameters in
this case). Entering EXIT terminates the Help subsystem. Entering
Control-Y stops the display. Entering Control-S stops the display and
entering Control-Q resumes the display (useful if the screen in full if
using a CRT terminal).
Entering a carriage return in "subsystem" mode causes HELP to display
information up to the next keyword or command. For example, after
entering AUXUSL, HELP displays AUXUSL syntax, the keyword list (PARMS,
EXAMPLE) and prompts (>). Entering carriage return again causes HELP to
display all PARMS information for the -AUXUSL command, and so on. (This
is similar to page turning through a manual.)
Entering -HELP with a parameter causes Help to enter the "immediate"
mode. Information pertaining to that parameter is displayed immediately.
For example:
-HELP AUXUSL
causes Help to display:
-AUXUSL
Opens an auxiliary USL file for management.
SYNTAX
-AUXUSL filereference
EXAMPLE
To obtain information concerning the managing of SL files, enter:
-HELP SLS
MPE/iX 5.0 Documentation