Typographic Conventions; Command Syntax Conventions - Cisco VGD-1T3 Software Configuration Manual

Documentation Conventions
This section includes the following topics:
•
•
•
•

Typographic Conventions

Cisco IOS documentation uses the following typographic conventions:
Convention
^ or Ctrl
string

Command Syntax Conventions

Cisco IOS documentation uses the following command syntax conventions:
Convention
bold
italic
[x]
|
[x | y]
{x | y}
[x {y | z}]
Cisco VGD 1T3 Voice Gateway Software Configuration Guide
6
Typographic Conventions, page 6
Command Syntax Conventions, page 6
Software Conventions, page 7
Reader Alert Conventions, page 7
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.)
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; otherwise, the string will
include the quotation marks.
Description
Bold text indicates commands and keywords that you enter as shown.
Italic text indicates arguments for which you supply values.
Square brackets enclose an optional keyword or argument.
A vertical line, called a pipe, indicates a choice within a set of keywords
or arguments.
Square brackets enclosing keywords or arguments separated by a pipe indicate an
optional choice.
Braces enclosing keywords or arguments separated by a pipe indicate a
required choice.
Braces and a pipe within square brackets indicate a required choice within an
optional element.
About Cisco IOS Software Documentation