How to read syntax conventions

This topic describes how to read syntax conventions. It defines syntax notations and provides syntax examples that contain these items.

Note: When running a command, specify command parameters in the order in which they are shown in the command syntax diagram.
Table 1. Syntax conventions
Notation Meaning Syntax example Sample entry
Apostrophes Apostrophes indicate a parameter string and must be entered as shown. 
SEND 'message',NOW
 
SEND 'listings ready',NOW
Comma Commas must be entered as shown. 
DISPLAY C,K
 
DISPLAY C,K
Ellipsis ... Ellipsis indicates that the preceding item or group of items can be repeated one or more times. Do not enter the ellipsis. 
VARY (devspec[,devspec]...),ONLINE
 
VARY (282,283,287),ONLINE
Parentheses and special characters Parentheses and special characters must be entered as shown. 
DUMP COMM=(text)
 
DUMP COMM=(PAYROLL)
Underline Underline indicates a default option. If you select an underlined alternative, you do not have to specify it when you enter the command. 
K M[,AMRF={Y | N}] |,REF
K M
Lowercase parameter Lowercase indicates a variable term. Substitute your own value for the item. 
MOUNT devnum
 
MOUNT A30
or 
mount a30
Uppercase parameter Uppercase indicates the item must be entered using the characters shown. Enter the item in either upper or lowercase. 
DISPLAY SMF
 
DISPLAY SMF
or 
display smf
Single brackets Single brackets represent single or group-related items that are optional. Enter one or none of these items. 
DISPLAY SLIP[=xxxx]
 
DISPLAY SLIP=W292
Stacked brackets Stacked brackets represent group-related items that are optional. Enter one or none of these items. 
[TERMINAL]
[NOTERMINAL]
 
NOTERMINAL
Single braces Single braces represent group-related items that are alternatives. You must enter one of the items. You cannot enter more than one. 
{COMCHECK | COMK}
 
COMK
Stacked braces Stacked braces represent group related items that are alternatives. You must enter one of the items. You cannot enter more than one. 
MN  {DSNAME}
    {SPACE }
    {STATUS}
 
MN SPACE
Or-bar (|) An or-bar indicates a mutually exclusive choice. When used with brackets, enter one or none of the items. When used with braces, you must enter one of the items. 
ACTIVATE RECOVER=SOURCE | TARGET
 
ACTIVATE RECOVER=SOURCE
Stacked items with or-bars (|) and brackets Stacked items with or-bars indicates a mutually-exclusive choice. Enter one or none of these items. 
CD RESET [ ,SDUMP    ]
          |,SYSABEND
          |,SYSUDUMP
          |,SYSMDUMP
          |,ALL
 
CD RESET,SYSUDUMP
Parent topic: Command syntax notation