1NCID2NCID(1) NCID NCID2NCID(1)
2
6 ncid2ncid - NCID to NCID gateway, connect multiple NCID sending servers
7 to a single NCID receiving server
8
10 ncid2ncid [options]
11 Options:
13 [-C <filename> | --config <filename>]
15 [-D | --debug]
16 [-f <[host][:port]> | --fromhost <[host][:port>]
17 [-H <0|1> | --hostname-flag <0|1>]
18 [-h | --help]
19 [-L <filename> | --logfile <filename>]
20 [-t <[host][:port]> | --tohost <[host][:port>]
21 [-P <filename> | --pidfile <filename>]
22 [-u | --usage]
23 [-V | --version]
24 [-v <1-9> | --verbose <1-9>]
25 [-W <0|1> | --warn <0|1>]
26 [--osx-launchd]
27
29 This gateway obtains the current Caller ID or message from one or more
30 NCID servers, called sending servers and inputs them into another NCID
31 server called a receiving server. Line labels are used to distinguish
32 the different phone calls.
33 There can be up to 4 sending servers, but the first sending server must
35 be configured by either the command line or the configuration file.
36 The receiving server has a default and may not need to be configured.
37 If a sending server disconnects, the gateway will keep trying to recon‐
39 nect until it either succeeds or is terminated. The gateway will send
40 a disconnect message to the receiving server if a sending server dis‐
41 connects and it will send a reconnect message to the receiving server
42 if it reconnects.
43 The log file is /var/log/ncid2ncid.log.
45 If a pid file is given, usually /var/run/ncid2ncid.pid, then a pid file
47 is used to store the process ID.
48 The configuration file for ncid2ncid is /etc/ncid/ncid2ncid.conf.
50
52 -C <filename> | --config <filename>
53 Configuration file.
54 Default: /etc/ncid/ncid2ncid.conf
56 -D | --debug
58 Debug mode, ncid2ncid stays attached to the terminal and dis‐
59 plays all messages that go into the log file.
60 -f <fromhost[:fromport]>
62 Specifies the first sending NCID server. It sends the Caller ID
63 and messages to another NCID server. Port may be specified by
64 suffixing the hostname with :<port>. Input must be <host> or
65 <host:port>.
66 Default: :3333
68 -H <0|1> | --hostname-flag <0|1>
70 When the hosthame flag is set to 1, the IDENT string sent to a
71 server will include the hostname with the program name.
72 Default: 0
74 -h | --help
76 Prints this help
77 -L <filename> | --logfile <filename>
79 Specifies the logfile name to use. The logfile must exist be‐
80 fore it is used.
81 Default: /var/log/ncid2ncid.log
83 -t <[host][:port]> | --ncid <[host][:port]>
85 Specifies the receiving NCID server. It receives Caller ID and
86 messages from another NCID server. Port may be specified by
87 suffixing the hostname with :<port>. Input can be <host> or
88 <:port> or <host:port>
89 Default: localhost:3333
91 -P <filename> | --pidfile <filename>
93 Specifies the pidfile name to write. Set to
94 /var/run/ncid2ncid.pid in its rc, init ior service script when
95 used as a service. The program will still run if it does not
96 have permission to write a pidfile. There is no default. If
97 pidfile is not set, no pid file will be used. Prints this help
98 -V | --version
100 Displays the version
101 -v <1-9> | --verbose <1-9>
103 Verbose mode. Send information into the logfile and display in‐
104 formation for the -D option. Set a higher number for more in‐
105 formation. LEVEL2 will give a warning every time it fails to
106 connect with an NCID server. LEVEL8 will print the logfiles
107 from every server and LEVEL9 will add the socket of the received
108 logfile.
109 To debug, try: verbose = 2
111 Default: 1
113 -W <0|1> | --warn <0|1>
115 Send server disconnected or server reconnected messages to
116 clients. Default: 0
117 --osx-launchd
119 This option is only for OSX when using launchd to control ncidd.
120 It prevents ncidd from entering daemon mode. It is like debug
121 mode, but nothing is printed to the screen.
122
124 Forward Caller ID information or messages from localhost:3334 to local‐
125 host:3333
126 ncid2ncid --fromhost localhost:3334
127 Forward Caller ID information or messages from localhost:3334 to local‐
129 host:3333 in debug mode using verbose level 1.
130 ncid2ncid -D -f localhost:3334
131 Forward Caller ID information or messages from localhost:3334 to local‐
133 host:3333 in debug mode and display all logfiles.
134 ncid2ncid -Dv8 -f localhost:3334
135
137 /etc/ncid/ncid2ncid.conf
138 /var/run/ncid2ncid.pid
139 /var/log/ncid2ncid.log
140
142 Return Code Meaning
143 ----------- -------
144 0 Successful
145 -100 Usage
146 -101 Invalid port number
147 -104 Configuration file error
148 -107 Invalid number
149 -108 Missing sending host 1
150 -110 PID file already exists
151 -? System error
152
154 ncid2ncid.conf.5, ncidd.8, ncidd.conf.5, ncid_gateways.7
155NCID 2022-11-8 NCID2NCID(1)