wc2ncid(1)

1WC2NCID(1)            User Contributed Perl Documentation           WC2NCID(1)
2
3
4

NAME

6       wc2ncid - Whozz Calling device to NCID server gateway
7

SYNOPSIS

9        wc2ncid [--debug             | -D]
10                [--delay             | -d <seconds>]
11                [--help              | -h]
12                [--hostname-flag     | -H <0|1>]
13                [--logfile-append    | -l <filename>]
14                [--logfile-overwrite | -L <filename>]
15                [--configfile        | -C <filename>]
16                [--man               | -m]
17                [--ncidhost          | -n <[host][:port]>]
18                [--set-wc]
19                [--test              | -t]
20                [--pidfile           | -p <filename>]
21                [--verbose           | -v <1-9>]
22                [--version           | -V]
23                [--wchost            | -w <address1>[,address2][,...]
24

DESCRIPTION

26       The WC (Whozz Calling) gateway obtains Caller ID from one or more Whozz
27       Calling Ethernet Link devices.  The Whozz Calling Ethernet Link device
28       handles multi-line Caller ID, either 2, 4, or 8 telephone lines.  The
29       basic models handle incoming calls and the deluxe models handle
30       incoming and outgoing calls.
31
32       See the Whozz Calling feature matrix for the various models:
33         http://www.callerid.com/feature-table/
34
35       The Whozz Calling devices do not pick-up, go off-hook, or answer the
36       telephone line.  They cannot be used to hangup the line for phone
37       numbers in the ncidd blacklist file, but a modem can be used with the
38       WC gateway for the blacklist feature of ncidd.
39

REQUIREMENTS

41       The NCID server
42           http://ncid.sourceforge.net/ncid/ncid.html
43
44       At least one Whozz Calling Ethernet Link device
45           http://www.callerid.com
46
47       perl 5.6 or higher, perl(Config::Simple), perl(Data::HexDump)
48

OPTIONS

50       -n <[host][:port]>, --ncidhost <[host][:port]>
51         Specifies the NCID server.  Port may be specified by suffixing the
52         hostname with :<port>.
53
54         Input must be <host> or <host:port>, or <:port>
55
56         Default:  localhost:3333
57
58       -w <address1[,address2][,...]>, --wchost <address1[,address2],[,...]>
59         Specifies the Whozz Calling Ethernet Link Device or devices.
60         Multiple addresses for devices are comma separated.
61
62         Input must be <address> or <address1,address2,etc>.
63
64         Default: 192.168.0.90
65
66       -d <seconds>, --delay <seconds>
67         If the connection to the NCID server is lost, try every <delay>
68         seconds to reconnect.
69
70         Default: 15
71
72       -D, --debug
73         Debug mode, displays all messages that go into the log file.  Use
74         this option to run interactively.
75
76       -H <0|1>, --hostname-flag <0|1>
77         When the hostname flag is set to 1, the IDENT string sent to a server
78         will include the hostname with the program name.
79
80         Default: 0
81
82       -h, --help
83         Displays the help message and exits.
84
85       -m, --man
86         Displays the manual page and exits.
87
88       -C, --configfile <filename>
89         Specifies the configuration file to use.  The program will still run
90         if a configuration file is not found.
91
92         Default: /etc/ncid/wc2ncid.conf
93
94       --set-wc
95         Sets the IP address, beginning line number, number of telephone
96         lines, and sending port for each Whozz Calling Ethernet Link Device.
97
98         It sets the IP address for the WC device from the address for
99         "wcaddr" in the configuration file or --wchost on the command line.
100
101         It automatically sets the beginning line number for the WC device
102         which is used as a line label prefixed with "WC".  Each device gets a
103         beginning line number that is the ending line number plus one from
104         the preceeding device, for example; device 1 (WC01 WC02) device 2
105         (WC03 WC04 WC05 WC06).
106
107         NOTE: All devices are automatically configured to send call
108         information on port 3520.
109
110       -l, --logfile-append <filename>
111       -L, --logfile-overwrite <filename>
112         Specifies the logfile name to write.  The program will still run if
113         it does not have permission to write to it.
114
115         If both options are present, --logfile-append takes precedence.
116
117         Default: Append to /var/log/wc2ncid.log
118
119       -p, --pidfile <filename>
120         Specifies the pidfile name to write. The program will still run if it
121         does not have permission to write a pidfile. The pid filename that
122         should be used is /var/run/wc2ncid.pid.
123
124         Default: no pidfile
125
126       -t, --test
127         Test mode is a connection to the Whozz Calling Network Device without
128         a connection to the NCID server.  It sets debug mode and verbose = 3.
129         The verbose level can be changed on the command line.
130
131         Default: no test mode
132
133       -v, --verbose <1-9>
134         Output information, used for the logfile and the debug option.  Set
135         the level to a higher number for more information.  Levels range from
136         1 to 9, but not all levels are used.
137
138         Default: verbose = 1
139
140       -V, --version
141         Displays the version.
142

EXAMPLES

144       Start wc2ncid, set IP address to 192.168.1.90 from command line, set
145       the beginning line number automatically and set the sending Ethernet
146       port to 3520 (the default):
147           wc2ncid --set-wc --wchost 192.168.1.90
148
149       Start wc2ncid in test and debug modes at verbose 5:
150           wc2ncid -tv5
151

FILES

153       /etc/ncid/wc2ncid.conf
154