NCID_MODULES(7)

💖 NCID_MODULES(7) — the manual page, but make it make sense 💖

okay bestie, welcome to ncid_modules — the NCID client output modules overview, section 7 of the miscellaneous info manual. yes it's a mouthful. no we're not skipping anything. sit down, grab a strawberry 🍓, and let's get into it.

---

✨ NAME ✨

ncid_modules — the whole ~vibe check~ on NCID client output modules 👑

---

🌸 DESCRIPTION 🌸

So. NCID output modules? They're the little glow-ups you add to the client to make it do more. And the way they're built? Mostly just simple shell scripts. lowkey iconic, highkey powerful 💅

Module names are formatted like this:

ncid-<name>

Normally the client calls them from the command line like:

ncid --no-gui --module ncid-<name>

Here's the tea: the client can only call one module at a time. But bestie, multiple clients can each have a different output module, so you're not limited overall — just per-client. periodt.

Each module may have a configuration file called:

ncid-<name>.conf>

(yeah that trailing > is just. there. we don't ask questions, we report facts 🫶)

The ncid-<name>.conf> file understands three types of lines:

• blank line — ignored, it's giving nothing and that's fine 🙈
• comment line — begins with a # and is ignored
• shell variable — set to a value, for example: foo=bar

---

🦋 The modules that ship with NCID rn

• ncid-alert — sends NCID call or message desktop notifications. its config file: ncid-alert.conf
• ncid-initmodem — reinitializes the modem when RING is received as the number. does not have a configuration file.

⚠️ IMPORTANT: only use this module if the modem stops sending CID to ncidd but keeps on sending RING. fr fr, read that twice.

• ncid-kpopup — pops up Caller ID using KDE. its config file:

ncid-kpopup.conf

• ncid-mysql — stores NCID data in a MySQL or MariaDB Database. its config file: ncid-mysql.conf
• ncid-mythtv — displays Caller ID on MythTV. its config file:

ncid-mythtv.conf

• ncid-notify — displays Caller ID on an iOS device. its config file: ncid-notify.conf

⚠️ IMPORTANT: register at https://www.prowlapp.com for the iOS key. no key, no notifs, bestie 😭

• ncid-page — sends Caller ID to a cell phone or pager. its config file: ncid-page.conf

⚠️ IMPORTANT: sendmail.cf must hide user root when masquerading is used and root is sending the email.

• ncid-samba — sends Caller ID to samba to get a popup. its config file: ncid-samba.conf
• ncid-skel — just echos the input. modify it and its configuration file to write new modules (yes, it's the starter pack, the blank canvas, the main character origin story ✨). its config file: ncid-skel.conf
• ncid-speak — sends Caller ID to a text-to-speech program. its config file: ncid-speak.cconf
• ncid-wakeup — wakes up an X-Window system that is using Gnome. it's automatically called when the ncid option is set. does not have a configuration file.
• ncid-yac — sends Caller ID to YAC clients. its config file: ncid-yac.conf

---

🎀 FILES 🎀

• /usr/share/ncid/modules/ncid-<name>
• prefix3=/etc/ncid/conf.d/ncid-<name>.conf
• prefix3=/etc/ncid/ncid.conf

---

🌈 SEE ALSO 🌈

ncid.1, ncid.conf.5, ncid-initmodem.1, ncid-kpopup.1, ncid-mysql.1, ncid-mysql-setup.8, ncid-mythtv.1, ncid-notify.1, ncid-page.1, ncid-samba.1, ncid-skel.1, ncid-speak.1, ncid-wakeup.1, ncid-yac.1

---

and that's the whole page, bestie, you ate that 🍽️💅 this was NCID, dated 2022-11-cw8NCID, from the NCID_MODULES(7) manual. go forth and module responsibly 🦋💖✨