Learning About the User Interfaces

23

Figure 2 Abbreviated Syntax

Commands, parameters, and service names can be entered in abbreviated form. Uppercase denotes the shortest unambiguous abbreviation of a command, service name, or parameter.

Command name

Parameter name

SETD !1 -FDDI IP = DNI

Value

Additional syntax examples are provided in “Full and Abbreviated Syntax Examples” on page 24.

Symbols

You may see a variety of symbols shown as part of the command syntax. These symbols usually explain how to enter the command, and you do not type them as part of the command itself. The exceptions to this rule are parentheses, the hyphen, and the exclamation point, which you do type as part of the command. Table 3 summarizes command syntax symbols.

Table 3 Command Syntax Symbols

Symbol

Description

 

 

 

 

angle brackets < >

Enclose a variable or value. You must specify the variable or value; for

 

 

example, in the syntax:

 

 

DELete -IP ADDRess <IP address>

 

 

you must supply an address for <IP address> when you enter the

 

 

command. Do not type the angle brackets.

 

 

 

 

square brackets[ ]

Enclose an optional value or a list of optional arguments. One or more

 

 

values or arguments can be specified. For example, in the syntax:

 

 

SET PRIvilege = [User NetMgr]

 

 

you can specify either User or NetMgr when you enter the command. Do

 

not type the square brackets.

 

 

 

parentheses ( )

Enclose a list of values that can be assigned to a single parameter. At least

 

one of them must be selected. You must type the parentheses and

 

 

separate the values with a comma if you are assigning more than one

 

 

value. For example, in the syntax:

 

 

SET CurrentPorts = ALL (<port>, <port>)

 

 

you can specify two port numbers by enclosing them in parentheses and

 

separating them with a comma when you enter the command.

 

 

 

 

vertical bar

Separates mutually exclusive items in a list, one of which must be

 

 

entered. For example, in the syntax:

 

 

SET ScreenLength = [None <line>(6–100)]

 

 

you can specify either the word None or a number between 6 and 100

 

when you enter the command. Do not type the vertical bar.

 

 

 

 

ellipsis ...

Following a parameter name or value, indicates that one or more

 

 

additional arguments may be specified on the same command line. For

 

example, in the syntax:

 

 

ADD !<port> -IP SecAuthIn <authority> [<authority> ...

]

 

[ANY]

 

you can specify multiple authorities (GENSER, SIOP, SCI, NSA, DOE, NONE) when you enter the command. Do not type the ellipsis.

Page 23
Image 23
3Com 11.3 manual Symbols, Symbol Description