ncid (1) - Linux Manuals

ncid: Network Caller ID Client

NAME

ncid - Network Caller ID Client

SYNOPSIS

ncid [options] [arguments]

tivocid [options] [arguments]

tivoncid [options] [arguments]

Options:

[--no-gui]
[--call-prog         | -C]
[--delay seconds     | -D seconds]
[--message           | -M]
[--nocid             | -N]
[--program PROGRAM   | -P PROGRAM]
[--pidfile FILE      | -p PIDFILE]
[--raw               | -R]
[--ring count        | -r count]
[--tivo              | -T]
[--PopupTime seconds | -t seconds]
[--verbose           | -V]

Arguments:

[IP_ADDRESS | HOSTNAME]
[PORT_NUMBER]

DESCRIPTION

Ncid displays Caller ID information sent to it by the Caller ID server. In the default GUI mode, if the server is configured to send the CID Call Log, it will load the call log in the CID log window at startup. The call log is updated by ncid whenever a call is received.

Ncid can also display Phone Call if the modem used by the server does not send the Caller ID information to it. This is useful if a visual indication is wanted for ringing.

Ncid also has a message window that will send a single line message to the server which, in turn, will send it to all connected clients.

Ncid runs on Linux and Windows 98, ME, XP, 2000, NT. In the GUI mode, it will pop up, and go on top whenever a call comes in. In addition, it will display itself on whatever desktop is active in Linux. If ncid is given the --no-gui option, it will either output to a external program, output module, or use the verbose mode to display the CID information in a terminal window.

If ncid is named tivocid, it will start in a no-gui mode and output to a external program called out2osd which displays the Caller ID on a TV using a TiVo.

If ncid is named tivoncid, it will start in a no-gui mode and output to a module called ncid-tivo which displays the Caller ID on a TV using a TiVo. This option uses the TiVo program, text2osd, instead of out2osd.

If ncid is configured to output to a external program, it will test for it, and if it is not found, or if it is not executable, it will terminate with a error message.

The configuration file for ncid is /etc/ncid/ncid.conf.

The distributed output modules are listed in the ncidmodules man page, can be customized as needed in the /etc/ncid/ncidmodules.conf file:

Whenever the server connection is broken, ncid will normally try to reconnect once a minute. It provides a visual record of the countdown and number of tries. If the delay between attempts is set to zero seconds, ncid will not attempt a reconnect.

The file menu provides three menu items in the GUI mode:

reconnect

provides an immediate reconnect and a reload of the call log file. This provides a way to synchronize ncid with the server call log in the event of a network problem.

clear

clears the call log

quit

terminates ncid.

OPTIONS

--no-gui

Do not display CID information using a GUI
Default: display CID using a GUI, except if called tivocid

--call-prog | -C

Output the Caller ID information to a external program or output module.
Default: does not call a external program unless name is tivocid or tivoncid

--delay SECONDS | -D SECONDS

Delay SECONDS between server connection attempts if SECONDS > 0.
Only one attempt to connect to server if SECONDS = 0.
Default: 60 seconds

--message | -M

Send messages to the output modules

--nocid | -N

Configure ncid to indicate Phone Call on the first ring received from the modem. It requires a modem that indicates ring, but does not require a modem that supports caller id.

--pidfile | -p

Name of PID file to create. Set to /var/run/ncid.pid in a rc or init script when used as a service. Set to /var/run/OUTPUTMODULE.pid in a rc or init script when used as a service and when using a output module. There is no default. If pidfile is not set, no pid file will be used.

--program PROGRAM | -P PROGRAM

Name of the output module (program) to use. Some output modules are ncid-kpopup, ncid-page, and ncid-speak.
Default PATH: /usr/share/ncid
Default PROGRAM: ncid-speak

--raw | -R

display data received from the CID Server
Default: raw data not displayed

--ring count | -r count

Call output module on specific ring count.
For modems that indicate RING, count can be: 0 2 3 4 5 6 7 8 9
For VoIP, using a SIP gateway, count can be: -2 -1
A count of -1 incdicates a hangup before answer.
A count of -2 incdicates a hangup after answer.
Default: output module called as soon as CID received

--Tivo | -T

This option is for a TiVo using out2osd or text2osd
Changes output to 2 lines: name number line
Default output is 5 lines: date time number name line

--PopupTime seconds | -t seconds

Time for the popup to stay on top of all windows. Range is 1 second to 99 seconds
Default popup time os 5 seconds

--verbose | -V

display formatted CID information, including CID log file
Default: silent

Arguments

IP_ADDRESS | HOSTNAME

set the IP Address
Default: 127.0.0.1 (localhost)

PORT_NUMBER

set the port number
Default: 3333

FILES

/etc/ncid/*
/usr/share/ncid/*

EXAMPLES

# run ncid in a terminal window, server on remote host
ncid --no-gui tardis.drwho.home

# only speak Caller ID
ncid --no-gui --call-prog --program ncid-speak

# send CID output to GUI and speak it
ncid --call-prog --program /usr/local/bin/ncid-speak

# send CID output to a cell phone after third ring
ncid --no-gui --call-prog --program ncid-page --ring 3

# send CID output to a cell phone on hangup before answer
ncid --no-gui --call-prog --program ncid-page --ring -1

# indicate ring on a popup module as a message
ncid --no-gui --nocid --message --call-prog --program ncid-kpopup

# run ncid on a TiVo using out2osd, server on remote host
tivocid 192.168.0.1