ncid(1) - f34

1NCID(1)                              NCID                              NCID(1)
2
3
4

NAME

6       ncid - Network Caller ID Client
7

SYNOPSIS

9       ncid [options] [arguments]
10
11       Options:
12
13       [--no-gui]
14       [--alt-date               | -A]
15       [--call-log               | -c]
16       [--country <code>         | -C <country code>
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
29       Arguments:
30
31       [IP_ADDRESS | HOSTNAME]
32       [PORT_NUMBER]
33

DESCRIPTION

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
41       The  size  of  the  client  window  at startup is controlled by the the
42       ncid.conf file.  The user can resize the window, but there is a minimum
43       size restriction.
44
45       The  history  window  displays one line per call or message.  Each line
46       starts with a line label.  Under Help->Line Labels you can  read  about
47       each one.
48
49       The  view  window  shows  all Line Types that can appear in the history
50       window.  The view window also shows all LineIDS that do appear  in  the
51       history  window.   The  view menu can select Line Types and LineIDS for
52       viewing.  Those not selected have a horizontal line through them.
53
54       The message window will send a user typed single line  message  to  the
55       server which, in turn, will send it to all connected clients.
56
57       The ncid client supports three themes:
58
59              Day:      Color theme on a white background.
60              Night:    Color theme on a black background.
61              Default:  Black and white theme.
62
63       The  ncid client runs on Linux, Windows and Mac OS X.  If ncid is given
64       the --no-gui option, it will run without a GUI.
65
66       If ncid is given the --module <module name> option, it will  output  to
67       either  an  external  program or output module.  The ncid client can be
68       configured to call any single module.  It cannot call multiple modules,
69       but  multiple clients can be used, each calling a different output mod‐
70       ule.
71
72       If ncid is configured to output to an external program,  it  will  test
73       for it and if it is not found, or if it is not executable, it will ter‐
74       minate with an error message.
75
76       The default configuration file for ncid is /etc/ncid/ncid.conf.
77
78       The distributed output modules are listed in the ncid_modules man page.
79       They  are  customized  as  needed  in the /etc/ncid/conf.d/ncid-<module
80       name>.conf files.
81
82       Whenever the server connection is broken, ncid  will  normally  try  to
83       reconnect  every  15  seconds.   It provides a visual indication of the
84       countdown and number of tries.  If the delay between attempts is set to
85       zero seconds, ncid will not attempt a reconnect.
86

OPTIONS

88       --no-gui
89              Do not display CID information using a GUI.
90
91              Default: display CID using a GUI.
92
93       --alt-date | -A
94              Display the date in an alternate format.  Assuming the date sep‐
95              arator is a "/", the date is displayed as dd/mm/yyyy.
96
97              Default: display the date as mm/dd/yyyy
98
99       --call-log | -c
100              Configure ncid to tell the server to send the  call  log.   Only
101              used in the NoGUI mode.
102
103              Default: The call log is not sent.
104
105       --country-code <code> | -C <country code>
106              Configure the country code to format the phone number.
107
108              Supported Country Codes:
109
110              DE - Germany (was broken, for now same as NONE)
111              FR - France
112              HR - Croatia
113              SE - Sweden
114              UK - United Kingdom
115              US - North America
116              NONE - do not format number
117
118              Default: US country code
119
120       --delay <seconds> | -D <seconds>
121              If  <seconds>  >  0,  delay  <seconds> between server connection
122              attempts.
123              If <seconds> = 0, only one attempt to reconnect to  server  will
124              be made.
125
126              Default: 15 seconds
127
128       --help | -h
129              Display usage.
130
131       --hostname-flag | -H
132              Changes  the  LINE field to <hostname>:ncid for created messages
133              and adds <hostname> to the IDENT string
134
135              Default LINE field: ncid.
136
137       --module <module name> | -m <module name>
138              Output the Caller ID information to the external program or out‐
139              put  module.   <module  name>  is  the name of the output module
140              (program) to use.  The selected module is  sent  all  calls  and
141              messages.
142
143              Default module PATH: /usr/share/ncid/modules
144
145       --noexit | -X
146              Configure ncid to ignore the close window button.
147
148       --pidfile | -p
149              Name  of  PID file to create.  Set to /var/run/ncid.pid in an rc
150              or init script when used as a service.  Set to  /var/run/<module
151              name>.pid  in  an  rc  or init script when used as a service and
152              when using a output module.  There is no default.  If pidfile is
153              not set, no pid file will be used.
154
155       --PopupTime <seconds> | -t <seconds>
156              Time  the  popup is forced to stay on top of all windows.  Range
157              is 1 second to 5 seconds, or 0 to disable.
158
159              Default popup time is 1 second.
160
161       --ring <count> | -r <count>
162              Execute output module on specific ring count.
163              All count values: -9 -3 -2 -1 0 2 3 4 5 6 7 8 9
164
165              For modems that indicate RING, count can be: -9 0 2 3 4 5 6 7  8
166              9
167              A count of -9 executes the output module on each ring.
168              A count of 0 executes the output module when ringing stops.
169              A  count  of  1  should  never be used in the US/Canada, because
170              Caller ID is sent between rings 1 and 2.
171              A count between 2-9 executes the output module on that ring num‐
172              ber.
173              A count greater than 9 is not useful.
174
175              For VoIP, using a SIP gateway, count is: -3 -2 -1
176              For POTS, using a wc2ncid gateway, count is: -2 -1
177              A  count  of  -1  executes the output module on call termination
178              without pickup.
179              A count of -2 executes the output  module  on  call  termination
180              after pickup.
181              A  count  of -3 executes the output module on line busy termina‐
182              tion.
183
184              Default: output module called as soon as CID received
185
186       --verbose | -v
187              Display formatted CID information, including CID log file.
188
189              Default: silent
190
191       --version | -V
192              Display version and exit.
193
194       --wakeup | -W
195              Works only on X-Windows and  Gnome.  On  the  first  ring,  this
196              causes  module  ncid-wakeup  to  be executed to wake the monitor
197              and/or exit the screensaver.  Do not use with  the  "--module  |
198              -m" option.
199

ARGUMENTS

201       IP_ADDRESS | HOSTNAME         Set the IP Address.
202
203                                     Default: 127.0.0.1 (localhost)
204
205       PORT_NUMBER                   Set the port number.
206
207                                     Default: 3333
208

FILES

210       /etc/ncid/ncid.conf
211       /etc/ncid/conf.d/ncid-*
212       /usr/share/ncid/modules/*
213

EXAMPLES

215       # Display the date as dd/mm/yyyy
216       ncid --alt-date
217
218       # run ncid in a terminal window, server on remote host
219       ncid --no-gui tardis.drwho.home
220
221       # only speak Caller ID
222       ncid --no-gui --module ncid-speak
223
224       # send CID output to GUI and desktop alert messages
225       ncid --module ncid-alert
226
227       # send CID output to a cell phone
228       ncid --no-gui --module ncid-page
229
230       # run ncid in a terminal window and tell the server to send the call log
231       ncid --no-gui --call-log
232