Document Conventions - Cisco ASR 1000 Series Hardware Installation Manual

Document Conventions

Within the guide, 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 documentation uses the following conventions:
Convention
^ or Ctrl
string
Command syntax descriptions use the following conventions:
Convention
bold
italics
[x]
|
[x | y]
{x | y}
Nested sets of square brackets or braces indicate optional or required choices within optional or required
elements. For example:
Convention
[x {y | z}]
Examples use the following conventions:
Convention
screen
bold screen
<
Cisco ASR 1000 Fixed Ethernet Line Card Hardware Installation Guide
x
Description
The ^ and Ctrl symbols represent the Control key. For example, the key
combination ^D or Ctrl-D means hold down the Control key while you press
the D key. Keys are indicated in capital letters, but are not case sensitive.
A string is a nonquoted set of characters shown in italics. For example, when
setting a Simple Network Management Protocol (SNMP) community string to
public, do not use quotation marks around the string. If you do, the string will
include the quotation marks.
Description
Bold text indicates commands and keywords that you enter exactly as shown.
Italic text indicates arguments for which you supply values.
Square brackets enclose an optional element (keyword or argument).
A vertical line indicates a choice within an optional or required set of keywords
or arguments.
Square brackets enclosing keywords or arguments separated by a vertical line
indicate an optional choice.
Braces enclosing keywords or arguments separated by a vertical line indicate a
required choice.
Description
Braces and a vertical line within square brackets indicate a required choice
within an optional element.
Description
Examples of information displayed on the screen are set in Courier font.
Examples of text that you must enter are set in Courier bold font.
> Angle brackets enclose text that is not printed to the screen, such as passwords.
OL-29623-03