Command Syntax Conventions; Notes, Cautions, And Warnings; Key Terms - Brocade Communications Systems Brocade 8/12c Command Reference Manual

Command syntax conventions

Command syntax in the synopsis section follows these conventions:
command
--option, option
-argument, arg
[ ]
variable
...
value
|
\

Notes, cautions, and warnings

The following notices and statements are used in this manual. They are listed below in order of
increasing severity of potential hazards.
NOTE
A note provides a tip, guidance, or advice, emphasizes important information, or provides a
reference to related information. Regular help page notes are included under the NOTES side
heading.
ATTENTION
An Attention statement indicates potential damage to hardware or data.
CAUTION
A Caution statement alerts you to situations that can be potentially hazardous to you or cause
damage to hardware, firmware, software, or data.
DANGER
A Danger statement indicates conditions or situations that can be potentially lethal or extremely
hazardous to you. Safety labels are also attached directly to products to warn of these conditions
or situations.

Key terms

For definitions specific to Brocade and Fibre Channel, see the technical glossaries on the Brocade Web
site. See
xxx
Commands are printed in bold.
Command options are printed in bold.
Arguments are printed in bold.
Optional element.
Variables are printed in italics. In the help pages, values are underlined or
enclosed in angle brackets < >.
Repeat the previous element, for example "member[;member...]"
Fixed (literal) values following arguments are printed in plain font. For example,
--show WWN
Boolean. Elements are exclusive. Example: --show -mode egress | ingress
Backslash indicates a "soft" line break. If a backslash separates two lines of a
command input, enter the entire command at the prompt without the back slash.
"Brocade resources" on page xxxi for instructions on accessing the information.
Fabric OS Command Reference
53-1002147-01