1NCIDD.CONF(5)                 File Formats Manual                NCIDD.CONF(5)
2
3
4

NAME

6       ncidd.conf - ncidd configuration file
7

DESCRIPTION

9       The  ncidd.conf  file contains the configuration information for ncidd,
10       the Network Caller ID Server.
11
12       The ncidd.conf file is used to set options.  Options are set on a  com‐
13       mand  line.  A line is broken up into words.  A word is either a string
14       of non-blank characters, everything between double quotes, or an  equal
15       sign.
16
17       The ncidd.conf file understands 4 types of lines:
18
19       blank line
20              ignored
21
22       comment line, beginning with '#'
23              ignored
24
25       command lines, beginning with 'send'
26              send DATATYPE
27                  where DATATYPE = cidlog or cidinfo
28
29              Most  gateways  and  the command line option of ncid do not need
30              the cidlog.  They send a HELLO command at connect so the  server
31              does not send cidlog.
32
33       command lines, beginning with 'set'
34              set ITEM = VALUE [ITEM = VALUE] [...]
35
36              where ITEM =
37                     announce,   audiofmt,   blacklist,   cidalias,  cidinput,
38                     cidlog,  cidlogmax,  datalog,  gencid,  hangup,  hupmode,
39                     hupname,   huprmd,  ignore1,  initcid,  initstr,  lineid,
40                     lockfile, pickup, pidfile, port, regex, send,  ttyclocal,
41                     ttyport, ttyspeed, verbose, whitelist
42

EXAMPLES

44       Send the CID log to each client at connect:
45            send cidlog
46
47       Send the ring count, at each ring, to each client:
48            send cidinfo
49
50       Caller ID from a modem and optional gateways:
51            set cidinput = 0  # default
52
53       Caller ID from a serial or USB device and optional gateways:
54            set cidinput = 1
55
56       Caller ID from gateways without modem support:
57            set cidinput = 3
58
59       Caller  ID  from  a gateway with modem support for hangup and dialing a
60       number.  The gateway and modem must be using the same telephone line:
61            set cidinput = 2
62
63       Set the Telephone Line Indicator for the modem providing support to the
64       xdmf2ncid gateway when its gateway line indicator is "CometUSB0":
65            set lineid = CometUSB0
66
67       Set the Telephone Line Indicator for the modem providing support to the
68       xdmf2ncid gateway when its gateway line indicator is "HoltekUSB0":
69            set lineid = HoltekUSB0
70
71       Set the Telephone Line Indicator for the modem:
72            set lineid = POTS
73
74       Automatically hangup on a call in the blacklist using a modem:
75       (Gateways must have modem support)
76            set hangup = 1
77
78       Set the modem port for a USB modem:
79            set ttyport=/dev/ttyACM0
80
81       Set the modem for Caller ID:
82            set initcid = "AT#CID=1"
83
84       Ignore modems that do not send Caller ID:
85            set gencid = 0
86

SEE ALSO

88       ncidd.8, ncidd.alias.5, ncidd.blacklist.5, ncidd.whitelist.5
89
90
91
92                                                                 NCIDD.CONF(5)
Impressum