1NCIDD(8) System Manager's Manual NCIDD(8)
2
6 ncidd - Network Caller ID Server
7
9 ncidd [options]
10 Options:
12 [-A <aliasfile> | --alias <aliasfile>]
14 [-C <configfile> | --config <configfile>]
15 [-c <logfile> | --cidlog <logfile>]
16 [-D | --debug]
17 [-d <logfile> | --datalog <logfile>]
18 [-e <identifier> | --lineid <identifier>]
19 [-h | --help]
20 [-I <modemstr> | --initstr <modemstr>]
21 [-i <cidstr> | --initcid <cidstr>]
22 [-L <logfile> | --logfile <logfile>]
23 [-l <lockfile> | --lockfile <lockfile>]
24 [-M <MaxBytes> | --cidlogmax <MaxBytes>]
25 [-N <0|1> | --noserial <0|1]
26 [-n <0|1> | --nomodem <0|1]
27 [-P <pidfile> | --pidfile <pidfile>]
28 [-p <portnumber> | --port <portnumber>]
29 [-S <0|1> | --ttyclocal <0|1]
30 [-s <datatype> | --send <datatype>]
31 [-T <ttyspeed> | --ttyspeed <ttyspeed>]
32 [-t <ttyport> | --ttyport <ttyport>]
33 [-V | --version]
34 [-v <1-9> | --verbose <1-9>]
35
37 NCIDD collects Caller ID data from:
38 - a modem or CID device on a telephone line
40 - a CID gateway on the network
41 - or both
42 It formats the data on a single text line, and then sends it to one or
44 more Network CallerID (NCID) clients over TCP/IP. NCIDD also allows an
45 alias for the number, an alias for the name, and an alias for the tele‐
46 phone line identifier.
47 The telephone company limits names to 15 upper case characters, so by
49 using the alias function, you can display the name as you would like to
50 view it, or correct a name that was truncated. You can even change or
51 mask a telephone number.
52 NCIDD can be configured to send a CIDINFO line to clients at each ring
54 and when ringing stops. It contains a LINE (called telephone line)
55 indicator and a RING indicator.
56 If the Caller ID is obtained from a modem, and the modem supports it,
58 the server will include a ring count in each CIDINFO line. When ring‐
59 ing stops, the ring count will be zero. This allows, for example, a
60 client to send the call information to a pager or cell phone on a spe‐
61 cific ring count. If the ring count is not reached, it is assumed the
62 phone was answered and there is no need to send a page or cell phone
63 notification.
64 If ncidd is using a modem that indicates ring but not Caller ID, ncidd
66 will generate call data on ring number 2 and send it to the connect
67 clients. The number will be "RING" and the name will be "No Caller
68 ID".
69 If the Caller ID is obtained from a SIP Gateway the CIDINFO line is
71 only sent at the begining and end of a call. At the end of a call,
72 RING indicates either Hangup Without Answer or Hangup after Answer This
73 allows a cell phone or pager to receive a message only if the phone was
74 not answered.
75 NCIDD will accept a text message for a client, and then send it to all
77 connected clients, including the one that sent it.
78 NCIDD will accept a CID message from a client. A CID message contains
80 the Caller ID information from a CID client instead of a serial device
81 or modem.
82 NCIDD will accept a CIDINFO message from a client. A SIP client will
84 send a CIDINFO message when it receives a CANCEL command. The server
85 will then send a ring count of -1 to its clients to indicate a hangup
86 with no answer.
87 NCIDD will reload the alias file when sent a SIGHUP signal.
89
91 -A <file> | --alias <file>
92 Alias file.
93 Default: /etc/ncid/ncidd.alias
94 -C <file> | --config <file>
95 Config file.
96 Default: /etc/ncid/ncidd.conf
97 -c <file> | --cidlog <file>
98 Call log data file.
99 Default: /var/log/cidcall.log
100 -D | --debug
101 Debug mode.
102 -d <file> | --datalog <file>
103 Data log data file, usually from a modem.
104 Default: /var/log/datalog.log
105 -e <identifier> | --lineid <identifier>
106 The telephone line identifier is for a modem. It is normally 1
107 to 4 characters. The default indicator is not displayed, but
108 for one POTS line, you could change it to POTS. For multiple
109 lines you should use a identifier. You could change it to the 4
110 digit extension for an exchange. For example, if the telephone
111 number is 321-555-1212 the identifier whould be 1212.
112 Default: -
113 -h | --help
114 Display a help message.
115 -I string | --initstr string
116 Modem initialization string
117 Default: ATE1V1Q0
118 -i string | --initcid string
119 CID initialization string
120 Default: AT+VCID=1
121 if it fails: AT#CID=1
122 -L <file> | --logfile <file>
123 Server logfile.
124 Default: /var/log/ncidd.log
125 -l <file> | --lockfile <file>
126 Modem lockfile.
127 Default: /var/lock/LCK..modem
128 -M <MaxBytes> | --cidlogmax <MaxBytes>
129 Set the maximum CID call log file size in bytes.
130 Maximum size is 100000000
131 Default: cidlogmax = 110000
132 -N <0|1> | --noserial <0|1>
133 serial device (0) or no serial device (1)
134 Default: noserial = 0
135 -n <0|1> | --nomodem <0|1>
136 modem (0) or no modem (1)
137 Default: nomodem = 0
138 -P <pidfile> | --pidfile <pidfile>
139 Server PID file. Set to /var/run/ncidd.pid in a rc or init
140 script when used as a service. The program will still run if it
141 does not have permission to write a pidfile. There is no
142 default. If pidfile is not set, no pid file will be used.
143 -p <port> | --port <port>
144 Server port.
145 Default: 3333
146 -S <0|1> | --ttyclocal <0|1>
147 Enable (0) or disable (1) modem control signals.
148 Default: modem control signals disabled
149 -s <datatype> | --send <datatype>
150 Send optional CID data to a client. Where datatype is:
151 cidlog: sent when the client connects. If the CID call log gets
152 too big, it will not be sent.
153 cidinfo: sent on each ring, to all clients, gives the current
154 ring count.
155 Default: Optional CID DATA is not sent
156 -T <ttyspeed> | --ttyspeed <ttyspeed>
157 Set the tty port speed to one of: 19200, 9600, 4800
158 Default: ttyspeed = 19200
159 -t <ttyport> | --ttyport <ttyport>
160 Modem device file, or serial port that provides Caller ID infor‐
161 mation.
162 Default: /dev/modem
163 -V | --version
164 Display the version number.
165 -v <1-9> | --verbose <1-9>
166 Output information, used for the logfile and the -D option. Set
167 higher number for more information. Do not use level 9 unless
168 there is a problem in poll(). It grows the logfile very fast.
169 Default: verbose = 1
170 Most Useful: verbose = 3
171
173 The ncidd.conf(5) file is used to set options. The syntax of the
174 ncidd.conf(5) file is discussed seperately, and should be consulted for
175 detailed reference information.
176 The ncidd.alias(5) file is used to create aliases. The syntax of the
178 ncidd.alias(5) file is discussed seperately, and should be consulted
179 for detailed reference information.
180
182 These are five examples of the three types of lines sent to NCID
183 clients. The first field is line identifier.
184 The CID: line gives the CID information of the current call.
186 The CIDLOG: line gives the CID information of a line in the CID log
188 file.
189 The MSG: line gives messages from the server.
191 The MSGLOG: line gives a message logged in the CID log file.
193 The CIDINFO: line gives a line number and ring count from the server.
195 The ring count starts at 1 and increases until ringing ends, at which
196 time a count of 0 is sent. The line number default is 1, Distinctive
197 Ring will add one of the letters: A B C D to indicate the virtual line
198 called. Expect additional name/values pairs to be added in the future.
199 The CID: and CIDLOG: lines are identical, with data stored as name and
201 value pairs. Clients should always locate the line identifier, and
202 then scan for a field name and get its value. It's possible that addi‐
203 tional name/value pairs may be added in the future.
204 The MSG: and MSGLOG: lines are identical,
206 CID: *DATE*mmddyyyy*TIME*hhmm*NMBR*number*MESG*NONE*NAME*name*
208 CIDLOG: *DATE*mmddyyyy*TIME*hhmm*NMBR*number*MESG*NONE*NAME*name*
209 CIDINFO: *LINE*line indicator*RING*ringcount*
210 MSG: Too many clients connected: 15
211 MSGLOG: Too many clients connected: 15
212
214 cidcall.log Contains CID and MSG lines
215 ciddata.log Contains the output from the modem or CID device
216 ncidd.log Server log file. Contents controlled by verbose.
217
219 Return Code Meaning
220 ----------- -------
221 0 Successful
222 -100 Usage
223 -101 Invalid port number
224 -102 TTY lockfile exists
225 -103 Unable to set modem for Caller ID
226 -104 Configuration file error
227 -105 No modem found
228 -106 Invalid data type.
229 -107 Invalid number
230 -108 Invalid tty port speed [set in config file]
231 -109 Alias file error
232 -110 PID file already exists
233 -111 Cannot init TTY
234 -112 Serial device error
235 -113 string too long
236 -? System error
237
239 ncid.1, ncidtools.1, lcdncid.1, out2osd.1, ncidd.conf.5, ncidd.alias.5,
240 ncid.conf.5
241 NCIDD(8)