3.2 Command Line Interface

Synopsis

chestnut-dialer [basic options] [command [options]
                [attribute_name=value | unset attribute_name]...]

Description

If no arguments are supplied, then Chestnut Dialer runs with the user interface specified in file ~/.chestnut-dialer/preferred-ui-X, where ~ stands for the user home directory, X is X11 or console. If there is no such file, then the program attempts to determine the preferred user interface based on the current environment (X11 or console).

All commands except --dial either disable the user interface or use interface none. The program terminates as soon as the command has been executed.

Command --dial is an exception: the program will remain running as long as a connection exists if interface none is used; the program will remain running until the user stops it if another interface is used. To disconnect the connection established while using interface none, press Ctrl+C on the keyboard.

Exit Status

0

Successful termination. Chestnut Dialer terminated at the user’s request.

1

Command line usage error.

2

Invalid arguments are supplied (e.g. invalid account identifier, invalid user interface).

3

Unknown error.

4

No dialtone.

5

Line is busy.

6

No carrier detected.

7

Authentication failure.

8

Internal software error.

9

Operating system error.

Basic Options

-i interface_name

--ui=interface_name

Specifies the user interface. Use command --list-ui to get a list of all possible interfaces.

--ui-param=name:value

Passes a parameter to the user interface. Multiple --ui-param options may be specified. Use command --list-ui-params to get list of all possible parameters.

--debug=integer

Sets the debugging information output level. The program sends debugging info to the standard error stream. Level 0 means output of fatal errors only. The more the value, the more info is sent to the output. The default value is 2.

--no-headers

Disables printing of the header line in all lists.

--daemon

Detach from controlling terminal.

Commands

-d

--dial

Dial.

-s

--disconnect

Disconnect.

-e

--erase

Delete the account.

-c

--create

Create a new account and print its identifier.

-m

--modify

Modify the existing account.

-p

--print

Print the account.

--print-full

Print the account with all default values.

-l

--list-accounts

List accounts. Prints a table, the first column contains identifiers, the second column contains account names.

--list-ui

List installed user interfaces. Prints a table, the first column shows interface names, the second column shows interface types, the third column shows the author, the 4-th column shows the description.

--list-ui-params

List parameters that the currently selected user interface can process. Prints a table, the first column contains parameter names, the second column shows the parameter type, the third column shows the description.

--list-acc-attrs

List all possible account attributes. Prints a table, the first column contains attribute names, the second column shows the attribute type.

-q

--quit

Disconnect and terminate existing process (if there is no such process, Chestnut Dialer notifies you).

-?

--help

Print short usage info.

--version

Print the program name and version.

Command Options

-a integer

--account=integer

Selects the account by the ID number.

-n name

--account-name=name

Selects the account by the name. First account whose name contains a value of given argument will be selected. Search is not case sensitive.

Account Attributes

See a description of all account attributes in Account Attributes.

Keyword unset resets an attribute to its default value.

Values of boolean attributes can be specified as: ‘on’ or ‘off’, or ‘yes’ or ‘no’, or ‘1’ or ‘0’. The value for a list attribute may be specified as a list of values separated by commas.

Examples

Create an account:

chestnut-dialer -c name="CoolOnline" phone_numbers=555,666 \
user=larry passwd=secret

Dial using account CoolOnline (CoolOnline is the account name).

chestnut-dialer -i none -dn CoolOnline

Dial using a modified account with account identifier 1 (the program does not save new attribute values, it uses the new attibute values for one connection only):

chestnut-dialer -i none -da 1 phone_numbers=777 redial_attempts=5

Modify account CoolOnline:

chestnut-dialer -mn CoolOnline phone_numbers=777 redial_attempts=5

Print account 1 (1 is the account identifier):

chestnut-dialer -pa 1

Delete account 1 (1 is the account identifier):

chestnut-dialer -ea 1