Document Conventions - Cisco ASR 1000 Series Software Configuration Manual

Preface

Document Conventions

Within the SIP and SPA software configuration guides, the term router is generally used to refer to a variety
of Cisco products (for example, routers, access servers, and switches). Routers, access servers, and other
networking devices that support Cisco IOS software are shown interchangeably within examples. These
products are used only for illustrative purposes; that is, an example that shows one product does not necessarily
indicate that other products are not supported.
This document uses the following conventions:
Convention
^ or Ctrl
bold font
Italic font
Courier font
Bold Courier font
[x]
...
|
[x | y]
{x | y}
[x {y | z}]
string
< >
OL-14127-17
Description
Both the ^ symbol and Ctrl represent the Control (Ctrl) key on a keyboard.
For example, the key combination ^D or Ctrl-D means that you hold
down the Control key while you press the D key. (Keys are indicated in
capital letters but are not case sensitive.)
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.
Terminal sessions and information the system displays appear in
font.
Bold Courier font indicates text that the user must enter.
Elements in square brackets are optional.
An ellipsis (three consecutive nonbolded periods without spaces) after
a syntax element indicates that the element can be repeated.
A vertical line, called a pipe, indicates a choice within a set of keywords
or arguments.
Optional alternative keywords are grouped in brackets and separated by
vertical bars.
Required alternative keywords are grouped in braces and separated by
vertical bars.
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.
A nonquoted set of characters. Do not use quotation marks around the
string or the string will include the quotation marks.
Nonprinting characters such as passwords are in angle brackets.
Cisco ASR 1000 Series Aggregation Services Routers SIP and SPA Software Configuration Guide, Cisco IOS XE
Document Conventions
courier
Everest 16.5
xliii