Document conventions, Text formatting, Command syntax conventions – Brocade Unified IP MIB Reference (Supporting FastIron Releases 07.5.00 and 08.0.10) User Manual
Page 24: Notes
xxiv
Unified IP MIB Reference
53-1003106-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:
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:
Notes
The following notice statements are used in this manual.
NOTE
A note provides a tip, guidance, or advice, emphasizes important information, or provides a
reference to related information.
bold text
Identifies command names
Identifies the names of user-manipulated GUI elements
Identifies keywords
Identifies text to enter at the GUI or CLI
italic text
Provides emphasis
Identifies variables
Identifies document titles
code
text
Identifies CLI output
command
Commands are printed in bold.
--
option, option
Command options are printed in bold.
-
argument, arg
Arguments.
[ ]
Optional elements appear in brackets.
variable
Variables are printed in italics.
...
Repeat the previous element, for example “member[;member...]”
value
Fixed values following arguments are printed in plain font. For example,
--
show WWN
|
Boolean. Elements are exclusive. Example:
--
show
-
mode egress | ingress