ncid man page

ncid — Network Caller ID Client

Synopsis

ncid [options] [arguments]

tivocid [options] [arguments]

tivoncid [options] [arguments]

Options:

[--no-gui]
[--alt-date               | -A]
[--delay <seconds>        | -D <seconds>]
[--help                   | -h]
[--noexit                 | -X]
[--pidfile <file name>    | -p <file name>]
[--PopupTime <seconds>    | -t <seconds>]
[--program <program name> | -P <program name>]
[--ring <count>           | -r <count>]
[--tivo                   | -T]
[--verbose                | -v]
[--version                | -V]

Arguments:

[IP_ADDRESS | HOSTNAME]
[PORT_NUMBER]

Description

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

The size of the client window at startup is controlled by the the ncid.conf file. The user can resize the window, but there is a minimum size restriction.

The history window displays one line per call or message. Each line line starts with a call label. There are five call types and two message types that can be displayed:

CID:
Incoming Call
OUT:
Outgoing Call
HUP:
Blacklisted Call Hangup
BLK:
Blacklisted Call Block
PID:
CID from a smart phone
MSG:
User or NCID message
NOT:
Message from a smart phone

The ncid client 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.

The ncid client runs on Linux and Windows 98, ME, XP, 2000, NT and Mac OS X. 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 run without a GUI.

If ncid is given the --program <module> option, it will output to either a external program or output module. The ncid client can be configured to call any one module. It cannot call multiple modules, but multiple clients can be used, each calling a different output module.

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 ncid-modules man page, can be customized as needed in the /etc/ncid/conf.d/ncid-<name>.conf files.

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, unless called as tivocid or tivoncid.

--alt-date | -A

Display the date in a alternate format. Assuming the date separator is a "/", the date is displayed as dd/mm/yyyy.

Default: display the date as mm/dd/yyyy

--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

--help | -h
Display usage.
--noexit | -X
Configure ncid to to ignore the close window button.
--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

Output the Caller ID information to the external program or output module. PROGRAM is the name of the output module (program) to use. The selected module is sent all calls and messages.

Default module PATH: /usr/share/ncid/modules

--ring count | -r count

Call output module on specific ring count.
All count values: -9 -2 -1 0 2 3 4 5 6 7 8 9

For modems that indicate RING, count is: -9 0 2 3 4 5 6 7 8 9
A count of -9 indicates call on each ring.
A count of 0 indicates call when ringing stops.
A count of 1 should never be used, Caller ID is between 1 and 2.
A count between 2-9 indicates call on that ring number.
A count greater than 9 is not useful.

For VoIP, using a SIP or wc2ncid gateway, count is: -2 -1
A count of -1 indicates call on hangup with no answer.
A count of -2 indicates call on 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

--version | -V
Display version and quit.

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/modules/*

Examples

# Display the date as dd/mm/yyyy
ncid --alt-date

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

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

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

# send CID output to a cell phone
ncid --no-gui --program ncid-page

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

See Also

ncidd.8, sip2ncid.8, ncid2ncid.1, ncidrotate.1, yac2ncid.1, ncid-initmodem.1, ncid-kpopup.1, ncid-mythtv.1, ncid-notify.1, ncid-page.1, ncid-samba.1, ncid-skel.1, ncid-speak.1, ncid-yac.1, ncid.conf.5 , ncidtools.7

Info