Output command syntax description
Component: | SDF |
Functional area: | SDF control |
Domain: | SDF |
Privileges: | STD-PROCESSING |
Function
The SHOW-CMD command outputs the syntax description of a command. In addition, the name and type of the employed syntax file are displayed. CMD-NAME= *ALL produces a list of all command names. Using wildcards in the command name, the user can display a list of command names which match the search pattern.
Output can be directed to either SYSOUT or to SYSLST.
The INFORMATION operand controls the scope of the syntax description. INFORMATION= *MINIMUM displays the command name, the name of the syntax file containing the syntax description, the operand names and any default values. Alternative operand values are displayed with INFORMATION=*MEDIUM, while with INFORMATION=*MAXIMUM help texts are also displayed.
The output only shows the syntax description of the assigned syntax files. In particular, task-specific default values are not displayed.
The FORM operand controls output of syntax objects whose input is not permitted in guided dialog. FORM=*UNGUIDED shows the command syntax which can also be entered in unguided dialog, or a command list which also contains aliases of the command names. Commands and operands which are not permitted in unguided dialog are indicated in the output with an asterisk (*).
The CHECK-PRIVILEGES operand determines whether the output will take account of the privileges of the user. If CHECK-PRIVILEGES=*YES is specified, the output only contains information on operands and operand values of commands which the user’s privileges allow him/her to use. If a list of command names is output, commands which the user is not authorized to use are marked with an asterisk (*).
The CHECK-INPUT-MODE operand controls the output of syntax objects which may only be input in a particular input mode. Users can thus inform themselves as to which operands and values are permissible, for example, for input in batch mode. If no input mode is specified (*NO), commands and operands for which restrictions exist as regards the input modes (interactive mode, batch mode, procedure in interactive or batch mode) are marked with an asterisk (*).
Format
SHOW-CMD | ||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||
Operands
CMD-NAME = *ALL / <structured-name 1..30 with-wild>
Name of the desired command.
CMD-NAME = *ALL
Lists all commands in alphabetical order. FORM=*UNGUIDED also displays defined aliases (in separate output lines).
CMD-NAME = <structured-name 1..30 with-wild>
Name of the command whose syntax is to be output. If you specify an alias, the real command name is displayed followed by the alias in parentheses.
If wildcards are used, all commands which match the search pattern are listed in alphabetical order. FORM=*UNGUIDED also outputs defined aliases (in separate output lines).
INFORMATION = *MINIMUM / *MEDIUM / *MAXIMUM
Determines the scope of the output. When lists of commands are output, the SIZE operand is ignored.
INFORMATION = *MINIMUM
The output contains the command names, operands and preset operand values.
INFORMATION = *MEDIUM
The output contains the command names, operands, preset operand values and alternative operand values.
INFORMATION = *MAXIMUM
The output contains the command names, operands, preset and alternative operand values and help texts.
FORM = *GUIDED / *UNGUIDED
Determines whether the syntax for guided or unguided dialog is to be output.
FORM = *GUIDED
Operands and operand values which are not allowed in guided dialog are not output.
FORM = *UNGUIDED
The output also contains operands and operand values which are not allowed in guided dialog. When lists of commands are displayed (CMD=*ALL), these also contain the aliases.
CHECK-PRIVILEGES = *YES / *NO
Specifies whether the output is to take account of the privileges of the user.
CHECK-PRIVILEGES = *YES
Information is displayed only on commands, operands and operand values which the user is authorized to use.
CHECK-PRIVILEGES = *NO
Information is displayed on all commands, operands and operand values, regardless of the user’s privileges.
CHECK-INPUT-MODE = *CURRENT / *DIALOG / *DIALOG-PROC / *BATCH / *BATCH-PROC / *NO
Determines the input mode for which the syntax is to be displayed. Only those syntax objects are displayed for the user which are permissible in the specified input mode.
CHECK-INPUT-MODE = *CURRENT
The output contains only the syntax objects permitted for the current input mode.
CHECK-INPUT-MODE = *DIALOG
The output contains only the syntax objects permitted for interactive mode.
CHECK-INPUT-MODE = *DIALOG-PROC
The output contains only the syntax objects permitted for the interactive procedure mode.
CHECK-INPUT-MODE = *BATCH
The output contains only the syntax objects permitted for batch mode.
CHECK-INPUT-MODE = *BATCH-PROC
The output contains only the syntax objects permitted for the batch procedure mode.
CHECK-INPUT-MODE = *NO
Output takes place independently of the input mode. The output lines with commands and operands which are not permitted in the current input mode are marked with an asterisk (*).
OUTPUT = *SYSOUT / *SYSLST(...)
Specifies where the information is to be output.
OUTPUT = *SYSOUT
The information is output to the system file SYSOUT.
OUTPUT = *SYSLST(...)
The information is output ready for printing to the system file SYSLST.
The first byte of each output record is X'40'. The LINES-PER-PAGES operand defines after how many output records a header line with page feed is generated.
SYSLST-NUMBER = *STD / <integer 1..99>
Specifies whether the information is to be output to the system file SYSLST or to a SYSLST file from the set SYSLST01 through SYSLST99.
The default is *STD, i.e. output is directed to the system file SYSLST.
LINES-PER-PAGE = *STD / *UNLIMITED / <integer 1..200>
Defines after how many output records a new page is to begin. Each printed page begins with a header line which contains a page-feed control character in the first byte. The header contains the name of the displayed command and the page number.
LINES-PER-PAGE = *STD
A new page begins after 55 output records.
LINES-PER-PAGE = *UNLIMITED
The output is not divided into printed pages. No header lines are output.
Return codes
(SC2) | SC1 | Maincode | Meaning/Guaranteed messages |
|---|---|---|---|
0 | CMD0001 | Command executed without errors | |
1 | 32 | CMD0500 | Syntax description in current syntax file invalid |
1 | 64 | CMD0812 | Command execution not successful. |
Examples
/show-cmd cmd=add-pass ————————————————————————————————————————————— (1)
%ADD-PASSWORD (ADD-PASS,ADPW) % FROM :2OSH:$TSOS.SYSSDF.BS2CP.190 (SYSTEM) % PASSWORD =
/show-cmd cmd=add-pass,information=max ——————————————————————————————— (2)
%ADD-PASSWORD (ADD-PASS,ADPW) % FROM :2OSH:$TSOS.SYSSDF.BS2CP.190 (SYSTEM) %Adds passwords for files or job variables to the password table of the %task % PASSWORD = % -list-possible (63)-: x-string_1..8 or c-string_1..4 or % integer_-2147483648..2147483647 % Specifies passwords to be added to the password table
/show-cmd cmd=write* ———————————————————————————————————————————————— (3)
% WRITE-ACCOUNTING-RECORD % WRITE-SPOOL-TAPE % WRITE-TEXT
(1) | The syntax of the ADD-PASSWORD command is output. |
(2) | The syntax of the ADD-PASSWORD command is output with all operands, operand values and help texts (INFORMATION=*MAXIMUM). |
(3) | All commands beginning with the string “WRITE” are output. |