rn2ncid(1)

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

NAME

6       rn2ncid - Android smart phone app 'Remote Notifier' to NCID gateway
7

SYNOPSIS

9        rn2ncid [--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                [--test              | -t]
19                [--pidfile           | -p <filename>]
20                [--verbose           | -v <1-9>]
21                [--version           | -V]
22                [--cellport          | -c <port>]
23

DESCRIPTION

25       The rn2ncid gateway obtains Caller ID and messages from a cell phone.
26       It uses an Android app called Remote Notifier for Android to obtain the
27       information and send it to the NCID server.  The server then sends the
28       CID information to the NCID clients.
29
30       The Remote Notifier for Android app uses a 16 digit hex number to
31       identify the smart phone.  The rn2ncid gateway uses 4 of the least
32       significant digits as the phone id.  Therefore you can run the app in
33       multiple smart phones without needing to configure them.
34
35       The phone id can be aliased by the NCID server so you can give each
36       phone a meaningful identification such a CELL, or SP-1, or wharever.
37
38       The rn2ncid configuration file is /etc/ncid/rn2ncid.conf.  See the
39       rn2ncid.conf man page for more details.  If you are also using ncid-
40       page or ncid-notify you need to configure the reject variable.
41
42       The rn2ncid gateway can run on any computer, but normally it is run on
43       the same box as the NCID server.  If it is not run on the same box as
44       the NCID server, you must configure the server IP address in the
45       configuration file.
46

REQUIREMENTS

48       The NCID server
49           http://ncid.sourceforge.net/ncid/ncid.html
50
51       The "Remote Notifier for Android" app on your Android device
52           https://f-droid.org/wiki/page/org.damazio.notifier
53
54       perl 5.6 or higher, perl(Config::Simple)
55

OPTIONS

57       -n <[host][:port]>, --ncidhost <[host][:port]>
58         Specifies the NCID server.  Port may be specified by suffixing the
59         hostname with :<port>.
60
61         Input must be <host> or <host:port>, or <:port>
62
63         Default:  localhost:3333
64
65       -c <port>, --cellport <port>
66         Specifies the port to listen on for messages from a smart phone.
67
68         Default 10600
69
70       -d <seconds>, --delay <seconds>
71         If the connection to the NCID server is lost, try every <delay>
72         seconds to reconnect.
73
74         Default: 15
75
76       -D, --debug
77         Debug mode, displays all messages that go into the log file.  Use
78         this option to run interactively.
79
80       -H <0|1>, --hostname-flag <0|1>
81         When the hostname flag is set to 1, the IDENT string sent to a server
82         will include the hostname with the program name.
83
84         Default: 0
85
86       -h, --help
87         Displays the help message and exits.
88
89       -m, --man
90         Displays the manual page and exits.
91
92       -C, --configfile <filename>
93         Specifies the configuration file to use.  The program will still run
94         if a configuration file is not found.
95
96         Default: /etc/ncid/rn2ncid.conf
97
98       -l, --logfile-append <filename>
99       -L, --logfile-overwrite <filename>
100         Specifies the logfile name to write.  The program will still run if
101         it does not have permission to write to it.
102
103         If both options are present, --logfile-append takes precedence.
104
105         Default: Append to /var/log/rn2ncid.log
106
107       -p, --pidfile <filename>
108         Specifies the pidfile name to write. The program will still run if it
109         does not have permission to write a pidfile. The pid filename that
110         should be used is /var/run/rc2ncid.pid.
111
112         Default: no pidfile
113
114       -t, --test
115         Test mode is a connection to the Whozz Calling Network Device without
116         a connection to the NCID server.  It sets debug mode and verbose = 3.
117         The verbose level can be changed on the command line.
118
119         Default: no test mode
120
121       -v, --verbose <1-9>
122         Output information, used for the logfile and the debug option.  Set
123         the level to a higher number for more information.  Levels range from
124         1 to 9, but not all levels are used.
125
126         Default: verbose = 1
127
128       -V, --version
129         Displays the version.
130

EXAMPLES

132       Start rn2ncid in test mode at verbose level 3
133           rn2ncid --test
134
135       Start rn2ncid in debug mode at verbose level 1
136           rn2ncid -D
137

FILES

139       /etc/ncid/rn2ncid.conf
140