Brocade Communications Systems 53-1002163-02 Document conventions

Converged Enhanced Ethernet Administrator’s Guide xix
53-1002163-02
DRAFT: BROCADE CONFIDENTIAL
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:
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 command 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. 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:
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.
TABLE 1 Command syntax conventions
Convention Description
[ ] Default responses to system prompts appear in square brackets.
{x | y | z} A choice of required keywords appears in braces separated by vertical
bars. You must select one.
screen font 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.
bold face font Commands and keywords.
italic Variables for which you supply values.