Brocade Access Gateway Administrator's Guide Supporting Fabric OS v7.0.0 (53-1002156-01, April 2011)

Access Gateway Administrator’s Guide xv
53-1002156-01
In this chapter
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:
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
code text Identifies CLI output
Identifies syntax examples
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:
Notes, cautions, and warnings
The following notices appear in this document.
NOTE
A note provides a tip, guidance, or advice, emphasizes important information, or provides a
reference to related information.
command Commands are printed in bold.
--option, option Command options are printed in bold.
-argument, arg Arguments.
[ ] Optional element.
variable 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...]”
value Fixed values following arguments are printed in plain font. For example,
--show WWN
| Boolean. Elements are exclusive. Example:
--show -mode egress | ingress