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

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:
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 conventions

Command syntax in this manual follows these conventions:
TABLE 1
Convention
[ ]
{x | y | z}
screen font
<>
[ ]
bold face font
italic

Notes, cautions, and warnings

The following notices and statements are used in this manual. They are listed below in order of
increasing severity of potential hazards.
Converged Enhanced Ethernet Administrator's Guide
53-1002163-02
DRAFT: BROCADE CONFIDENTIAL
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
Command syntax conventions
Description
Default responses to system prompts appear in square brackets.
A choice of required keywords appears in braces separated by vertical
bars. You must select one.
Examples of information displayed on the screen.
Nonprinting characters, for example passwords, appear in angle
brackets.
Keywords or arguments that appear within square brackets are
optional.
Commands and keywords.
Variables for which you supply values.
xix