Conventions - Cisco uBR905 Installation Manual

Preface

Conventions

This document uses the following conventions:
Convention
Boldface
Italics
Square brackets ([ ])
Vertical bars ( | )
Braces ({ })
Braces and vertical bars
within square brackets
([ { | } ])
Caret character (^)
A string
System prompts
Screen
OL-0598-01 (9/2000)
Meaning
Commands and keywords you
enter literally as shown
Variables for which you supply
values
Optional elements
Separated alternative elements
Required choices
A required choice within an
optional element
Control key
A nonquoted set of characters
Denotes interactive sessions,
indicates that the user enters
commands at the prompt
font Terminal sessions and
information the system displays
Comments
offset-list
command type interface
You replace the variable with the type
of interface.
In contexts that do not allow italics,
such as online help, arguments are
enclosed in angle brackets (< >).
command [abc]
abc is optional (not required), but you
can choose it.
command [ abc | def ]
You can choose either abc or def, or
neither, but not both.
command { abc | def }
You must use either abc or def, but
not both.
command [ abc { def | ghi } ]
You have three options:
Nothing
•
• abc def
abc ghi
•
The key combinations ^D and Ctrl-D
are equivalent: Both mean hold down
the Control key while you press the D
key. Keys are indicated in capital
letters, but are not case sensitive.
For example, when setting an SNMP
community string to public, do not
use quotation marks around the
string; otherwise, the string will
include the quotation marks.
The system prompt indicates the
current command mode. For
example, the prompt
Router (config) #
configuration mode.
Cisco uBR905 Router Hardware Installation Guide
Conventions
indicates global
ix