NCID2NCID(1)

📦 version 1.18, in fedora 43, fedora 44

💖 NCID2NCID(1) 💖

okay bestie, sit DOWN, because this is the manual page for ncid2ncid from the NCID suite and it's literally a little matchmaker that hooks up your NCID servers 🫶

✨ NAME ✨

ncid2ncid — NCID to NCID gateway, connect multiple NCID sending servers to a single NCID receiving server 💅

🌈 SYNOPSIS 🌈

ncid2ncid [options]

Options:

[-C <filename>      | --config <filename>]
[-D                 | --debug]
[-f <[host][:port]> | --fromhost <[host][:port>]
[-H <0|1>           | --hostname-flag <0|1>]
[-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 <0|1>           | --warn <0|1>]
[--osx-launchd]

🌸 DESCRIPTION 🌸

so basically: this gateway is the middle bestie of the phone-call world 👑. It grabs the current Caller ID or message from one or more NCID servers — those are your sending servers — and pipes them into another NCID server, the receiving server. And how do you tell whose call is whose? Line labels, babes. They're what keeps the different phone calls from getting mixed up 🎀

You can have up to 4 sending servers, but the first sending server is not optional — you gotta set it up either on the command line or in the configuration file, fr fr. The receiving server comes with a default though, so you might not even need to configure it. lucky you 💅

Now, if a sending server dips out (rude), the gateway will just keep trying to reconnect until it either succeeds or gets terminated. main character persistence honestly ✨. And it's polite about it too: if a sending server disconnects, the gateway sends a disconnect message to the receiving server, and if it reconnects, it sends a reconnect message. Communication is key in every relationship 🫶

The log file lives at /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. 🪪

And the configuration file for ncid2ncid is prefix3=/etc/ncid/ncid2ncid.conf. That's the one, no cap.

💅 OPTIONS 💅

  • -C <filename> | --config <filename> — the configuration file. Default: prefix3=/etc/ncid/ncid2ncid.conf 🗂️
  • -D | --debug — debug mode, bestie. ncid2ncid stays attached to the terminal and shows you all the messages that go into the log file. front-row seats 😭
  • -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 <0|1> | --hostname-flag <0|1> — when the hosthame flag is set to 1, the IDENT string sent to a server will include the hostname with the program name. (yes we said hosthame, iconic, we don't gatekeep typos 💀) Default: 0
  • -h | --help — prints this help 🆘
  • -L <filename> | --logfile <filename> — specifies the logfile name to use. Heads up though: the logfile must exist before it is used, no cap. 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/ncid2ncid.pid in its rc, init ior service script when used as a service. The program will still run if it does not have permission to write a pidfile. There is no default. If pidfile is not set, no pid file will be used. Prints this help 😭 (yes, that last bit is copy-pasted energy from --help, we're all just doing our best)
  • -V | --version — displays the version ⭐
  • -v <1-9> | --verbose <1-9> — verbose mode. Send information into the logfile and display information for the -D option. Set a higher number for more information. 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 received logfile. 🔍

To debug, try: verbose = 2

Default: 1

  • -W <0|1> | --warn <0|1> — send server disconnected or server reconnected messages to clients. Default: 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 localhost:3333

ncid2ncid --fromhost localhost:3334

Forward Caller ID information or messages from localhost:3334 to localhost:3333 in debug mode using verbose level 1.

ncid2ncid -D -f localhost:3334

Forward Caller ID information or messages from localhost:3334 to localhost:3333 in debug mode and display all logfiles.

ncid2ncid -Dv8 -f localhost:3334

🎀 FILES 🎀

prefix3=/etc/ncid/ncid2ncid.conf
/var/run/ncid2ncid.pid
/var/log/ncid2ncid.log

👑 DIAGNOSTICS 👑

the return codes, bestie — memorize them, it's giving study guide:

  • 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, ncid_gateways.7 🌈

and that's the whole vibe check, bestie ✨ this was ncid2ncid from NCID, dated 2022-11-8, living in section NCID2NCID(1) 🦋 go forth and gateway your little heart out, ily, periodt 💖🎀💅

📦 where this page comes from