Chapter 2

SpeedTouch™ Command Line Interface

Help You can use help or ? from any level to list all available commands and command groups for that level. Below an example is provided of executing help from the firewall command group selection:

=>:firewall help

 

are available :

 

Following commands

 

config

: Display/Modify firewall configuration.

list

: Display firewall configuration.

flush

: Flush firewall configuration.

 

Following command groups are available :

 

chain

debug

level

rule

Executing :help firewall from top level gives the same result.

Entering help followed by a specific command, for example :help firewall list (starting from top level) or help list (entered from within the firewall command group selection) results in a description of the syntax for the command:

=>:help firewall list

Display firewall configuration.

Syntax : list [format = <{prettycli}>]

Parameters :

[format = <{prettycli}>]

The format of the firewall list.

Executing :help all from top level will generate the complete listing of all available CLI commands (including syntax description). If entered from within a CLI command group, the listing of all available CLI commands from that CLI command group (including syntax description) are shown.

Command completion The CLI features command completion, which means that when starting to type a command it can be completed by pressing TAB.

For the completion to be successful, the part already typed has to be unique. Completion works for the command groups, for the commands and the options, but not for values.

For example, typing the letter l at the firewall command group selection, followed by pressing TAB results in the full command being completed. Entering firewall l from top level and pressing TAB gives the same result: the command is completed to firewall list.

Going to the beginning

You can move the cursor to the beginning of the command line by pressing

or end of a line

"CTRL+A"; to move the cursor to the end of the Command Line press "CTRL+E".

Breaking off commands You can break off a command by pressing "CTRL+G". This can be useful in a situation where a user wants to abort the command. This can be useful to break off commands for which the user does not know the value of a required command parameter.

8

E-DOC-CTC-20051017-0155 v1.0

 

Page 18
Image 18
Technicolor - Thomson SpeedTouchTM620 manual Going to the beginning, Or end of a line, =help firewall list