Document Conventions; Text Formatting; Command Syntax Conventions; Notes, Cautions, And Warnings - Brocade Communications Systems 8 Administrator's Manual

Document conventions

This section describes text formatting conventions and important notices formats.

Text formatting

The narrative-text formatting conventions that are used in this document are as follows:
For readability, command names in the narrative portions of this guide are presented in mixed
lettercase: for example, switchShow. In actual examples, command lettercase is often all
lowercase.

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 appear in this document.
NOTE
A note provides a tip, emphasizes important information, or provides a reference to related
information.
Access Gateway Administrator's Guide
553-1001760-01
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
text Identifies CLI output
code
Identifies 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
-- -
xv