Rational Developer for System z
Enterprise PL/I for z/OS, Version 3.8, Programming Guide

How to read the syntax notation

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.
>>---
Indicates the beginning of a statement.
--->
Indicates that the statement syntax is continued on the next line.
>---
Indicates that a statement is continued from the previous line.
---><
Indicates the end of a statement.

Diagrams of syntactical units other than complete statements start with the >--- symbol and end with the ---> symbol.

Conventions
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-'
 

If an optional item appears above the main path, that item has no effect on the execution of the statement and is used only for readability.

Read syntax diagramSkip visual syntax diagram                  .-optional_item-.
>>-REQUIRED_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_ITEM--+-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>>-REQUIRED_ITEM--+------------------+-------------------------><
                  +-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                 |
>>-REQUIRED_ITEM----repeatable_item-+--------------------------><
 

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

Read syntax diagramSkip visual syntax diagram                  .-,---------------.
                  V                 |
>>-REQUIRED_ITEM----repeatable_item-+--------------------------><
 

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

Default keywords
IBM-supplied default keywords 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--.
>>-REQUIRED_ITEM--+-----------------+--------------------------><
                  +-optional_choice-+
                  '-optional_choice-'
 
Fragments
Sometimes a diagram must be split into fragments. The fragments are represented by a letter or fragment name, set off like this: | A |. The fragment follows the end of the main diagram. The following example shows the use of a fragment.
Read syntax diagramSkip visual syntax diagram>>-STATEMENT--item 1--item 2--| A |----------------------------><
 
A:
 
|--+-item 3-+--KEYWORD--+--------+------------------------------|
   '-item 4-'           +-item 5-+
                        '-item 6-'
 
Substitution-block
Sometimes a set of several parameters is represented by a substitution-block such as <A>. For example, in the imaginary /VERB command you could enter /VERB LINE 1, /VERB EITHER LINE 1, or /VERB OR LINE 1.
Read syntax diagramSkip visual syntax diagram>>-/VERB--+-----+--LINE--line#---------------------------------><
          '-<A>-'
 

where <A> is:

Read syntax diagramSkip visual syntax diagram>>-+-EITHER-+--------------------------------------------------><
   '-OR-----'
 
Parameter endings
Parameters with number values end with the symbol '#', parameters that are names end with 'name', and parameters that can be generic end with '*'.
Read syntax diagramSkip visual syntax diagram>>-/MSVERIFY--+-MSNAME--msname-+-------------------------------><
              '-SYSID--sysid#--'
 

The MSNAME keyword in the example supports a name value and the SYSID keyword supports a number value.


Terms of use | Feedback

This information center is powered by Eclipse technology. (http://www.eclipse.org)