How to read a syntax diagram

The syntax diagram shows you how to specify a command so that the operating system can correctly interpret what you type. Read the syntax diagram from left to right and from top to bottom, following the horizontal line (the main path).

Symbols and punctuation

The following symbols are used in syntax diagrams:

Symbol
Description
>>
Marks the beginning of the command syntax.
><
Marks the end of the command syntax.

You must include all punctuation such as colons, quotation marks, and minus signs that are shown in the syntax diagram.

Parameters

The following types of parameters are used in syntax diagrams.

Parameter
Description
Required
Required parameters are displayed on the main path.
Optional
Optional parameters are displayed below the main path.

Parameters are classified as keywords or variables. Keywords are displayed in lowercase letters and can be entered in lowercase. For example, a command name is a keyword. Variables are italicized and represent names or values you supply.

Syntax examples

In the following example, the user command is a keyword. The required variable is user_id, and the optional variable is password. Replace the variables with your own values.

Read syntax diagramSkip visual syntax diagram>>-user--user_id--+----------+---------------------------------><
                  '-password-'
 

Required keywords: required keywords and variables appear on the main path line.

Read syntax diagramSkip visual syntax diagram>>-required_keyword--------------------------------------------><
 

You must code required keywords and values.

Choose one required item from a stack: If there is more than one mutually exclusive required keyword or variable to choose from, they are stacked vertically in alphanumeric order.

Read syntax diagramSkip visual syntax diagram>>-+-required_parameter_1-+------------------------------------><
   '-required_parameter_2-'
 

Optional values: Optional keywords and variables appear below the main path line.

Read syntax diagramSkip visual syntax diagram>>-+---------+-------------------------------------------------><
   '-keyword-'
 

You can choose not to code optional keywords and variables.

Choose one optional keyword from a stack: If there is more than one mutually exclusive optional keyword or variable to choose from, they are stacked vertically in alphanumeric order below the main path line.

Read syntax diagramSkip visual syntax diagram>>-+-------------+---------------------------------------------><
   +-parameter_1-+
   '-parameter_2-'
 

Variables: A word in all italics is a variable. Where you see a variable in the syntax, you must replace it with one of its allowable names or values, as defined in the text.

Read syntax diagramSkip visual syntax diagram>>-variable----------------------------------------------------><
 

Nonalphanumeric characters: If a diagram shows a character that is not alphanumeric (such as colons, quotes, or minus signs), you must code the character as part of the syntax. In this example, you must code cluster:port.

Read syntax diagramSkip visual syntax diagram>>-cluster:port------------------------------------------------><