Symbol

Description

ª¬¬¬ SEGMENT= ¬¬¬§¬¬¬ value_1 ¬¬¬§¬¬¬«

value 2 ¬¬¬¯

This symbol indicates a syntax segment
which is referenced from a main syntax
diagram that is shown above the syntax
segment.

KEYWORDS

Keywords are denoted with upper case
letters. Obey the spelling. Lower case
letters are optional and can be omitted
(for example DISable). In the actual
statements or commands the keywords
can be coded in upper case or lower
case letters.

variables

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

Table 12: Reading Syntax Diagrams

B.3 Sample Syntax Description

The following figure shows a sample of a complex syntax description. This is not an example of an exis-
ting system parameter or panel command. It is used mainly to demonstrate the “look and feel” of syntax
descriptions.

Syntax

CMDNAME required argument [optional argument]

{required choice 1 |
required choice 2 |
required choice }

[optional choice 1 |
optional choice 2]

REQUIRED KEYWORD=variable

[OPTIONAL KEYWORD=variable]

[DEFAULT KEYW
ORD | KEYW
ORD 1 | KEYWORD 2]

[KEYWORD=default choice | KEY
WORD={choice 1 | choice 2}]

repeatable item n
{repeatable item n ...}

repeatable item n
{,repeatable item n ,...}

fragment name

(variable 1, variable 2)

fragment_name

[DEFAULT KEYWORD | KE
YWORD 1 | KEYWORD 2 | KEYWORD 4]

KEYWORD={choice 1 |
choice 2
|
choice |
choice 4}

Figure 69: Sample Syntax Description

B.4 Sample Syntax Diagram

The next figure shows a sample of a complex syntax diagram. It shows the same example as in the
syntax description in the previous section. Like in the example before it is not based on an existing
system parameter or panel command. It is used mainly to demonstrate the “look and feel” of syntax
descriptions.

Syntax

Êʬ¬¬ CMDNAME ¬¬¬ required argument ¬¬¬§¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬§¬¬¬¬¬¬¬¬¬¬¬Ê

optional argument ¬¬¬¯

ʬ¬¬§¬¬¬ required choice 1 ¬¬¬§¬¬¬§¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬§¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬Ê

ª¬¬¬ required choice 2 ¬¬¬«
ª¬¬¬
optional choice 1 ¬¬¬«

required choice optional choice 2 ¬¬¬¯

ʬ¬¬ REQUIRED KEYWORD=variable ¬¬¬§¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬§¬¬¬¬¬¬¬¬Ê

KEYWORD=variable ¬¬¬¯

default choice ¬¬¬¬¬¬®

ʬ¬¬¦¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¦¬¬¬¦¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¦¬¬¬¬¬¬¬¬¬ÊÍ

ª¬¬¬¬¬¬ KEYWORD 1 ¬¬¬¬¬¬« ¬¬¬§¬¬¬ choice 1 ¬¬¬«

¬¬¬¬¬¬ KEYWORD 2 ¬¬¬¬¬¬choice 2 ¬¬¬¯

repeatable item n repeatable item n ¬¬¬¨¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬Ê

ʬ¬¬« fra
gment name ª¬¬¬ (
¬¬¬ variable 1 ¬¬¬ ,
¬¬¬ variable 2 ¬¬¬ ) ¬¬¬¬¬¬¬¬Ê

fragment_name

KEYWORD ¬¬¬®

ª¬¬¬¦¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¬¦¬¬¬ KEYW
ORD= ¬¬¬§¬¬¬ choice 1 ¬¬¬§¬¬¬¬¬¬¬¬¬¬¬¬¬¬«

ª¬¬¬¬¬¬ KEYWORD 1 ¬¬¬¬¬¬«

ª¬¬¬ choice 2 ¬¬¬«

ª¬¬¬¬¬¬ KEY
WORD 2 ¬¬¬¬¬¬«


ª¬¬¬ choice ¬¬¬«

ª¬¬¬¬¬¬ KEYWORD ¬¬¬¬¬¬«


¬¬¬ choice 4 ¬¬¬¯

¬¬¬¬¬¬ KEYWORD 4 ¬¬¬¬¬¬¯

Figure 70: Sample Syntax Diagram