Command Syntax and Description Format
The command syntax is explained in the following format:
The following table explains the symbols used in syntax explanations in this chapter.
Symbol | Convention |
---|---|
| | In syntax explanations, a vertical bar separates multiple items, and has the meaning of OR. For example: A|B|C means A, or B, or C. |
{ } | In syntax explanations, curly brackets indicate that only one of the enclosed items is to be selected. If the items are arranged horizontally and separated by a vertical bar (|), select one of the items. For example: {A|B|C} means only one of A, or B, or C. |
[ ] | In syntax explanations, square brackets indicate that the enclosed item or items are optional. For example: [A] means that you can specify A or nothing. |
Italic | In syntax explanations, italic characters indicate an element that must be specified. For example: property means that you must specify a property. |
... | In coding, an ellipsis (...) indicates that one or more lines of coding have been omitted. For example: ABC ... means that the coding after ABC has been omitted. |
~ | In syntax explanations, a swung dash (~) indicates that the items preceding the swung dash comply with the rules mentioned in < >, (( )), and << >> following the swung dash. |
< > | In syntax explanations, angle brackets indicate the syntax elements that must be complied with when items are coded. For details on syntax elements, see the following table. |
(( )) | In syntax explanations, double-parentheses indicate the range of values that you can specify for an item. |
<< >> | In syntax explanations, double-angle brackets indicate the default value that the system assumes when an item is omitted. |
The following table lists the types and definitions of the syntax elements used in this chapter.
Type | Definition |
---|---|
Alphabetic characters | A to Z, a to z |
Lowercase alphabetic characters | a to z |
Uppercase alphabetic characters | A to Z |
Numeric characters | 0 to 9 |
Alphanumeric characters | A to Z, a to z, 0 to 9 |
Symbols | _, ., - |
Character string | An array of strings |