Document conventions, Text formatting, Command syntax conventions – Brocade Network OS Command Reference v4.1.0 User Manual
Page 35
Network OS Command Reference
xxxv
53-1003115-01
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 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.
Convention
Description
[ ]
Keywords or arguments that appear within square brackets are optional. For example:
command [active | standby | disabled] = One (and only one) of this set of keywords may be
used.
command [active] [standby] [disabled] = Three independent options, and one or more may
be used on the same command line.
{ x | y | z }
A choice of required keywords appears in braces separated by vertical bars. You must
select one. For example:
command {active | standby | disabled} = One (and only one) of this set of
keywords/operands must be used.
screen font
Examples of information displayed on the screen.
< >
Nonprinting characters, for example, passwords, appear in angle brackets.
[ ]
Default responses to system prompts appear in square brackets.
italic text
Identifies variables.
bold text
Identifies literal command options and keywords.