Document Conventions; Text Formatting; Command Syntax Conventions - Brocade Communications Systems StoreFabric SN6500B Command Reference 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 command titles and in the narrative portions of this guide are
presented in mixed letter case, for example, switchShow. In examples, command letter case is all
lowercase.

Command syntax conventions

Command syntax in this document follows these conventions:
command
--option, option
-argument, arg
[ ]
variable
...
value
|
\
xxiv
Automatic page breaks in CLI command output displays are being phased out. Use the more option
to display command output with page breaks: command | more. Do not use the more option in
conjunction with help pages. Executing help command | more will display a command "no manual
entry for command" message.
bold text Identifies command names
Identifies 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 are printed in bold.
Optional element.
Variables are printed in italics. In the help pages, values are underlined or
enclosed in angle brackets < >.
Repeat the previous element, for example "member[;member...]"
Fixed (literal) values following arguments are printed in plain font. For example,
--show WWN
Boolean. Elements are exclusive. Example: --show -mode egress | ingress
Backslash indicates a "soft" line break. If a backslash separates two lines of a
command input, enter the entire command at the prompt without the backslash.
Fabric OS Command Reference
53-1002746-01