ncid(1) - f35

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       [--delay <seconds>        | -D <seconds>]
17       [--help                   | -h]
18       [--hostname-flag          | -H]
19       [--module <module name>   | -m <module name>]
20       [--noexit                 | -X]
21       [--pidfile <file>         | -p <file>]
22       [--PopupTime <0-5>        | -t <0-5 seconds>]
23       [--ring <0-9|-1|-2|-3|-9> | -r <0-9|-1|-2|-3|-9>]
24       [--verbose <1-9>          | -v <1-9>]
25       [--version                | -V]
26       [--wakeup                 | -W]
27
28       Arguments:
29
30       [IP_ADDRESS | HOSTNAME]
31       [PORT_NUMBER]
32

DESCRIPTION

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

OPTIONS

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

ARGUMENTS

185       IP_ADDRESS | HOSTNAME         Set the IP Address.
186
187                                     Default: 127.0.0.1 (localhost)
188
189       PORT_NUMBER                   Set the port number.
190
191                                     Default: 3333
192

FILES

194       /etc/ncid/ncid.conf
195       /etc/ncid/conf.d/ncid-*
196       /usr/share/ncid/modules/*
197

EXAMPLES

199       # Display the date as dd/mm/yyyy
200       ncid --alt-date
201
202       # run ncid in a terminal window, server on remote host
203       ncid --no-gui tardis.drwho.home
204
205       # only speak Caller ID
206       ncid --no-gui --module ncid-speak
207
208       # send CID output to GUI and desktop alert messages
209       ncid --module ncid-alert
210
211       # send CID output to a cell phone
212       ncid --no-gui --module ncid-page
213
214       # run ncid in a terminal window and tell the server to send the call log
215       ncid --no-gui --call-log
216