Cisco SRST User Guide - Page 7

Convention, Meaning, Description / Comments, Boldface, offset-list, command - configuration example

Page 7 highlights

Preface Syntax Conventions Table 2 Conventions Convention Boldface Italics Square brackets ([ ]) Vertical bars ( | ) Braces ({ }) Braces and vertical bars within square brackets ([ { | } ]) Caret character (^) A nonquoted set of characters System prompts Screen font Meaning Description / Comments Commands and keywords offset-list you enter as shown. Variables for which you supply values. 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 (< >). Optional elements. command [abc] abc is optional (not required), but you can choose it. Separated alternative elements. command [ abc | def ] You can choose either abc or def, or neither, but not both. Required choices. command { abc | def } You must choose either abc or def, but not both. A required choice within an command [ abc { def | ghi } ] optional element. You have three options: nothing abc def abc ghi Control key. 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. A string. 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. Denotes interactive sessions, indicates that the user enters commands at the prompt. The system prompt indicates the current command mode. For example, the prompt Router (config) # indicates global configuration mode. Terminal sessions and information the system displays. OL-7959-01 Cisco SRST SNMP MIB Release 3.4 Guide vii

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62

vii
Cisco SRST SNMP MIB Release 3.4 Guide
OL-7959-01
Preface
Syntax Conventions
Table 2
Conventions
Convention
Meaning
Description / Comments
Boldface
Commands and keywords
you enter as shown.
offset-list
Italics
Variables for which you
supply values.
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 (< >).
Square brackets ([ ])
Optional elements.
command
[abc]
abc is optional (not required), but you
can choose it.
Vertical bars ( | )
Separated alternative
elements.
command
[ abc | def ]
You can choose either abc or def, or
neither, but not both.
Braces ({ })
Required choices.
command
{ abc | def }
You
must
choose either abc
or
def, but
not both.
Braces and vertical bars
within square brackets
([ { | } ])
A required choice within an
optional element.
command
[ abc { def | ghi } ]
You have three options:
nothing
abc def
abc ghi
Caret character (^)
Control key.
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.
A nonquoted set of
characters
A string.
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.
System prompts
Denotes interactive
sessions, indicates that the
user enters commands at the
prompt.
The system prompt indicates the
current command mode. For example,
the prompt
Router (config) #
indicates global configuration mode.
Screen
font
Terminal sessions and
information the system
displays.