Syntax diagram conventions

Use the following conventions to interpret the syntax diagrams that accompany the command references.

To read the syntax diagrams, start at the top leftmost line and read from left to right and from top to bottom. The horizontal line represents the main path of parameters that you use when you enter the commands. Parameters that are off the main path are optional and may have a default, if you omit them.

Symbols and punctuation

Syntax diagrams use the following symbols:

Symbol	Description
>>	Marks the beginning of the command syntax.
>	Indicates that the command syntax is continued.
\|	Marks the beginning and end of a fragment or part of the command syntax.
><	Marks the end of the command syntax.

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

Parameters

The following types of parameters are used in syntax diagrams:

Required: Required parameters are displayed on the main path.
Optional: Optional parameters are displayed below the main path.
Default: Default parameters are displayed above the main path.


                      .-Default_variable-.                       
>>-Required_variable--+------------------+--Optional_parameter-><

Parameters are classified as keywords or variables. You must enter keywords exactly as written in the diagram. The diagrams display variables, which are names or values you supply, in italics.

Single-line command

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


>>-USER-- -user_id-- -+----------+-----------------------------><
                      '-password-'

Multiple line commands

If a diagram is longer than one line, the first line ends with a single arrowhead and the second line begins with a single arrowhead.


>>-The first line of a syntax diagram that is longer than one line-->

>--Continues on the next line displaying any subcommands, parameters, or variables.-><

Choices

Syntax diagrams display choices of exclusive required parameters as a vertical stack starting on the main path. You must choose one of the parameters.


>>-+-Choice_1-+------------------------------------------------><
   '-Choice_2-'

Syntax diagrams display choices of exclusive optional parameters as a vertical stack below the main path.


>>-+----------+------------------------------------------------><
   +-Option_1-+   
   '-Option_2-'

Non-alphanumeric characters

You must enter all non-alphanumeric characters as shown in the syntax diagram. For example, if you must enter OPERAND=(001,0.001) the syntax diagram would display:


>>-OPERAND--=--(--001--,--0--.--001--)-------------------------><

Blank spaces

You must enter all blank spaces shown in syntax diagrams. For example, to enter OPERAND=(001 FIXED) the syntax diagram would display:


>>-OPERAND--=--(--001-- -FIXED--)------------------------------><

Default parameters

Syntax diagrams display default parameters and their values above the main path. The system uses the displayed value if you omit the parameter.


   .-Parameter=default-.   
>>-+-------------------+---------------------------------------><

Syntax fragments

Some diagrams contain syntax fragments, which serve to break up diagrams that are too long, too complex, or too repetitious. Syntax fragment names are in mixed case and are shown in the diagram and in the heading of the fragment. The fragment is placed below the main diagram.


>>-Command-- -| Operands |-------------------------------------><

Operands

|--Operand1--,--Operand2--,--Operand3---------------------------|