Preface; Document Conventions; Text Formatting Conventions; Command Syntax Conventions - Brocade Communications Systems VDX 6940 Series Hardware Installation Manual

Preface

∙

Document conventions..................................................................................................................................................................................................... 7

∙
Brocade resources...............................................................................................................................................................................................................8
∙
Contacting Brocade Technical Support...................................................................................................................................................................8
∙
Document feedback........................................................................................................................................................................................................... 9
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
bold text
italic text
Courier font

Command syntax conventions

Bold and italic text identify command syntax components. Delimiters and operators define groupings of parameters and their logical
relationships.
Convention
bold text
italic text
value
[ ]
{ x | y | z }
x | y
< >
Brocade VDX 6940 Hardware Installation Guide
53-1003495-06
Description
Identifies command names
Identifies keywords and operands
Identifies the names of user-manipulated GUI elements
Identifies text to enter at the GUI
Identifies emphasis
Identifies variables
Identifies document titles
Identifies CLI output
Identifies command syntax examples
Description
Identifies command names, keywords, and command options.
Identifies a variable.
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.
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.
A vertical bar separates mutually exclusive elements.
Nonprinting characters, for example, passwords, are enclosed in angle brackets.
7