![]() |
![]() |
This section covers syntax diagrams including descriptions and examples:
Abbreviations: Uppercase letters denote the shortest acceptable abbreviation. If an item appears entirely in uppercase letters, you cannot abbreviate the item.
You can type the item in uppercase letters, lowercase letters, or any combination. In this example, you can enter CMDNA, CMDNAM, or CMDNAME in any combination of uppercase and lowercase letters.
>>-CMDNAme-----------------------------------------------------><
Symbols: You must code these symbols exactly as they appear in the syntax diagram.
Variables: Highlighted lowercase items (like this) denote variables. In this example, var_name represents a variable you must specify when you code the CMDNAME command.
>>-CMDNAme--var_name-------------------------------------------><
Repetition: An arrow returning to the left means that the item can be repeated. A character within the arrow means that you must separate repeated items with that character.
.-,------. V | >>---repeat-+--------------------------------------------------><
A footnote (1) by the arrow refers to a limit that tells how many times the item can be repeated.
.-,-------------. V (1) | >>----------repeat-+-------------------------------------------><
Notes:
Required Choices: When two or more items are in a stack and one of them is on the line, you must specify one item.
In this example, you must choose CMDNAME=A, CMDNAME=B, or CMDNAME=C. Do not include any blanks immediately before or after the equal sign (=).
>>-CMDNAme--=--+-A-+------------------------------------------->< +-B-+ '-C-'
Optional Choices: When an item is below the line, the item is optional. In this example, you can choose CMDNAME=A or nothing at all. Do not include any blanks immediately before or after the equal sign (=).
>>-+---------------+------------------------------------------->< '-CMDNAme--=--A-'
When two or more items are in a stack below the line, all of them are optional. In this example, you can choose CMDNAME=A, CMDNAME=B, CMDNAME=C, or nothing at all. Do not include any blanks immediately before or after the equal sign (=).
>>-+-------------------+--------------------------------------->< '-CMDNAme--=--+-A-+-' +-B-+ '-C-'
Defaults: Defaults are above the line. The system uses the default unless you override it. You can override the default by coding an option from the stack below the line.
In this example, CMDNAME=A is the default. You can also code CMDNAME=A, CMDNAME=B, or CMDNAME=C. Do not include any blanks before or after the equal sign (=).
.-CMDNAme--=--A-----. >>-+-------------------+--------------------------------------->< '-CMDNAme--=--+-A-+-' +-B-+ '-C-'
Repeatable Choices: A stack of items followed by an arrow returning to the left means that you can select more than one item or, in some cases, repeat a single item. In this example, you can choose more than one value, with each name delimited with a comma. Do not include any blanks before or after the equal sign (=).
.-,----------. V | >>-CMDNAme--=----+-value1-+-+---------------------------------->< +-value2-+ '-value3-'
Syntax Fragments: Some diagrams, because of their length, must fragment the syntax. The fragment name appears between vertical bars in the diagram.
The expanded fragment appears in the diagram after all other parameters or at the bottom of the diagram. A heading with the fragment name identifies the expanded fragment. Commands appearing directly on the line are required.
In this example, the fragment is named "Fragment".
>>-| Fragment |------------------------------------------------>< Fragment .-A-. |--+---+--------------------------------------------------------| +-B-+ '-C-'