How to read syntax diagrams

The following rules apply to the syntax diagrams used in this book:

Arrow symbols
Read the syntax diagrams from left to right, from top to bottom, following the path of the line.
Conventions
  • Variables appear in italics (for example, column-name). They represent user-defined parameters or suboptions.
  • When entering commands, separate parameters and keywords by at least one blank if there is no intervening punctuation.
  • Enter punctuation marks (slashes, commas, periods, parentheses, quotation marks, equal signs) and numbers exactly as given.
  • Footnotes are shown by a number in parentheses, for example, (1).
  • A ␢ symbol indicates one blank position.
Required items
Required items appear on the horizontal line (the main path).
Read syntax diagramSkip visual syntax diagram
>>-REQUIRED-ITEM-----------------------------------------------><

Optional items
Optional items appear below the main path.
Read syntax diagramSkip visual syntax diagram
>>-REQUIRED-ITEM--+---------------+----------------------------><
                  '-optional-item-'   

Multiple required or optional items
If you can choose from two or more items, they appear vertically in a stack. If you must choose one of the items, one item of the stack appears on the main path.
Read syntax diagramSkip visual syntax diagram
>>-+-required-choice1-+----------------------------------------><
   '-required-choice2-'   

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

Read syntax diagramSkip visual syntax diagram
>>-+------------------+----------------------------------------><
   +-optional-choice1-+   
   '-optional-choice2-'   

Repeatable items
An arrow returning to the left above the main line indicates that an item can be repeated.
Read syntax diagramSkip visual syntax diagram
   .-----------------.   
   V                 |   
>>---repeatable-item-+-----------------------------------------><

If the repeat arrow contains a comma, you must separate repeated items with a comma.

Read syntax diagramSkip visual syntax diagram
   .-,---------------.   
   V                 |   
>>---repeatable-item-+-----------------------------------------><

A repeat arrow above a stack indicates that you can specify more than one of the choices in the stack.

Default items
IBM-supplied defaults appear above the main path, and the remaining choices are shown below the main path. In the parameter list following the syntax diagram, the default choices are underlined.
Read syntax diagramSkip visual syntax diagram
   .-default-choice---.   
>>-+------------------+----------------------------------------><
   +-optional-choice1-+   
   '-optional-choice2-'   


Information Information

Feedback


Timestamp icon Last updated: Friday, 7 February 2014


http://pic.dhe.ibm.com/infocenter/cicsts/v5r1/topic///ccv-about-syntax-diagrams.htm