Document conventions, Text formatting, Command syntax conventions – Brocade VDX 6740 Hardware Reference Manual (Supporting VDX 6740, VDX 6740T, and VDX 6740T-1G) User Manual
Page 8

viii
Brocade VDX 6740 Hardware Reference Manual
53-1002829-02
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:
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
code
text
Identifies CLI output
Identifies command syntax examples
Command syntax conventions
Command syntax in this manual follows these conventions:
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.
command
Commands are printed in bold.
[ ]
Optional element.
variable
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...]”
value
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}]