User Manual

Conventions
IP-RN 8000 Installation & Commissioning Guide xv
Conventions
This section describes Airvana document conventions. It contains these sections:
• Text conventions
on page xv
• Icon conventions
on page xvii
Text conventions
Table 1
lists and describes the text conventions in Airvana guides.
Table 1 Airvana text conventions
Convention Description
bold face angle brackets
< >
Indicate a required parameter in a Command Line Interface (CLI) command.
For example:
>band-class <class>
In the above example, <class> is a required parameter that happens to be a
variable parameter (indicated by the italics) with a range of 1 to 3. A valid
command in this syntax is:
>band-class 3
Indicate that you press the keyboard character enclosed in the brackets. For
example:
• Press <ENTER> to continue.
In the above example, you press the Enter key to continue.
• Press <CTRL><ALT><DELETE> to reboot your computer.
In the above example, you press the Ctrl, Alt, and Delete keys
simultaneously to reboot your computer.
boldface screen font Indicates text that must be entered exactly as shown. For example:
•Enter ping 192.23.10.12 at the CLI prompt.
•Enter 255.255.255.0 in the Net Mask field.
In both examples above, you must enter the bold text exactly as shown.
italic screen font Indicates a variable parameter in a CLI command. For example:
>authentication key <aukey>
In the above example, <aukey> is a variable parameter that specifies the
authentication key for which you must enter a value, containing up to 16
numbers. A valid command in this syntax is:
>authentication key 9782503000
boldface square brackets
[ ]
Indicates an optional parameter in a CLI command. For example:
>activate image <version> [reboot]
In the above example, [reboot] is an optional parameter. A valid
command in this syntax is:
>activate image rnc8500.2.0.0
boldface pipe character
|
Indicates you enter one or the other of the identified parameter options. For
example:
>channel-included <yes | no>
A valid command in this syntax is:
>channel-included yes