Appendix B. Syntax

This book uses two kinds of describing the syntax of the utilities. These are:

B.1 Reading Syntax Descriptions

All syntax descriptions in this book use a common structure as described in the following table.

Syntax Element

Description

KEYWORDS

Keywords are denoted with upper case letters. Obey the spelling. In the
actual statements or commands they can be coded in upper case or
lower case letters.

variables

All user defined values are denoted with lower case italic letters. In the
actual statements or commands they can be coded in upper case or
lower case letters.

{ }

Signifies that all, or some portion, of the code elements between the
braces are required elements. Note that the braces are not part of the
statements and must be not coded.

[ ]

Signifies that all, or some portion of the code elements between the
square brackets can optionally appear but are not required elements.
Note that the square brackets are not part of the statements and must be
not coded.

|

The OR symbol signifies that you may use only one of the code elements
or values from the possible choices. Note that the OR symbol is not part
of the statements and must be not coded.

xxx,...

Signifies that there can be more than one value in a comma delimited
list. Note that the dots are not part of the statements and must be not
coded.

xxx ...

Signifies that there can be more than one value in a blank space delimit-
ted list. Note that the dots are not part of the statements and must be not
coded.

Table 11: Reading Syntax Descriptions

B.2 Reading Syntax Diagrams

All syntax diagrams in this book (configuration statements, console commands and utilities) use a com-
mon structure as described in the following table.

Symbol

Description

Êʬ¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬

This symbol indicates the beginning of a
syntax diagram.

¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬ÊÍ

This symbol indicates the end of a syntax
diagram.

¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬Ê

This symbol indicates that the syntax
diagram is continued on the next line.

ʬ¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬

This symbol indicates that the syntax
diagram is a continuation from the pre-
vious line.

¬¬¬¬¬¬¬¬¬¬ required_element ¬¬¬¬¬¬¬¬¬¬¬

A required element (keyword or variable)
appears on the main path of the hori-
zontal line. You must specify this ele-
ment.

¬¬¬¬¬§¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬§¬¬¬¬¬

An optional element (keyword or vari-
able) appears below the main path of the
horizontal line. You may or may not
specify this element.

¬¬¬¬¬§¬¬¬¬ required_choice_1 ¬¬¬¬§¬¬¬¬¬

ª¬¬¬¬ required_choice_2 ¬¬¬¬«

A required choice (keyword or variable)
appears vertically stacked in the main
path of the horizontal line. You must
choose one of the available options.

¬¬¬¬¬§¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬§¬¬¬¬¬

ª¬¬¬¬ optional_choice_2 ¬¬¬¬«

An optional choice (keyword or variable)
appears vertically stacked below the
main path of the horizontal line. You may
choose one of the available options.