1NCID(1) General Commands Manual NCID(1)
2
6 ncid - Network Caller ID Client
7
9 ncid [options] [arguments]
10 tivocid [options] [arguments]
12 tivoncid [options] [arguments]
14 Options:
16 [--no-gui]
18 [--call-prog | -C]
19 [--delay seconds | -D seconds]
20 [--message | -M]
21 [--noexit | -X]
22 [--program PROGRAM | -P PROGRAM]
23 [--pidfile FILE | -p PIDFILE]
24 [--raw | -R]
25 [--ring count | -r count]
26 [--tivo | -T]
27 [--PopupTime seconds | -t seconds]
28 [--verbose | -V]
29 Arguments:
31 [IP_ADDRESS | HOSTNAME]
33 [PORT_NUMBER]
34
36 Ncid displays Caller ID information sent to it by the Caller ID server.
37 In the default GUI mode, if the server is configured to send the CID
38 Call Log, it will load the call log in the CID log window at startup.
39 The call log is updated by ncid whenever a call is received.
40 Ncid also has a message window that will send a single line message to
42 the server which, in turn, will send it to all connected clients.
43 Ncid runs on Linux and Windows 98, ME, XP, 2000, NT. In the GUI mode,
45 it will pop up, and go on top whenever a call comes in. In addition,
46 it will display itself on whatever desktop is active in Linux. If ncid
47 is given the --no-gui option, it will either output to a external pro‐
48 gram, output module, or use the verbose mode to display the CID infor‐
49 mation in a terminal window.
50 If ncid is named tivocid, it will start in a no-gui mode and output to
52 a external program called out2osd which displays the Caller ID on a TV
53 using a TiVo.
54 If ncid is named tivoncid, it will start in a no-gui mode and output to
56 a module called ncid-tivo which displays the Caller ID on a TV using a
57 TiVo. This option uses the TiVo program, text2osd, instead of out2osd.
58 If ncid is configured to output to a external program, it will test for
60 it, and if it is not found, or if it is not executable, it will termi‐
61 nate with a error message.
62 The configuration file for ncid is /etc/ncid/ncid.conf.
64 The distributed output modules are listed in the ncidmodules man page,
66 can be customized as needed in the /etc/ncid/ncidmodules.conf file:
67 Whenever the server connection is broken, ncid will normally try to
69 reconnect once a minute. It provides a visual record of the countdown
70 and number of tries. If the delay between attempts is set to zero sec‐
71 onds, ncid will not attempt a reconnect.
72 The file menu provides three menu items in the GUI mode:
74 reconnect provides an immediate reconnect and a reload of the call log
75 file. This provides a way to synchronize ncid with the
76 server call log in the event of a network problem.
77 clear clears the call log
78 quit terminates ncid.
79
81 --no-gui
82 Do not display CID information using a GUI
83 Default: display CID using a GUI, except if called tivocid
84 --call-prog | -C
85 Output the Caller ID information to a external program or output
86 module.
87 Default: does not call a external program unless name is tivocid
88 or tivoncid
89 --delay SECONDS | -D SECONDS
90 Delay SECONDS between server connection attempts if SECONDS > 0.
91 Only one attempt to connect to server if SECONDS = 0.
92 Default: 60 seconds
93 --message | -M
94 Send messages to the output modules --noexit | -X Configure ncid
95 to to ignore the close window button.
96 --pidfile | -p
97 Name of PID file to create. Set to /var/run/ncid.pid in a rc or
98 init script when used as a service. Set to /var/run/OUTPUTMOD‐
99 ULE.pid in a rc or init script when used as a service and when
100 using a output module. There is no default. If pidfile is not
101 set, no pid file will be used.
102 --program PROGRAM | -P PROGRAM
103 Name of the output module (program) to use. Some output modules
104 are ncid-kpopup, ncid-page, and ncid-speak.
105 Default PATH: /usr/share/ncid
106 Default PROGRAM: ncid-speak
107 --raw | -R
108 display data received from the CID Server
109 Default: raw data not displayed
110 --ring count | -r count
111 Call output module on specific ring count.
112 For modems that indicate RING, count can be: 0 2 3 4 5 6 7 8 9
113 For VoIP, using a SIP gateway, count can be: -2 -1
114 A count of -1 incdicates a hangup before answer.
115 A count of -2 incdicates a hangup after answer.
116 Default: output module called as soon as CID received
117 --Tivo | -T
118 This option is for a TiVo using out2osd or text2osd
119 Changes output to 2 lines: name number line
120 Default output is 5 lines: date time number name line
121 --PopupTime seconds | -t seconds
122 Time for the popup to stay on top of all windows. Range is 1
123 second to 99 seconds
124 Default popup time os 5 seconds
125 --verbose | -V
126 display formatted CID information, including CID log file
127 Default: silent
128 Arguments
130 IP_ADDRESS | HOSTNAME set the IP Address
131 Default: 127.0.0.1 (localhost)
132 PORT_NUMBER set the port number
133 Default: 3333
134
136 /etc/ncid/*
137 /usr/share/ncid/*
138
140 # run ncid in a terminal window, server on remote host
141 ncid --no-gui tardis.drwho.home
142 # only speak Caller ID
144 ncid --no-gui --call-prog --program ncid-speak
145 # send CID output to GUI and speak it
147 ncid --call-prog --program /usr/local/bin/ncid-speak
148 # send CID output to a cell phone after third ring
150 ncid --no-gui --call-prog --program ncid-page --ring 3
151 # send CID output to a cell phone on hangup before answer
153 ncid --no-gui --call-prog --program ncid-page --ring -1
154 # indicate ring on a popup module as a message
156 ncid --no-gui --nocid --message --call-prog --program ncid-kpopup
157 # run ncid on a TiVo using out2osd, server on remote host
159 tivocid 192.168.0.1
160
162 ncid.conf.5, ncidmodules.1, ncidmodules.conf.5, ncidd.8, ncidd.conf.5,
163 ncidd.alias.5, sip2ncid.8, sip2ncid.conf.5, ncidsip.8, ncidsip.conf.5
164 NCID(1)