Conventions - Cisco 700 Series Configuration Manual

Conventions

This publication uses the following conventions to convey instructions and information:
•
The caret character (^) represents the Control key.
For example, 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 capitals, but are not
case sensitive.
•
A string is defined as a nonquoted set of characters.
There are a few strings that include quotation marks as part of the statement. Therefore,
common practice is not to include the quotation marks unless they are included in the
statement. For example, set the SNMP community string to public does not use
quotation marks around the string "public" because when you enter the string, you
would not include the quotation marks.
Command descriptions use these conventions:
•
Vertical bars ( | ) separate alternative, mutually exclusive, elements.
•
Square brackets ([ ]) indicate optional elements.
•
Variables for which you supply values are in italic.
•
Examples that contain system prompts denote interactive sessions, indicating the user
enters the command at the prompt. The system prompt indicates the current command
mode. For example, the prompt router:2503> indicates profile mode. The exception is
when a list of commands is provided in an example configuration; the prompt is not
shown for the sake of clarity.
•
Fixed information you enter is in boldface screen font. Variable information you
enter is in italic.
•
Terminal sessions and information the system displays are in screen font.
•
Nonprinting characters, such as passwords, are in angle brackets (< >).
The command syntax contains a combination of bold and regular uppercase and lowercase
alphanumeric characters. You can enter the full text of the commands, or you can enter the
abbreviated form. The abbreviated form consists of the first characters in each word, shown
in uppercase bold in the command syntax. The uppercase bold characters are the minimum
you must enter for the command to be recognized and executed.
Conventions
About This Manual ix