Previous Topic: Command OverviewNext Topic: Defaults


Notation Conventions

This guide uses the following rules and special characters in syntax illustrations.

Enter exactly as shown in command syntax:

Notation

Description of use

UPPERCASE

Identifies commands, keywords, and keyword values that you must enter exactly as shown or replace it with an authorized abbreviation.

symbols

You must enter all special characters, such as parentheses and quotation marks (but not ellipses, brackets, and braces) as shown.

Do not enter the following as shown; notations clarify command syntax:

Notation

Description of use

lower case italics

Represent a value you must supply.

Brackets [ ]

Identifies optional keywords or clauses, or a group of options from which, if included at all, you must make a choice.

Braces { }

Enter one of the keywords or clauses.

Underlining

Indicates a CA Ideal default that you cannot change with a SET command and, therefore, you do not need to specify.

Ellipses ...

You can repeat the preceding word or clause.

Note: For more information about the use of special characters in names, see the Concepts section of the Programming Reference Guide.

Example

This example shows syntax format of CA Ideal commands.

COMmand keyword1={AAA} [keyword2] [keyword3={CCC     }]	
                 {BBB}            [         {xxxxxxxx}]
COM

Initiates the command. COM is an abbreviation.

keyword1=

Designates a required keyword followed by a choice of required values. You must specify one and only one of these values.

keyword2

Specifies an optional keyword.

keyword3=

Designates an optional keyword followed by a choice of values, one of which is required if you specify the parameter.

CCC

Designates a default value for keyword 3. If you do not specify the keyword, the product uses this value.

xxxxxxxx

Indicates that you can specify a value according to the instructions in the keyword description following the syntax diagram.