Text formatting, Command syntax conventions, Notes – Brocade Network OS Message Reference v4.1.1 User Manual
Page 13: Key terms
Network OS Message Reference
xiii
53-1003227-01
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.
Command syntax conventions
Command syntax in this manual follows these conventions:
NOTE
In standalone mode, interfaces are identified using slot/port notation. In Brocade VCS Fabric
technology® mode, interfaces are identified using switch/slot/port notation.
Notes
The following note is used in this manual.
NOTE
A note provides a tip, guidance, or advice, emphasizes important information, or provides a
reference to related information.
Key terms
For definitions specific to Brocade and Fibre Channel, see the technical glossaries on MyBrocade.
See
on page xiv for instructions on accessing MyBrocade.
command
Commands are printed in bold.
variable
Variables are printed in italics.
[ ]
Keywords or arguments that appear within square brackets are optional.
{ 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.
< >
Non-printing characters, for example, passwords, appear in angle brackets.