Command Conventions; Syntax Conventions; Example Conventions - Alcatel Router User Manual

8
Chapter : Command Line Interface

Command Conventions

Router User Guide
Each command is briefly described and then followed by the complete syntax, which is essentially a
map of the command that shows mandatory and optional parameters.
The following tables provide details of the conventions used for syntaxes and examples.
Table 6 Syntax Conventions
For Syntaxes
normal type
[ a | b | c ]
< >
[ ]
Table 7 Example Conventions
For Examples
What it means
Within syntaxes, "normal type" represents required words that must be
entered by the user — except when followed by a parameter setting that is
enclosed in angled brackets. In that case, only enter the parameter setting
enclosed in the angled brackets.
Example 1: Normal type only.
In this example, the user enters the word or argument (module) appearing in
the syntax in "normal type."
Syntax:
module
Command execution:
module
Example 2: Normal type word or argument that is followed by a second
normal type word or argument, which is followed by a parameter setting
enclosed in angled brackets.
In this example, the user enters the first word or argument "connections,"
appearing in normal type, and then only enters the value "4" of the second
word or argument.
Syntax:
connections connections < n >
Command execution:
connections 4
In other words, the first occurence of "connections" must be entered because
it is not followed by a setting enclosed in angled brackets. The second
occurence of the word "connections" must NOT be entered because it is
followed by a setting enclosed in angled brackets. This value of the setting
must be entered to execute the command.
Normal brackets "[ ]" indicate optional keywords or arguments.
A vertical bar " | " separates individual settings.
Example:
In this example, the user enters the word "timeout;" must specify either for
"tcp" or "udp" for a protocol type; and optionally enters a timeout value "n."
Syntax:
timeout protocol_type < tcp | udp > [ seconds < n > ]
Command execution:
timeout udp 3600
Angled brackets. All parameter settings are enclosed in angled brackets. The
user is directed to choose an appropriate setting. In some cases, the parameter
name accompanies the required setting.
Optional parameter settings in each syntax are indicated by normal brackets.
What it means