Text formatting, Command syntax conventions, Notes – Brocade 6910 Ethernet Access Switch Diagnostic Guide (Supporting R2.2.0.0) User Manual
Page 9
Brocade 6910 Ethernet Access Switch Diagnostic Guide
ix
53-1002653-01
Disclaimer
Text formatting
The narrative-text formatting conventions that are used are as follows:
Command syntax conventions
Command syntax in this manual follows these conventions:
Notes
The following notice statements are used in this manual.
NOTE
A note provides a tip, guidance, or advice, emphasizes important information, or provides a
reference to related information.
ATTENTION
An Attention statement indicates potential damage to hardware or data.
bold text
Identifies command names
Identifies the names of user-manipulated GUI elements
Identifies keywords
Identifies text to enter at the GUI or CLI
italic text
Provides emphasis
Identifies variables
Identifies document titles
code
text
Identifies CLI output
command
Commands are printed in bold.
--
option, option
Command options are printed in bold.
-
argument, arg
Arguments.
{
}
Mandatory elements appear in braces.
[ ]
Optional elements appear in brackets.
variable
Variables are printed in italics.
...
Repeat the previous element, for example “member[,member...]”
value
Fixed values following arguments are printed in plain font. For example,
--
show WWN
|
Boolean. Elements are exclusive. Example:
--
show
-
mode egress | ingress