Using This Reference › How You Interpret Syntax Diagrams

How You Interpret Syntax Diagrams

The following legend has been provided to help you read the syntax diagrams provided for each command:

ALL UPPERCASE or all lowercase

Identifies control verbs, object identifiers, and arguments that must be exactly as shown.

Note: Whether you use all uppercase or all lowercase depends on which platform you are documenting.

MIXed Case

Identifies abbreviations. The uppercase letters are the minimum abbreviation; lowercase letters are optional.

lowercase italics

Identifies a value that you must supply.

[ ] Brackets

Identifies optional arguments. Brackets are put around each argument. Multiple arguments are separated by a space.

{ } Braces

Identifies required arguments among multiple arguments. Braces are put around each argument. Multiple arguments are separated by a space.

Underlined Text

Indicates default values.

|

Separates alternative arguments (choose one).

...

Indicates that the preceding items or group of items can be repeated.