1NCID(1) NCID NCID(1)
2
6 ncid - Network Caller ID Client
7
9 ncid [options] [arguments]
10 Options:
12 [--no-gui]
14 [--alt-date | -A]
15 [--call-log | -c]
16 [--debug | -D]
17 [--delay <seconds> | -d <seconds>]
18 [--help | -h]
19 [--hostname-flag | -H]
20 [--module <module name> | -m <module name>]
21 [--noexit | -X]
22 [--pidfile <file> | -p <file>]
23 [--PopupTime <0-5> | -t <0-5 seconds>]
24 [--ring <0-9|-1|-2|-3|-9> | -r <0-9|-1|-2|-3|-9>]
25 [--verbose <1-9> | -v <1-9>]
26 [--version | -V]
27 [--wakeup | -W]
28 Arguments:
30 [IP_ADDRESS | HOSTNAME]
32 [PORT_NUMBER]
33
35 The ncid client displays Caller ID information sent to it by the NCID
36 server. In the default GUI mode, if the server is configured to send
37 the Call Log, it will load the call log in the call history window at
38 startup. The history window is then updated by ncid whenever a call is
39 received.
40 The minimum size of the client window at startup displays 8 columns and
42 5 rows in the history window. The user can resize the window bigger,
43 but not smaller than the minimum size. The user can select which col‐
44 umns to display in the history window, but must select at least 3 col‐
45 umns.
46 The history window displays one line per call or message in columns.
48 Each line starts with a line label and has a context menu. Column
49 headers and most line columns have a tooltip to display more informa‐
50 tion. The help menu displays information about each topic listed.
51 The view window shows all Line Types that can appear in the history
53 window. The view window also shows all LineIDS that do appear in the
54 history window. The view menu can select Line Types and LineIDS for
55 viewing. Those not selected have a horizontal line through them.
56 The message window will send a user typed single line message to the
58 server which, in turn, will send it to all connected clients.
59 The ncid client supports three themes:
61 Day: Color theme on a white background.
63 Night: Color theme on a black background.
64 Default: Black and white theme.
65 The ncid client supports multiple languages. Supported languages are
67 in the Help menu. The default language is English.
68 The ncid client runs on Linux, Windows and Mac OS X. If ncid is given
70 the --no-gui option, it will run without a GUI.
71 If ncid is given the --module <module name> option, it will output to
73 either an external program or output module. The ncid client can be
74 configured to call any single module. It cannot call multiple modules,
75 but multiple clients can be used, each calling a different output mod‐
76 ule.
77 If ncid is configured to output to an external program, it will test
79 for it and if it is not found, or if it is not executable, it will ter‐
80 minate with an error message.
81 The default configuration file for ncid is /etc/ncid/ncid.conf.
83 The distributed output modules are listed in the ncid_modules man page.
85 They are customized as needed in the /etc/ncid/conf.d/ncid-<module
86 name>.conf files.
87 Whenever the server connection is broken, ncid will normally try to re‐
89 connect every 15 seconds. It provides a visual indication of the
90 countdown and number of tries. If the delay between attempts is set to
91 zero seconds, ncid will not attempt a reconnect.
92
94 --no-gui
95 Do not display CID information using a GUI.
96 Default: display CID using a GUI.
98 --alt-date | -A
100 Display the date in an alternate format. Assuming the date sep‐
101 arator is a "/", the date is displayed as dd/mm/yyyy.
102 Default: display the date as mm/dd/yyyy
104 --call-log | -c
106 Configure ncid to tell the server to send the call log. Only
107 used in the NoGUI mode.
108 Default: the call log is not sent
110 --debug | -D
112 Debug mode. Displays all log messages sent to the client log‐
113 file. Default: Verbose 3
114 --delay <seconds> | -D <seconds>
116 If <seconds> > 0, delay <seconds> between server connection at‐
117 tempts.
118 If <seconds> = 0, only one attempt to reconnect to server will
119 be made.
120 Default: 15 seconds
122 --help | -h
124 Display usage.
125 --hostname-flag | -H
127 Changes the LINE field to <hostname>:ncid for created messages
128 and adds <hostname> to the IDENT string
129 Default LINE field: ncid.
131 --module <module name> | -m <module name>
133 Output the Caller ID information to the external program or out‐
134 put module. <module name> is the name of the output module
135 (program) to use. The selected module is sent all calls and
136 messages.
137 Default module PATH: /usr/share/ncid/modules
139 --noexit | -X
141 Configure ncid to ignore the close window button.
142 --pidfile | -p
144 Name of PID file to create. Set to /var/run/ncid.pid in an rc
145 or init script when used as a service. Set to /var/run/<module
146 name>.pid in an rc or init script when used as a service and
147 when using a output module. There is no default. If pidfile is
148 not set, no pid file will be used.
149 --PopupTime <seconds> | -t <seconds>
151 Time the popup is forced to stay on top of all windows. Range
152 is 1 second to 5 seconds, or 0 to disable.
153 Default popup time is 1 second.
155 --ring <count> | -r <count>
157 Execute output module on specific ring count.
158 All count values: -9 -3 -2 -1 0 2 3 4 5 6 7 8 9
159 For modems that indicate RING, count can be: -9 0 2 3 4 5 6 7 8
161 9
162 A count of -9 executes the output module on each ring.
163 A count of 0 executes the output module when ringing stops.
164 A count of 1 should never be used in the US/Canada, because
165 Caller ID is sent between rings 1 and 2.
166 A count between 2-9 executes the output module on that ring num‐
167 ber.
168 A count greater than 9 is not useful.
169 For VoIP, using a SIP gateway, count is: -3 -2 -1
171 For POTS, using a wc2ncid gateway, count is: -2 -1
172 A count of -1 executes the output module on call termination
173 without pickup.
174 A count of -2 executes the output module on call termination af‐
175 ter pickup.
176 A count of -3 executes the output module on line busy termina‐
177 tion.
178 Default: output module called as soon as CID received
180 --verbose <0-9> | -v <0-9>
182 Verbose mode. Verbose mode. Sends information to the client
183 logfile and displays information for the -D option. Set a
184 higher number for more information. Verbose mode 0 turns of
185 logging. Default: Verbose 1
186 Default: silent
188 --version | -V
190 Display version and exit.
191 --wakeup | -W
193 Works only on X-Windows and Gnome. On the first ring, this
194 causes module ncid-wakeup to be executed to wake the monitor
195 and/or exit the screensaver. Do not use with the "--module |
196 -m" option.
197
199 IP_ADDRESS | HOSTNAME Set the IP Address.
200 Default: 127.0.0.1 (localhost)
202 PORT_NUMBER Set the port number.
204 Default: 3333
206
208 /etc/ncid/ncid.conf
209 /etc/ncid/conf.d/ncid-*
210 /usr/share/ncid/modules/*
211
213 # Display the date as dd/mm/yyyy
214 ncid --alt-date
215 # run ncid in a terminal window, server on remote host
217 ncid --no-gui tardis.drwho.home
218 # only speak Caller ID
220 ncid --no-gui --module ncid-speak
221 # send CID output to GUI and desktop alert messages
223 ncid --module ncid-alert
224 # send CID output to a cell phone
226 ncid --no-gui --module ncid-page
227 # run ncid in a terminal window and tell the server to send the call log
229 ncid --no-gui --call-log
230
232 ncid.conf.5, ncid_modules.7, ncidd.8
233NCID 2021-11-15 NCID(1)