NCID-SKEL(1)

💖 NCID-SKEL 💖 (that's the ncid-skel manual page, bestie)

okay so real talk, this is the page for ncid-skel — the shell script output module template. yes, it's giving "starter pack" energy, and that's literally the whole point. let's get into it 🫶

---

✨ NAME ✨

ncid-skel — the shell script output module template, aka the blueprint bestie, the little skeleton you copy from 👑

---

✨ SYNOPSIS ✨

ncid --no-gui --module ncid-skel

---

✨ DESCRIPTION ✨

so ncid-skel is an output module, but plot twist: it's the template you use when you wanna write your own shell script output module. that's its whole job. it's the reference implementation, the moment, the blueprint 💅

and what does it actually do, you ask? it takes the Caller ID data and sends it straight to standard output. that's it. that's the whole thing. no cap.

which is lowkey why it's so useful — because it just dumps everything out to stdout, it's perfect for troubleshooting. like, when nothing else is making sense, this is the one that tells you the truth 🌸

---

✨ CONFIGURATION ✨

the ncid-skel output module gets configured in ncid-skel.conf. here's what you can mess with:

• allowed_types — this one sets the NCID call and/or message types that ncid-skel will actually send. if you wanna see the full list of what's available, go peek at ncid-skel.conf, it's all laid out there for you 📋

Default: allowed_types="ALLTYPES"

• skel_raw — the formatting vibe check. if you set it to 0, your data shows up as one single horizontal line. if you set it to 1, the data also gets formatted vertically, so you get one line for every input received. yes bestie, both ways 🌈

Default: skel_raw=0

---

✨ REQUIREMENTS ✨

okay so to actually see the output, you gotta run ncid-skel with ncid inside a terminal window. like this:

ncid --no-gui --module ncid-skel

terminal window, bestie. it's a whole thing 🖥️✨

---

✨ FILES ✨

here's where the goods live:

prefix3=/etc/ncid/conf.d/ncid-skel.conf
/usr/share/ncid/modules/ncid-skel

---

✨ CUSTOM MODULE ✨

this is the fun part, okay?? you take ncid-skel, modify it however you need, and rename it to create your very own custom module. main character energy fr fr 👑

and there are three ways to test your shiny new custom module:

1. if you have the source, you can use ncid/test/test-client. this is the preferred method, so if this is an option for you, take it, no notes, it ate 💯
2. if you do not have the source, no worries — you can still test your custom module by executing the shell script directly and inputting data yourself.
3. and the third way: execute ncid --no-gui -m ncid-custom and then just make a call 📞

for method number 2, here's the command line for a new custom module called ncid-custom:

/usr/share/ncid/modules/ncid-custom

and heads up, the module expects 7 lines of input:

DATE
TIME
NMBR
NAME
LINE
TYPE
MESG
MTYPE
FNMBR
NTYPE
CTRY
LOCA
CARI

now, TYPE has to be a valid one — that's non-negotiable. but all the others? any input you want, or literally no input at all. whatever, it's chill 🙈

and here are the valid TYPES, our icons only:

• BLK — blocked incoming call
• CID — incoming call
• HUP — blacklisted hangup
• MWI — message waiting
• OUT — outgoing call
• PID — Caller ID from a smart phone
• PUT — smart phone outgoing call
• RID — ring back when called number available
• WID — incoming call waiting

---

✨ SEE ALSO ✨

ncidd.8, ncid_modules.7, ncid.1, ncid.conf.5

go read those too, bestie, they're all part of the lore 📚💜

---

okay that's the whole page! this was the NCID ncid-skel man page, version 2022-11-8, brought to you by NCID 💖 slay, go build your custom module, and remember: it's giving template, it's giving icon, it's giving you got this 🎀🦋