Table of Contents
Advertisement
1.
CLI Overview
Using the CLI
Command Syntax and Conventions
The CLI and CLI Reference Guide follow the syntax and style conventions described in this section.
•
Commands use the following syntax:
command subcommand required_arguments [optional_arguments]
•
Most options with modifiers are entered in the -option value format. For example, -p port_name indi-
cates you need to enter the option -p and the value port_name.
•
Some options with modifiers are entered in key-value pair (KVP) format, +keyword=[value] . For exam-
ple, +time=5.
•
Strings are a non quoted set of characters. Do not use quotation marks around the string or the string will
include the quotation marks.
•
The brackets, pipe symbols, ellipses and other indicators are used for documentation clarification and must be
excluded from the command.
•
The characters KMG|kmg are used for options that support a K/M/G suffix to indicate kilo-, mega-, or giga-.
•
The Ctrl+C command clears the current line and stops interactive commands but does not exit the CLI.
•
The Ctrl+D command exits the CLI.
Table 1
CLI Conventions
Convention
[ ]
Italics
or < >
{ x | y | z }
[ x , y , z ]
|
,
...
^
Boldface
Courier
Square brackets indicate an optional argument.
italics
Information in
or angle brackets indicates variables. For example:
addresses
,
user names
, and other values. Nonprinting characters, such as passwords, are also
displayed in angle brackets.
Lists in curly braces indicate alternative keyword groups. The items may be separated by verti-
cal bars or commas.
Lists in square brackets indicate optional alternative keyword groups. The items may be sepa-
rated by vertical bars or commas.
The vertical bar or pipe symbol indicates an exclusive list of options separated by vertical bars.
Use one of the options separated by vertical bars.
Commas indicate an inclusive list separated by commas. Use any number of the options sepa-
rated by commas.
An ellipse indicates input or output continues, but the sample input or output does not dis-
play all of the information.
The caret symbol indicates the key labeled Control. For example, the key combination ^D in a
screen display means hold down the Control key while you press the D key.
Indicates commands and key words.
The Courier font indicates terminal input and output. This includes file names, commands,
subcommands, options, parameters, IP addresses and other system values.
7
Description
ETERNUS DSP CLI Reference Guide
file names
IP
,
Advertisement
Table of Contents
