3Com ADSL Modem Ethernet - Manual (Page 13)

2
CLI C
OMMAND
C
ONVENTIONS AND
T
ERMINOLOGY
This chapter describes the command syntax, conventions and terminology used
within the Command Line Interface. Reviewing and understanding this chapter is
essential for you to understand subsequent chapters.
Command Structure
Format Commands can be followed by values and/or parameters and values. For example:
Ddd ip network <network_name> address [ip_addr]
■
add ip network is the command
■
<network_name> is the (required) value for the command
■
address is a required parameter
■
[ip_addr] is the value for the IP address parameter which you must provide
Parameters
■
are order independent
■
{ … } parameters enclosed by curly braces are required, and are provided with
default values. You do not need to specify these parameters unless you wish to
override the default.
Values
■
< … > required values for a command or parameter are enclosed by arrows.
■
[ … ] range of values following parameters are enclosed in brackets. Inside the
brackets, if you see a:
■
| (vertical bar) you may select only one of the displayed choices:
[FIRST | SECOND | THIRD]
■
, (comma) you can select one or more of the displayed choices:
[FIRST,SECOND,THIRD,...]
The type of value you enter must match the type requested. Numbers are either
decimal or hexadecimal. Text can be either a string that you create, or it may be a
list of options you must choose from. When choosing an option, type the text of
the option exactly.
Names or Strings
“Double quotation marks” set off user-defined strings. If you want white space or
special characters in a string, it must be enclosed by “double quotation marks”.