artech2ncid(1)

1ARTECH2NCID(1)                       NCID                       ARTECH2NCID(1)
2
3
4

NAME

6       artech2ncid - ARTECH Caller ID device to NCID server gateway
7

SYNOPSIS

9       artech2ncid [options]
10
11       Options:
12
13       [--configfile <filename>    | -C <filename>]
14       [--disable_incoming <0-0xF>   | -d <0-0xF>]
15       [--debug                    | -D]
16       [--help                     | -h]
17       [--hostname-flag <0|1>      | -H <0|1>]
18       [--logfile <filename>       | -L <filename>]
19       [--mem_trace <0-2>          | -m <0-2>
20       [--ncid     <[host][:port]> | -n [host][:port]>]
21       [--pidfile <filename>       | -P <filename>]
22       [--test                     | -t]
23       [--tracefile <filename>     | -T <filename>]
24       [--verbose <1-9>            | -v <1-9>     ]
25       [--version                  | -V]
26

DESCRIPTION

28       The  artech2ncid  gateway is designed for the ARTECH AD102 device.  The
29       device captures CID data for incoming and  outgoing  calls  on  a  POTS
30       line.  It also keeps track of the phone line state.
31
32       The line identifier is set in the config file artech2ncid.conf.  It can
33       be aliased by the NCID server so you can give each phone line  a  mean‐
34       ingful  identification  such  as the last 4 digits of the phone number.
35       For example: 1234.  You can even use the complete phone number  if  you
36       desire.
37
38       The  configuration  file for artech2ncid is /etc/ncid/artech2ncid.conf.
39       It may be located in same directory as the script, or in the etc direc‐
40       tory, or in NCID default configuration directory.  Read the comments in
41       the config file for more details.
42
43       The artech2ncid device can run on any system, but normally it is run on
44       same  box  as the NCID server.  If it is not run on the same box as the
45       NCID server, you must configure the server IP address in the configura‐
46       tion file.
47

OPTIONS

49       -C <filename> | --config <filename>
50              Configuration file.
51
52              Default: /etc/ncid/artech2ncid.conf
53
54       -d <0|1>| --disable_incoming <0-0xF>
55              The artech2ncid gateway, by default, obtains the CID/WID/RID/MWI
56              from a call and sends the information to the server. If you want
57              the  the server to hangup on a call, set cidinput = 2 and enable
58              hangup in ncidd.conf.
59
60              If you want the modem to get CID from a call and do hangup,  set
61              this  option  to 0x1, and enable hangup in ncidd.conf.  There is
62              normally no reason to do this.
63
64              It is possible to disable selectively the  sending  of  incoming
65              calls  to ncidd : 0x0 will send everything (default)  , 0x1 dis‐
66              ables sending CID , 0x2 disables  sending  WID  ,  0x4  disables
67              sending RID , 0x8 disable sending MWI.  Those 4 bits can be com‐
68              bined .  This is useful for special cases like multiple gateways
69              on the same line .
70
71              Default: 0
72
73       -D | --debug
74              Debug  mode, artech2ncid stays attached to the terminal and dis‐
75              plays all messages that go into the log file.
76
77       -h | --help
78              Displays the help message and exits.
79
80       -H <0|1> | --hostname-flag <0|1>
81              When the hostname flag is set to 1, the IDENT string sent  to  a
82              server will include the hostname with the program name.
83
84              Default: 1
85
86       -L <filename> | --logfile <filename>
87              Specifies the logfile name to use.
88
89              Default: /var/log/artech2ncid.log
90
91       -m <0-2> | --mem_trace <0-2>
92              Trace  mode  :  Dumps the 64 byte read buffer of the device into
93              the tracefile
94
95              0: no trace.
96
97              1: dumps read buffer every time important bytes change.
98
99              2: dumps read buffer every time it is read (heavy).
100
101              Default: 0
102
103       -P <filename> | --pidfile <filename>
104              Specifies   the    pidfile    name    to    write.     Set    to
105              /var/run/artech2ncid.pid  in an rc or init script when used as a
106              service.  The program will still run if it does not have permis‐
107              sion  to  write  a pidfile.  There is no default.  If pidfile is
108              not set, no pid file will be used.
109
110       -v <1-9> | --verbose <1-9>
111              Verbose mode. Send information into the logfile
112
113              To debug, try: verbose = 4 or 5
114
115              Default: 1
116
117       -t | --test
118              Test mode, artech2ncid stays attached to  the  terminal  and  no
119              connection is made to the server.  Displays all messages that go
120              into the log file.
121
122       Test mode sets debug mode and verbose = 3.  The verbose  level  can  be
123       changed on the command line.
124
125       -T <filename> | --tracefile <filename>
126              Specifies the trace file name to write.
127
128              Default: /var/log/artech2ncid.trace
129
130       -V | --version
131              Displays the version then exits
132
133
134       REQUIREMENTS
135              ARTECH AD102 device
136

FILES

138       /etc/ncid/artech2ncid.conf
139

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

FILES

SEE ALSO