ConvertBot: gives an explanation of a Midas command

2020-04-27T22:04:58Z

gives an explanation of a Midas command

New page

gives an explanation of a Midas command
<pre>
<name> - Name of Midas command (or its abbreviation)
<section> - Section of explain file to view (optional)

EXPLAIN outputs information about the calling sequence and performance of the
specified command. The explanation will be shown a page at a time; when the
screen fills, you are prompted to press Return for more. You can also press Q
at this prompt, to quit without seeing the rest of the explanation.

EXPLAIN assumes an explain file for the command has been written and placed in
the EXP area.

The <section> may be one of FUNCTIONS, MESSAGES, EXAMPLES, SWITCHES, SEEALSO or
any <NAME:> heading that is left aligned. If it is not one of these, then it
may be a name in the FUNCTIONS section.

If <section> is left blank the entire explain file is viewed. If section is
"SeeAlso" the "See Also" section is displayed.

There are 4 predefined sections: "Messages", "Switches", "See Also" and
"Examples". Each of which begins with the name of the section followed by a
colon (e.g. "Switches:") and continues as long as the text is indented below it.
Please see the PLOT;SYS explain file for an example.

Examples:
1. Display the entire explain file for the PLOT command:
nM> EXPLAIN PLOT

2. Display only the switches that can be used with PLOT:
nM> EXPLAIN PLOT SWITCHES

3. Display only the switches that can be used with PLOT:
nM> EXPLAIN PLOT SWITCHES

4. Display the PADX function in the SEDIT explain file
nM> EXPLAIN SEDIT PADX

5. Check this explain file for missing parameters
nM> EXPLAIN EXPLAIN /CHECK /OUT=nummissing

Switches:
/CHECK - Check existing explain file for missing parameters or switches.
/GEN - Generate an explain file (use /NEW to overwrite an existing one)
/NEW - Force overwrite of existing explain file when using /GEN
/NR=n - Number of rows output to screen for more filter.
/OUT=res - Output results name to hold number of missing parameters in
/CHECK mode.
/VERBOSE - Enable more screen output [DEF=FALSE]
/WARN - Issues warnings [DEF=TRUE]

</pre>

[[Category:NXM_Explain]]

EXPLAIN - Revision history

ConvertBot: gives an explanation of a Midas command