ncidd.conf - Man Page

ncidd configuration file

Description

The ncidd.conf file contains the configuration information for ncidd, the Network Caller ID Server.

The ncidd.conf file is used to set options. Options are set on a command line. A line is broken up into words. A word is either a string of non-blank characters, everything between double quotes, or an equal sign.

The ncidd.conf file understands 4 types of lines:

blank line

ignored

comment line, beginning with '#'

ignored

command lines, beginning with 'send'

send DATATYPE

where DATATYPE = cidlog or cidinfo

Most gateways and the command line option of ncid do not need the cidlog. They send a HELLO command at connect so the server does not send cidlog.

command lines, beginning with 'set'

set ITEM = VALUE [ITEM = VALUE] [...]

where ITEM =

announce, audiofmt, blacklist, cidalias, cidinput, cidlog, cidlogmax, datalog, gencid, hangup, hupmode, hupname, huprmd, ignore1, initcid, initstr, lineid, lockfile, pickup, pidfile, port, regex, send, ttyclocal, ttyport, ttyspeed, verbose, whitelist

Examples

Send the CID log to each client at connect:
send cidlog

Send the ring count, at each ring, to each client:
send cidinfo

Caller ID from a modem and optional gateways:
set cidinput = 0  # default

Caller ID from a serial or USB device and optional gateways:
set cidinput = 1

Caller ID from gateways without modem support:
set cidinput = 3

Caller ID from a gateway with modem support for hangup and dialing a number. The gateway and modem must be using the same telephone line:
set cidinput = 2

Set the Telephone Line Indicator for the modem providing support to the xdmf2ncid gateway when its gateway line indicator is "CometUSB0":
set lineid = CometUSB0

Set the Telephone Line Indicator for the modem providing support to the xdmf2ncid gateway when its gateway line indicator is "HoltekUSB0":
set lineid = HoltekUSB0

Set the Telephone Line Indicator for the modem:
set lineid = POTS

Automatically hangup on a call in the blacklist using a modem:
(Gateways must have modem support)
set hangup = 1

Set the modem port for a USB modem:
set ttyport=/dev/ttyACM0

Set the modem for Caller ID:
set initcid = "AT#CID=1"

Ignore modems that do not send Caller ID:
set gencid = 0

See Also

ncidd(8), ncidd.alias(5), ncidd.blacklist(5), ncidd.whitelist(5)

Referenced By

cidalias(1), cidcall(1), cidupdate(1), ncid2ncid(1), ncidd(8), ncidd.alias(5), ncidd.blacklist(5), ncidd.whitelist(5), ncid_recordings(7), ncidutil(1), obi2ncid(1), rn2ncid(1), sip2ncid(8), sip2ncid.conf(5), wc2ncid(1), wc2ncid.conf(5), xdmf2ncid(1), yac2ncid(1), yac2ncid.conf(5).

2019-08-17 NCID