Document Conventions
D
C
OCUMENT
Two types of messages, identified by icons, appear throughout the document:
Notes contain information about special circumstances.
Cautions indicate the possibility of equipment damage or the possibility of
personal injury.
C
-L
OMMAND
INE
The following typeface conventions are specific to the Command-Line Interface chapters of this
manual.
•
Bold courier type indicates text to be typed exactly as shown.
•
Unbolded courier type indicates onscreen messages or prompts.
•
<Angle Brackets> indicate a parameter for which you need to provide an appropriate
value.
•
[Square Brackets] indicate an optional parameter.
•
[<Angle brackets within square brackets>] indicate an optional
parameter that, should you include it, requires you to provide an appropriate value.
•
(Multiple|Values) in parenthesis separated by a vertical line indicate that you must
select one of the values for that parameter. However, parentheses may also contain
parameters for which you need to provide a value. For example, (all|<port>)
indicates that you can type all to view all ports or type a port number to view a specific
port.
•
Some optional parameters contain both a command and a parameter for which you need to
select from a finite set of values. For example, [-admin (up|down)] requires you to
type -admin up or -admin down, should you choose to include the parameter.
Optional parameters follow the required parameters in the command line, and can be
included in any order.
•
Italic type indicates the format in which you type the information specified in the
procedure.
iv
ONVENTIONS
I
NTERFACE
C
ONVENTIONS
Avidia System Configuration and Management User Manual