Documentation Conventions - Cisco ASR 9001 Hardware Installation Manual

Preface
•

Documentation Conventions

This publication uses these conventions:
• Ctrl represents the key labeled Control. For example, the key combination Ctrl- Z means hold down
Command descriptions use these conventions:
• Examples that contain system prompts denote interactive sessions, indicating the commands that you
Convention
bold font
Italic font
[ ]
{x | y | z}
[x | y | z]
string
courier
< >
[ ]
!, #
Site Log, on page 147, provides a sample site log that can be used to record actions relevant to the
operation and maintenance of the router.
the Control key while you press the Z key.
should enter at the prompt. For example:
RP/0/RSP0/CPU0:router#
font
Description
Commands and keywords and user-entered text appear in bold font.
Document titles, new or emphasized terms, and arguments for which you
supply values are in italic font.
Elements in square brackets are optional.
Required alternative keywords are grouped in braces and separated by
vertical bars.
Optional alternative keywords are grouped in brackets and separated by
vertical bars.
A nonquoted set of characters. Do not use quotation marks around the
string or the string will include the quotation marks.
Terminal sessions and information the system displays appear in
font.
Indicates a variable for which you supply values, in context where italics
cannot be used.
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 ASR 9001 and Cisco ASR 9001-S Routers Hardware Installation Guide
Documentation Conventions
courier
xi