Previous Topic

Next Topic

Book Contents

Command Conventions

In this document, the command name is in bold font. Parameters are in italic font. You must replace the parameter name with an appropriate value, which might be a name or number. Parameters are order dependent. The parameters for a command might include mandatory values, optional values, or keyword choices. Table below describes the conventions this document uses to distinguish between value types.

Symbol

Example

Description

<> angle brackets

<value>

Indicates that you must enter a value in place of the brackets and text inside them.

[] square brackets

[value]

Indicates an optional parameter that you can enter in place of the brackets and text inside them.

{} curly braces

{choice1 | choice2}

Indicates that you must select a parameter from the list of choices.

| Vertical bars

choice1 | choice2

Separates the mutually exclusive choices.

[{}] Braces within square brackets

[{choice1 | choice2}]

Indicates a choice within an optional element.

See also

Using the Command-Line Interface

Command Syntax

Common Parameter Values

Slot/Port Naming Convention

Using the “No” Form of a Command