How to read a syntax diagram
The format of the syntax diagram is as follows:
- Text in UPPER CASE (such as
BROWSE
) must be entered exactly as shown. - Text in mixed UPPER and lower case (such as
FILter
) indicates a command or operand that can be abbreviated. The UPPER CASE text is required, and the lower case text is optional. (For example,FILter
can be entered asFIL
,FILT
,FILTE
, andFILTER
, but not asFI
, since theL
is required.) - Text in italics (such as DSNpatt), possibly containing hyphens (such as member_name), represents information you enter. What you should enter is explained under the syntax diagram.
- A common element of a syntax diagram is a vertical stack of choices: In this case you must enter one of these choices; CHOICE1, CHOICE2 or CHOICE3.
- A variation of this choice stack is when several elements are listed vertically below a horizontal line, like this: In this case, you can choose one element, but the choice is optional—you don't have to choose any element.
- A further variation is when several elements are listed vertically, below a horizontal line, and one element is above the horizontal line, such as: In this case you can choose one element, but if you choose none, then the default option, which is the option above the line (CHOICE1), is the value used. You can supply the default value if you wish.
- The final variation on the choice stack is when there is a return loop: In this case you can choose more than one element. So, for example, you could choose CHOICE1 and CHOICE2, or CHOICE3 and CHOICE1 (the order isn't important), or just CHOICE2. The item in the return loop is the delimiter used to separate out the choices. If there is a limit to the number of choices you can make, this is noted in the diagram or with the associated description of the operands.