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 1
describes the conventions this document uses to distinguish between value
types.
Table 1. Parameter Conventions
Symbol
<> angle brackets
[] square brackets
{} curly braces
| Vertical bars
[{}] Braces within
square brackets
Common Parameter Values
Parameter values might be names (strings) or numbers. To use spaces as part of a name
parameter, enclose the name value in double quotes. For example, the expression "System
ProSafe Managed Switch
Example
Description
<value>
Indicates that you must enter a value in place of the
brackets and text inside them.
[value]
Indicates an optional parameter that you can enter in
place of the brackets and text inside them.
{choice1 |
Indicates that you must select a parameter from the list of
choice2}
choices.
choice1 | choice2
Separates the mutually exclusive choices.
[{choice1 |
Indicates a choice within an optional element.
choice2}]
Using the Command-Line Interface
11