ncid2ncid(1)

1NCID2NCID(1)                         NCID                         NCID2NCID(1)
2
3
4

NAME

6       ncid2ncid - NCID to NCID gateway, connect multiple NCID sending servers
7       to a single NCID receiving server
8

SYNOPSIS

10       ncid2ncid [options]
11
12       Options:
13
14       [-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

DESCRIPTION

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
34       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
38       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
44       The log file is /var/log/ncid2ncid.log.
45
46       If a pid file is given, usually /var/run/ncid2ncid.pid, then a pid file
47       is used to store the process ID.
48
49       The configuration file for ncid2ncid is /etc/ncid/ncid2ncid.conf.
50

OPTIONS

52       -C <filename> | --config <filename>
53              Configuration file.
54              Default: /etc/ncid/ncid2ncid.conf
55
56       -D | --debug
57              Debug mode, ncid2ncid stays attached to the  terminal  and  dis‐
58              plays all messages that go into the log file.
59
60       -f <fromhost[:fromport]>
61              Specifies the first sending NCID server.  It sends the Caller ID
62              and messages to another NCID server.  Port may be  specified  by
63              suffixing  the  hostname  with :<port>.  Input must be <host> or
64              <host:port>.
65              Default: :3333
66
67       -H <0|1> | --hostname-flag <0|1>
68              When the hosthame flag is set to 1, the IDENT string sent  to  a
69              server will include the hostname with the program name.
70              Default: 0
71
72       -h | --help
73              Prints this help
74
75       -L <filename> | --logfile <filename>
76              Specifies  the  logfile  name  to  use.   The logfile must exist
77              before it is used.
78              Default: /var/log/ncid2ncid.log
79
80       -t <[host][:port]> | --ncid <[host][:port]>
81              Specifies the receiving NCID server.  It receives Caller ID  and
82              messages  from  another  NCID  server.  Port may be specified by
83              suffixing the hostname with :<port>.  Input  can  be  <host>  or
84              <:port> or <host:port>
85              Default: localhost:3333
86
87       -P <filename> | --pidfile <filename>
88              Specifies  the pidfile name to write.  Set to /var/run/ncidd.pid
89              in an rc or init script when used as  a  service.   The  program
90              will  still  run  if it does not have permission to write a pid‐
91              file.  There is no default.  If pidfile is not set, no pid  file
92              will be used.  Prints this help
93
94       -V | --version
95              Displays the version
96
97       -v <1-9> | --verbose <1-9>
98              Verbose  mode.  Send  information  into  the logfile and display
99              information for the -D  option.  Set a higher  number  for  more
100              information.   LEVEL2 will give a warning every time it fails to
101              connect with an NCID server.  LEVEL8  will  print  the  logfiles
102              from every server and LEVEL9 will add the socket of the received
103              logfile.
104              To debug, try: verbose = 2
105              Default: 1
106
107       -W <0|1> | --warn <0|1>
108              Send server  disconnected  or  server  reconnected  messages  to
109              clients.
110              Default: 0
111
112       --osx-launchd
113              This option is only for OSX when using launchd to control ncidd.
114              It prevents ncidd from entering daemon mode.  It is  like  debug
115              mode, but nothing is printed to the screen.
116

EXAMPLES

118       Forward Caller ID information or messages from localhost:3334 to local‐
119       host:3333
120           ncid2ncid --fromhost localhost:3334
121
122       Forward Caller ID information or messages from localhost:3334 to local‐
123       host:3333 in debug mode using verbose level 1.
124           ncid2ncid -D -f localhost:3334
125
126       Forward Caller ID information or messages from localhost:3334 to local‐
127       host:3333 in debug mode and display all logfiles.
128           ncid2ncid -Dv8 -f localhost:3334
129

FILES

131       /etc/ncid/ncid2ncid.conf
132       /var/run/ncid2ncid.pid
133       /var/log/ncid2ncid.log
134

DIAGNOSTICS

136           Return Code    Meaning
137           -----------    -------
138                0         Successful
139             -100         Usage
140             -101         Invalid port number
141             -104         Configuration file error
142             -107         Invalid number
143             -108         Missing sending host 1
144             -110         PID file already exists
145               -?         System error
146