Document Conventions; Text Formatting; Command Syntax Conventions; Notes, Cautions, And Warnings - Brocade Communications Systems Brocade VDX 6740 Hardware Reference Manual

Document conventions

This section describes text formatting conventions and important notice formats used in this
document.

Text formatting

The narrative-text formatting conventions that are used are as follows:

Command syntax conventions

Command syntax in this manual follows these conventions:
command
[ ]
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.
ATTENTION
An Attention statement indicates potential damage to hardware or data.
viii
bold text Identifies command names
Identifies the names of user-manipulated GUI elements
Identifies keywords and operands
Identifies text to enter at the GUI or CLI
italic text Provides emphasis
Identifies variables
Identifies paths and Internet addresses
Identifies document titles
text Identifies CLI output
code
Identifies command syntax examples
Commands are printed in bold.
Optional element.
Variables are printed in italics. In the help pages, values are underlined or
enclosed in angled brackets < >.
Repeat the previous element, for example "member[;member...]"
Fixed values following arguments are printed in plain font. For example,
show environment temp rbridge 30
Boolean. Elements are exclusive. Example: show environment fan [rbridge-id
{rbridge-id | all}]
Brocade VDX 6740 Hardware Reference Manual
53-1002829-02