Command-Line Conventions - Nokia IP40 User Manual

Command-Line Conventions

This section defines the elements of commands that are available in Nokia products. You might
encounter one or more of the following elements on a command-line path.
Table 1 Command-Line Conventions
Convention
command
Italics
angle brackets < >
Square brackets [ ]
Vertical bars,
pipe
(|)
-flag
Nokia IP40 User Guide
Description
This required element is usually the product name or other short
word that invokes the product or calls the compiler or preprocessor
script for a compiled Nokia product. It might appear alone or
precede one or more options. You must spell a command exactly
as shown and use lowercase letters.
Indicates a variable in a command that you must supply. For
example:
delete interface if_name
Supply an interface name in place of the variable. For example:
delete interface nic1
Indicates arguments for which you must supply a value:
retry-limit <1–100>
Supply a value. For example:
retry-limit 60
Indicates optional arguments.
delete [slot slot_num]
For example:
delete slot 3
also called a
Separates alternative, mutually exclusive elements.
framing <sonet | sdh>
To complete the command, supply the value. For example:
framing sonet
or
framing sdh
A flag is usually an abbreviation for a function, menu, or option
name, or for a compiler or preprocessor argument. You must enter
a flag exactly as shown, including the preceding hyphen.
Conventions This Guide Uses
13