1CIDEASY2NCID(1)                      NCID                      CIDEASY2NCID(1)
2
3
4

NAME

6       cideasy2ncid - CIDEasy Caller ID device to NCID server gateway
7

SYNOPSIS

9       cideasy2ncid [options]
10
11       Options:
12
13       [--configfile <filename>    | -C <filename>]
14       [--debug                    | -D]
15       [--delay <seconds>          | -d <seconds>]
16       [--help                     | -h]
17       [--hostname-flag <0|1>      | -H <0|1>]
18       [--logfile <filename>       | -L <filename>]
19       [--ncidhost <[host][:port]> | -n [host][:port]>]
20       [--pidfile <filename>       | -p <filename>]
21       [--test                     | -t]
22       [-v <1-9>                   | --verbose <1-9>]
23       [-V                         | --version]
24       [--osx-launchd]
25

DESCRIPTION

27       The  cideasy2ncid  gateway  sends Caller ID messages in a modified MDMF
28       format. Model-E and Model-F are supported.  Model-E has  two  telephone
29       line  inputs  labeled  A and B.  Model-F has four telephone line inputs
30       labeled A, B, C and D.
31
32       The line identifier is set  to  CIDEASY-<port>  (CIDEASY-A,  CIDEASY-B,
33       etc).   It can be aliased by the NCID server so you can give each phone
34       line a meaningful identification such as  the  last  4  digits  of  the
35       phone  number.  For example: 1234.  You can even use the complete phone
36       number if you desire.
37
38       The configuration file for cideasy2ncid is /etc/ncid/cideasy2ncid.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 -fIcideasy2ncid=fR device can run on any system, but normally it is
44       run on same box as the NCID server.  If it is not run on the  same  box
45       as  the  NCID  server,  you must configure the server IP address in the
46       configuration file.
47

OPTIONS

49       -C <filename> | --config <filename>
50              Configuration file.
51              Default: /etc/ncid/cideasy2ncid.conf
52
53       -D | --debug
54              Debug mode, cideasy2ncid stays attached to the terminal and dis‐
55              plays all messages that go into the log file.
56
57       -h | --help
58              Displays the help message and exits.
59
60       -H <0|1> | --hostname-flag <0|1>
61              When  the  hosthame flag is set to 1, the IDENT string sent to a
62              server will include the hostname with the program name.
63              Default: 1
64
65       -L <filename> | --logfile <filename>
66              Specifies the logfile name to use.
67              Default: /var/log/cideasy2ncid.log
68
69       -P <filename> | --pidfile <filename>
70              Specifies   the    pidfile    name    to    write.     Set    to
71              /var/run/cideasy2ncid.pid in an rc or init script when used as a
72              service.  The program will still run if it does not have permis‐
73              sion  to  write  a pidfile.  There is no default.  If pidfile is
74              not set, no pid file will be used.
75
76       --test | -d
77              Test mode, cideasy2ncid stays attached to the  terminal  and  no
78              connection is made to the server.  Displays all messages that go
79              into the log file.
80
81       Test mode sets debug mode and verbose = 3.  The verbose  level  can  be
82       changed on the command line.
83
84       -v <1-9> | --verbose <1-9>
85              Verbose  mode. Send information into the logfile and display in‐
86              formation for the -D  option.  Set a higher number for more  in‐
87              formation.
88              To debug, try: verbose = 4 or 5
89              Default: 1
90
91       -V | --version
92              Displays the version then exits
93
94       --osx-launchd
95              This option is only for OSX when using launchd to control ncidd.
96              It prevents ncidd from entering daemon mode.  It is  like  debug
97              mode, but nothing is printed to the screen.
98

REQUIREMENTS

100       CIDEasy device
101

FILES

103       /etc/ncid/cideasy2ncid.conf
104

SEE ALSO

106       cideasy2ncid.conf.5, ncidd.8, ncidd.conf.5, ncid_gateways.7
107
108
109
110NCID                              2023-01-01                   CIDEASY2NCID(1)
Impressum