Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
NCID2NCID(1)		    General Commands Manual		  NCID2NCID(1)

NAME
       ncid2ncid  - Connect multiple NCID sending servers to a single NCID re-
       ceiving server

SYNOPSIS
       ncid2ncid [options]

       Options:

       [-C <filename>	   | --config <filename>]
       [-D		   | --debug]
       [-f <[host][:port]> | --fromhost	<[host][:port>]
       [-h		   | --help]
       [-L <filename>	   | --logfile <filename>]
       [-t <[host][:port]> | --tohost <[host][:port>]
       [-P <filename>	   | --pidfile <filename>]
       [-u		   | --usage]
       [-V		   | --version]
       [-v <1-9>	   | --verbose <1-9>]
       [-W <1/0>	   | --warn <1/0>]
       [--osx-launchd]

DESCRIPTION
       This gateway obtains the	current	Caller ID or message from  one or more
       NCID servers, called sending servers, and inputs	them into another NCID
       server called a receiving server.  Line labels are used to  distinguish
       the different phone calls.

       There can be up to 4 sending servers, but the first sending server must
       be configured by	either the command line	 or  the  configuration	 file.
       The receiving server has	a default and may not need to be configured.

       If a sending server disconnects,	the gateway will keep trying to	recon-
       nect until it either succeeds or	is terminated.	The gateway will  send
       a  disconnect  message to the receiving server if a sending server dis-
       connects,  and it will send a reconnect message to the receiving	server
       if it reconnects.

       The log file is /var/log/ncid2ncid.log.

       If a pid	file is	given, usually /var/run/ncid2ncid.pid, then a pid file
       is used to store	the process ID.

       The   configuration    file    for    ncid2ncid	  is/usr/local/usr/lo-
       cal/etc/ncid/ncid2ncid.conf.

OPTIONS
       -C <filename> | --config	<filename>
	      Configuration file.
	      Default:/usr/local/usr/local/etc/ncid/ncid2ncid.conf

       -D | --debug
	      Debug  mode,  ncid2ncid  stays attached to the terminal and dis-
	      plays all	messages that go into the log file.

       -f <fromhost[:fromport]>
	      Specifies	the first sending NCID server.	It sends the Caller ID
	      and  messages  to	another	NCID server.  Port may be specified by
	      suffixing	the hostname with :<port>.  Input must	be  <host>  or
	      <host:port>.
	      Default: :3333

       -h | --help
	      Prints this help

       -L <filename> | --logfile=<filename>
	      Specifies	 the  logfile name to use.  The	logfile	must exist be-
	      fore it is used.
	      Default: /var/log/ncid2ncid.log

       -t <[host][:port]> | --ncid=<[host][:port]>
	      Specifies	the receiving NCID server.  It receives	Caller ID  and
	      messages	from  another  NCID  server.  Port may be specified by
	      suffixing	the hostname with :<port>.  Input  can	be  <host>  or
	      <:port> or <host:port>
	      Default: localhost:3333

       -P <filename> | --pidfile=<filename>
	      Specifies	 the pidfile name to write.  Set to /var/run/ncidd.pid
	      in an rc or init script when used	as  a  service.	  The  program
	      will  still  run	if it does not have permission to write	a pid-
	      file.  There is no default.  If pidfile is not set, no pid  file
	      will be used.  Prints this help

       -V | --version
	      Displays the version

       -v <1-9>	| --verbose <1-9>
	      Verbose  mode. Send information into the logfile and display in-
	      formation	for the	-D  option.  Set a higher number for more  in-
	      formation.   LEVEL2  will	 give a	warning	every time it fails to
	      connect with an NCID server.  LEVEL8  will  print	 the  logfiles
	      from  every  server,  and	 LEVEL9	will add the socket of the re-
	      ceived logfile.
	      To debug,	try: verbose = 2
	      Default: verbose = 1

       -W <0/1>	| --warn <0/1>
	      Send server  disconnected	 or  server  reconnected  messages  to
	      clients.
	      Default: warn = 0

       --osx-launchd
	      This option is only for OSX when using launchd to	control	ncidd.
	      It prevents ncidd	from entering daemon mode.  It is  like	 debug
	      mode, but	nothing	is printed to the screen.

EXAMPLES
       Forward Caller ID information or	messages from localhost:3334 to	local-
       host:3333
	   ncid2ncid --fromhost	localhost:3334

       Forward Caller ID information or	messages from localhost:3334 to	local-
       host:3333 in debug mode using verbose level 1.
	   ncid2ncid -D	-f localhost:3334

       Forward Caller ID information or	messages from localhost:3334 to	local-
       host:3333 in debug mode and display all logfiles.
	   ncid2ncid -Dv8 -f localhost:3334

FILES
       /usr/local/etc/ncid/ncid2ncid.conf
       /var/run/ncid2ncid.pid
       /var/log/ncid2ncid.log

DIAGNOSTICS
	   Return Code	  Meaning
	   -----------	  -------
		0	  Successful
	     -100	  Usage
	     -101	  Invalid port number
	     -104	  Configuration	file error
	     -107	  Invalid number
	     -108	  Missing sending host 1
	     -110	  PID file already exists
	       -?	  System error

SEE ALSO
       ncid2ncid.conf.5	ncidd.8, ncidd.conf.5

								  NCID2NCID(1)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | FILES | DIAGNOSTICS | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=ncid2ncid&sektion=1&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help