Conventions - Cisco WCM300 - Channel Bonded Cable Modem Implementation Manual

Conventions

Conventions
This guide uses the following conventions for command syntax descriptions and textual emphasis:
Table 2
Convention
boldface font
italic font
[ ]
{x | y | z}
[x | y | z]
string
screen
boldface screen
italic screen
^
< >
[ ]
!, #
This symbol means reader take note. Notes contain helpful suggestions or references to material not
Note
covered in the publication.
This symbol means the following are useful tips.
Tip
This symbol means the described action saves time. You can save time by performing the action
Timesaver
described in the paragraph.
This symbol means reader be careful. In this situation, you might do something that could result in
Caution
equipment damage or loss of data.
Cisco Cable Wideband Solution Design and Implementation Guide, Release 1.0
x
Command Syntax and Emphasis Conventions
Description
Commands and keywords are in boldface.
Arguments for which you supply values are in italics.
Elements in square brackets are optional.
Alternative, mutually exclusive, keywords are grouped in braces and
separated by vertical bars.
Optional alternative keywords are grouped in brackets and separated by
vertical bars.
A nonquoted set of characters. Do not use quotation marks around the string
or the string will include the quotation marks.
font Terminal sessions and information the system displays are in
font Information you must enter is in
font Arguments for which you supply values are in
The symbol ^ represents the key labeled Control—for example, the key
combination ^D in a screen display means hold down the Control key while
you press the D key.
Nonprinting characters, such as passwords, are in angle brackets in contexts
where italics are not available.
Default responses to system prompts are in square brackets.
An exclamation point ( ! ) or a pound sign ( # ) at the beginning of a line of
code indicates a comment line.
font.
boldface screen
italic screen
Preface
font.
screen
font.
OL-10705-02