Brocade Communications Systems VDX 8770-4, Hardware Installation Manual, Page: 9 / 141

Preface
∙
Document conventions.....................................................................................................................................................................................................9
∙
Brocade resources.............................................................................................................................................................................................................10
∙
Contacting Brocade Technical Support................................................................................................................................................................. 10
∙
Document feedback............................................................................................................................................................................................................11
Document conventions
The document conventions describe text formatting conventions, command syntax conventions, and important notice formats used in
Brocade technical documentation.
Text formatting conventions
Text formatting conventions such as boldface, italic, or Courier font may be used in the flow of the text to highlight specific words or
phrases.
Format Description
bold text Identifies command names
Identifies keywords and operands
Identifies the names of user-manipulated GUI elements
Identifies text to enter at the GUI
italic text
Identifies emphasis
Identifies variables
Identifies document titles
Courier font
Identifies CLI output
Identifies command syntax examples
Command syntax conventions
Bold and italic text identify command syntax components. Delimiters and operators define groupings of parameters and their logical
relationships.
Convention Description
bold text Identifies command names, keywords, and command options.
italic text Identifies a variable.
value In Fibre Channel products, a fixed value provided as input to a command option is printed in plain text, for
example, --show WWN.
[ ] Syntax components displayed within square brackets are optional.
Default responses to system prompts are enclosed in square brackets.
{ x | y | z } A choice of required parameters is enclosed in curly brackets separated by vertical bars. You must select
one of the options.
In Fibre Channel products, square brackets may be used instead for this purpose.
x | y A vertical bar separates mutually exclusive elements.
< > Nonprinting characters, for example, passwords, are enclosed in angle brackets.
Brocade VDX 8770-4 Hardware Installation Guide
53-1002563-10 9