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 [--log-enable <0|1> | -l <0|1|2>]
21 [--log-dir <directory> | -L <directory>]
22 [--module <module name> | -m <module name>]
23 [--noexit | -X]
24 [--pidfile <file> | -p <file>]
25 [--PopupTime <0-5> | -t <0-5 seconds>]
26 [--ring <0-9|-1|-2|-3|-9> | -r <0-9|-1|-2|-3|-9>]
27 [--verbose <1-9> | -v <1-9>]
28 [--version | -V]
29 [--wakeup | -W]
30 Arguments:
32 [PORT_NUMBER] [HOSTNAME|IP_ADDRESS]
34
36 The ncid client displays Caller ID information sent to it by the NCID
37 server. In the default GUI mode, if the server is configured to send
38 the Call Log, it will load the call log in the call history window at
39 startup. The history window is then updated by ncid whenever a call is
40 received.
41 The minimum size of the client window at startup displays 8 columns and
43 5 rows in the history window. The user can resize the window bigger,
44 but not smaller than the minimum size. The user can select which col‐
45 umns to display in the history window, but must select at least 3 col‐
46 umns.
47 The history window displays one line per call or message in columns.
49 Each line starts with a line label and has a context menu. Column
50 headers and most line columns have a tooltip to display more informa‐
51 tion. The help menu displays information about each topic listed.
52 The view window shows all Line Types that can appear in the history
54 window. The view window also shows all LineIDS that do appear in the
55 history window. The view menu can select Line Types and LineIDS for
56 viewing. Those not selected have a horizontal line through them.
57 The message window will send a user typed single line message to the
59 server which, in turn, will send it to all connected clients.
60 The ncid client supports three themes:
62 Day: Color theme on a white background.
64 Night: Color theme on a black background.
66 Default: Black and white theme.
68 The ncid client supports multiple languages. Supported languages are
70 in the Help menu. The default language is English.
71 The ncid client runs on Linux, Windows and Mac OS X. If ncid is given
73 the --no-gui option, it will run without a GUI.
74 If ncid is given the --module <module name> option, it will output to
76 either an external program or output module. The ncid client can be
77 configured to call any single module. It cannot call multiple modules,
78 but multiple clients can be used, each calling a different output mod‐
79 ule.
80 If ncid is configured to output to an external program, it will test
82 for it and if it is not found, or if it is not executable, it will ter‐
83 minate with an error message.
84 The default configuration file for ncid is /etc/ncid/ncid.conf.
86 The distributed output modules are listed in the ncid_modules man page.
88 They are customized as needed in the /etc/ncid/conf.d/ncid-<module
89 name>.conf files.
90 Whenever the server connection is broken, ncid will normally try to re‐
92 connect every 15 seconds. It provides a visual indication of the
93 countdown and number of tries. If the delay between attempts is set to
94 zero seconds, ncid will not attempt a reconnect.
95
97 --no-gui
98 Do not display CID information using a GUI.
99 Default: display CID using a GUI
101 --alt-date | -A
103 Display the date in an alternate format. Assuming the date sep‐
104 arator is a "/", the date is displayed as dd/mm/yyyy.
105 Default: display the date as mm/dd/yyyy
107 --call-log | -c
109 Configure ncid to tell the server to send the call log. Only
110 used in the NoGUI mode.
111 Default: the call log is not sent
113 --debug | -D
115 Debug mode. Displays all log messages sent to the client log‐
116 file.
117 Default: Verbose 3
119 --delay <seconds> | -D <seconds>
121 If <seconds> > 0, delay <seconds> between server connection at‐
122 tempts.
123 If <seconds> = 0, only one attempt to reconnect to server will be made.
125 Default: 15 seconds
127 --help | -h
129 Display usage.
130 --hostname-flag | -H
132 Changes the LINE field to <hostname>:ncid for created messages
133 and adds <hostname> to the IDENT string
134 Default LINE field: ncid
136 --log-enable | -l
138 LogEnable can be set from 0-2.
139 If LogEnable = 0:
141 * do not write to log file (disabled)
142 If LogEnable = 1:
144 * embed process ID xxx in log file name: ncid-xxx.log
145 If LogEnable = 2:
147 * overwrite log file
148 * Use the OS name or hostname in log file name:
149 ncid-<OS|hostname>.log
150 * Be careful you don't launch multiple processes or they
151 will step on each other!
152 Default: 2
154 --log-dir | -L
156 Set the directory for log files. It can be an absolute or rela‐
157 tive path. A relative path should only be used when the
158 ncid.conf file is in the same directory as the running client
159 script, an indication the client is running on a limited OS,
160 e.g. Android.
161 Examples: set LogDir "/tmp/logs"
163 set LogDir "logs"
164 Default: $HOME/NCID/client
166 --module <module name> | -m <module name>
168 Output the Caller ID information to the external program or out‐
169 put module. <module name> is the name of the output module
170 (program) to use. The selected module is sent all calls and
171 messages.
172 Default module PATH: /usr/share/ncid/modules
174 --noexit | -X
176 Configure ncid to ignore the close window button.
177 --pidfile | -p
179 Name of PID file to create. Set to /var/run/ncid.pid in an rc
180 or init script when used as a service. Set to /var/run/<module
181 name>.pid in an rc or init script when used as a service and
182 when using a output module. There is no default. If pidfile is
183 not set, no pid file will be used.
184 --PopupTime <seconds> | -t <seconds>
186 Time the popup is forced to stay on top of all windows. Range
187 is 1 second to 5 seconds, or 0 to disable.
188 Default popup time: 1 second
190 --ring <count> | -r <count>
192 Execute output module on specific ring count.
193 All count values: -9 -3 -2 -1 0 2 3 4 5 6 7 8 9
194 For modems that indicate RING, count can be: -9 0 2 3 4 5 6 7 8 9
195 A count of -9 executes the output module on each ring.
196 A count of 0 executes the output module when ringing stops.
197 A count of 1 should never be used in the US/Canada,
198 because Caller ID is sent between rings 1 and 2.
199 A count between 2-9 executes the output module on that ring number.
200 A count greater than 9 is not useful.
201 For VoIP, using a SIP gateway, count is: -3 -2 -1
202 For POTS, using a wc2ncid gateway, count is: -2 -1
203 A count of -1 executes the output module on call termination without pickup.
204 A count of -2 executes the output module on call termination after pickup.
205 A count of -3 executes the output module on line busy termination.
206 Default: output module called as soon as CID received
208 --verbose <0-9> | -v <0-9>
210 Verbose mode. Verbose mode. Sends information to the client
211 logfile and displays information for the -D option. Set a
212 higher number for more information. Verbose mode 0 turns of
213 logging.
214 Default: Verbose 1
216 --version | -V
218 Display version and exit.
219 --wakeup | -W
221 Works only on X-Windows and Gnome. On the first ring, this
222 causes module ncid-wakeup to be executed to wake the monitor
223 and/or exit the screensaver. Do not use with the "--module |
224 -m" option.
225
227 PORT_NUMBER Set the port number.
228 Default: 3333
230 HOSTNAME|IP_ADDRESS Set the HOSTNAME or IP_Address.
232 Default: 127.0.0.1 (localhost)
234
236 /etc/ncid/ncid.conf
237 /etc/ncid/conf.d/ncid-*
238 /usr/share/ncid/modules/*
239
241 # Display the date as dd/mm/yyyy
242 ncid --alt-date
243 # run ncid in a terminal window, server on remote host
245 ncid --no-gui tardis.drwho.home
246 # only speak Caller ID
248 ncid --no-gui --module ncid-speak
249 # send CID output to GUI and desktop alert messages
251 ncid --module ncid-alert
252 # send CID output to a cell phone
254 ncid --no-gui --module ncid-page
255 # run ncid in a terminal window and tell the server to send the call log
257 ncid --no-gui --call-log
258
260 ncid.conf.5, ncid_modules.7, ncidd.8
261NCID 2023-6-24 NCID(1)