Document Conventions; Text Formatting; Command Syntax Conventions; Notes, Cautions, And Warnings - Brocade Communications Systems VDX 6710 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:
bold text
italic text
code
For readability, command names in the narrative portions of this guide are presented in mixed
lettercase: for example, show media. In actual examples, command lettercase is often all
lowercase. Otherwise, this manual specifically notes those cases in which a command is case
sensitive.

Command syntax conventions

Command syntax in this manual 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.
viii
DRAFT: BROCADE CONFIDENTIAL
Identifies command names
Identifies the names of user-manipulated GUI elements
Identifies keywords and operands
Identifies text to enter at the GUI or CLI
Provides emphasis
Identifies variables
Identifies paths and Internet addresses
Identifies document titles
text Identifies CLI output
Identifies command syntax examples
Commands are printed in bold.
Command options are printed in bold.
Arguments.
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 WWN
--
Boolean. Elements are exclusive. Example: show mode egress | ingress
-- -
Brocade VDX 6710 Hardware Reference Manual
53-1002xxx-01