Document Conventions - Cisco Nexus 5000 Series Configuration Manual

Preface

Document Conventions

Command descriptions use the following conventions:
Convention
bold
Italic
[x]
[x | y]
{x | y}
[x {y | z}]
variable
string
Screen examples use the following conventions:
Convention
screen font
boldface screen font
italic screen font
< >
[ ]
!, #
This document uses the following conventions:
OL-xxxxx-xx
Description
Bold text indicates the commands and keywords that you enter literally
as shown.
Italic text indicates arguments for which the user supplies the values.
Square brackets enclose an optional element(keyword or argument).
Square brackets enclosing keywords or arguments separated by a vertical
bar indicate an optional choice.
Braces enclosing keywords or arguments separated by a vertical bar
indicate a required choice.
Nested set of square brackets or braces indicate optional or required
choices within optional or required elements. Braces and a vertical bar
within square brackets indicate a required choice within an optional
element.
Indicates a variable for which you supply values, in context where italics
cannot be used.
A nonquoted set of characters. Do not use quotation marks around the
string or the string will include the quotation marks.
Description
Terminal sessions and information the switch displays are in screen font.
Information you must enter is in boldface screen font.
Arguments for which you supply values are in italic screen font.
Nonprinting characters, such as passwords, are in angle brackets.
Default responses to system prompts are in square brackets.
An exclamation point (!) or a pound sign (#) at the beginning of a line
of code indicates a comment line.
Cisco Nexus 5000 Series NX-OS SAN Switching Configuration Guide
Document Conventions
xix