ncid(1) - f30

1NCID(1)                     General Commands Manual                    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       [--night-mode]
15       [--alt-date               | -A]
16       [--call-log               | -c]
17       [--country <code>         | -C <country code>
18       [--delay <seconds>        | -D <seconds>]
19       [--help                   | -h]
20       [--hostname-flag          | -H]
21       [--noexit                 | -X]
22       [--pidfile <file>         | -p <file>]
23       [--PopupTime <0-5>        | -t <0-5 seconds>]
24       [--program <module name>  | -P <module name>]
25       [--ring <0-9|-1|-2|-3|-9> | -r <0-9|-1|-2|-3|-9>]
26       [--verbose <1-9>          | -v <1-9>]
27       [--version                | -V]
28       [--wakeup                 | -W]
29
30       Arguments:
31
32       [IP_ADDRESS | HOSTNAME]
33       [PORT_NUMBER]
34

DESCRIPTION

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

OPTIONS

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

ARGUMENTS

198       IP_ADDRESS | HOSTNAME         Set the IP Address.
199
200                                     Default: 127.0.0.1 (localhost)
201
202       PORT_NUMBER                   Set the port number.
203
204                                     Default: 3333
205

FILES

207       /etc/ncid/*
208       /usr/share/ncid/modules/*
209

EXAMPLES

211       # Display the date as dd/mm/yyyy
212       ncid --alt-date
213
214       # run ncid in a terminal window, server on remote host
215       ncid --no-gui tardis.drwho.home
216
217       # only speak Caller ID
218       ncid --no-gui --program ncid-speak
219
220       # send CID output to GUI and speak it
221       ncid --program ncid-speak
222
223       # send CID output to a cell phone
224       ncid --no-gui --program ncid-page
225
226       # run ncid in a terminal window and tell the server to send the call log
227       ncid --no-gui --call-log
228
229       # run ncid in the GUI mode with a Dark Theme
230       ncid --night-mode
231