Preface; Document Conventions; Text Formatting Conventions; Command Syntax Conventions - Brocade Communications Systems FastIron Administration Manual

Preface

●

Document conventions....................................................................................................11

● Brocade resources.......................................................................................................... 13
● Contacting Brocade Technical Support...........................................................................13
● Document feedback........................................................................................................ 14
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
FastIron Ethernet Switch Administration Guide
53-1003625-01
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.
11