Syntax conventions

For IPCS subcommands, IPCS primary commands, IPCS line commands, and TSO/E commands, the syntax in this book uses the conventions shown in Table 1.

Note: The defaults for the SETDEF-defined parameters are not shown in each subcommand syntax diagram because they are individually set by each IPCS user. Unless a special situation is noted for a particular subcommand, see SETDEF subcommand — set defaults for an explanation of each SETDEF-defined parameter.
Table 1. Summary of IPCS syntax conventions
Notation Meaning Syntax example Sample entry
UPPERCASE Uppercase indicates the item must be entered using the characters shown. Enter the item in either uppercase or lowercase. SUMMARY KEYFIELD summary keyfield
lowercase Lowercase indicates a variable item. Substitute your own value for the item. LENGTH(length) length(24)
  ‘   ’ Apostrophes indicate a parameter string. Enter the apostrophes as shown. VERBX VSMDATA 'parameter,parameter' verbx vsmdata 'error,global'
  (   ) Parentheses must be entered as shown. FLAG(severity) flag(info)
  {    } Single braces represent group-related items that are alternatives. You must enter exactly one of the items. { COMCHECK | COMK } comcheck
[    ] Single brackets represent single or group-related items that are optional. Enter one or none of the items. GTFTRACE [DEBUG] gtftrace 
  {    }
  {    }
  {    }
 Stacked braces represent group-related items that are alternatives. You must enter exactly one of the items. 
 { ASCBEXIT }  { pgmname }
 { ASCBX    }  { *       }
 ascbx * 
  [    ]
  [    ]
  [    ]
 Stacked brackets represent group-related items that are optional. Enter one or none of the items. 
 [ TERMINAL   ]
 [ NOTERMINAL ]
 terminal
  ____ Underscore indicates a default option. If you select an underscored alternative, you need not specify it when you enter the command. 
SCAN  [ SUMMARY   ]
      [ NOSUMMARY ]
 scan
   | Or-sign 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. RDCM[(ALL | LIST | address)] rdcm(all)
   … Ellipsis indicates that the preceding item or group of items can be repeated one or more times. SUB((subname[.subname]...)) sub((sub1. func2.svc3))
Parent topic: Introduction