How to read the TSO/E command syntax

Throughout this information, syntax of the whole command is described using the structure defined later in this topic.

Read the syntax diagrams from left to right, from top to bottom, following the path of the line.

Double arrows indicate the beginning and ending of a statement.


>>-STATEMENT---------------------------------------------------><

If a statement syntax requires more than one line to be shown, single arrows indicate their continuation.


>>-STATEMENT--…………--…………--…………--…………---------------------------->

>--…………--…………--…………--…………--………---------------------------------><

Required items appear on the horizontal line (the main path).


>>-STATEMENT--required_item------------------------------------><

Optional items appear below the main path.


>>-STATEMENT--+---------------+--------------------------------><
              '-optional_item-'

If you can choose from two or more items, they are stacked vertically.

If you must choose one of the items, an item of the stack appears on the main path.


>>-STATEMENT--+-required_choice_1-+----------------------------><
              '-required_choice_2-'

If choosing one of the items is optional, the entire stack appears below the main path.


>>-STATEMENT--+-------------------+----------------------------><
              +-optional_choice_1-+   
              '-optional_choice_2-'

An arrow returning to the left above the main line indicates an item that can be repeated.


              .-----------------.   
              V                 |   
>>-STATEMENT----repeatable_item-+------------------------------><

A repeat arrow above a stack indicates that you can make more than one choice from the stacked items, or repeat a single choice.


              .-----------------------.   
              V                       |   
>>-STATEMENT----+-repeatable_item_1-+-+------------------------><
                '-repeatable_item_2-'

Default values appear above the main path. For example, if you choose neither choice_2 nor choice_3, choice_1 is assumed. (Defaults can be coded for clarity reasons.)


              .-choice_1-.   
>>-STATEMENT--+----------+-------------------------------------><
              +-choice_2-+   
              '-choice_3-'

If a syntax diagram becomes too large or too complex to be printed or shown, fragments of it are shown below the main diagram as details.


>>---STATEMENT----required_variable----------------------------->

>--+--------------------------+--|  |--------------------------><
   '-'--optional_parameter--'-'         

FRAGMENT

|--OPERAND--+--------------------+--+--------------------+------>
            +-optional_choice_1a-+  +-optional_choice_2a-+   
            '-optional_choice_1b-'  '-optional_choice_2b-'   

>--+--------------------+--+--------------------+---------------|
   +-optional_choice_3a-+  +-optional_choice_4a-+   
   '-optional_choice_3b-'  '-optional_choice_4b-'

The previous syntax diagram is equivalent to the following diagram:


>>---STATEMENT----required_variable--+----------------------+--->
                                     '-'optional_parameter'-'   

>--OPERAND--+--------------------+--+--------------------+------>
            +-optional_choice_1a-+  +-optional_choice_2a-+   
            '-optional_choice_1b-'  '-optional_choice_2b-'   

>--+--------------------+--+--------------------+--------------><
   +-optional_choice_3a-+  +-optional_choice_4a-+   
   '-optional_choice_3b-'  '-optional_choice_4b-'

Keywords appear in uppercase (for example, PARM1). They can be spelled exactly as shown, but they can be in mixed or lower case. Variables appear in all lowercase letters (for example, parmx). They represent user-supplied names or values.

If punctuation marks, parentheses, arithmetic operators, or such symbols are shown, they must be entered as part of the syntax.