Document Conventions; Text Formatting; Command Syntax Conventions - Brocade Communications Systems 8 Troubleshooting And Diagnostics Manual

•
•
For further information about documentation updates for this release, refer to the release notes.

Document conventions

This section describes text formatting conventions and important notice formats used in this
document.

Text formatting

The narrative-text formatting conventions that are used are as follows:

Command syntax conventions

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. Otherwise, this manual specifically notes those cases in which a command is case
sensitive. Command syntax in this manual follows these conventions:
command
option, option
--
argument, arg
-
[ ]
variable
Fabric OS Troubleshooting and Diagnostics Guide
53-1001769-01
Information that was changed:
-
All commands have been updated.
Information that was deleted:
-
All obsolete information. This information was obsoleted because it was no longer
supported in the current version of firmware.
-
The iSCSI chapter has been removed and put in the iSCSI Administrator's Guide.
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 command 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 < >.
xi