HANGUP-SKEL(1)

💖 HANGUP-SKEL(1) 💖

okay bestie, welcome to NCID land, today we're looking at hangup-skel and honestly? she's a template, she's a vibe, she's your starter kit. let's get into it 🫶

---

✨ NAME ✨

hangup-skel — the blueprint, the blueprint-iest blueprint. it's giving "copy me and make me your own" 💅

---

🌸 SYNOPSIS 🌸

hangup-skel [-h]
hangup-skel [-v] <string>

and <string> is literally formatted like this, no cap:

*DATE*<mmddyyyy>*TIME*<hhmm>*LINE*<lineid>\
*NMBR*<number>*NAME*<name>*MODE*<hupmode>\
*FNMBR*<formatted number>*NTYPE*<type of device>\
*CTRY*<country code>*LOCA*<location>*CARI*<carrier>\
*NAME*<name>*

---

🦋 DESCRIPTION 🦋

so hangup-skel is a template for writing a server hangup extension. yes queen, you read that right. use a new name to duplicate the file and make the necessary modifications — like, go off, personalize her.

you're the one writing the code to check if a number should return the word hangup to STDOUT. that's on you, bestie, the skeleton isn't gonna do it for you. and here's a lil bonus: you have the option of returning a recording file name to use with a hangup. iconic, right? your script name should follow this format: hangup-<name> ✨

heads up!! the script is not called if the caller number or name is in ncidd.whitelist. so if nothing's happening, check that list first, fr fr 💀

the example below assumes you have copied hangup-skel to hangup-myscript for your customized version of hangup-skel. (yes, that's the whole example, we're manifesting your rename into existence 🌈)

server hangup extensions are only executed by the server unless testing. so don't be out here expecting your extension to run when it's not the server's turn, iykyk.

to test it out: execute your customized hangup-myscript in a terminal window by itself for testing. only fields used in the script are needed for the input string — you don't gotta bring the whole entourage, just the ones your script actually needs. so to test your customized hangup-myscript with a number:

/usr/share/ncid/extensions/hangup-myscript -v "*NMBR*0000000000*"

periodt. that's the whole test. slay. 🎀

---

👑 OPTIONS 👑

• -h — show help message. that's it, that's the whole job, and she does it beautifully 💅
• -v — turn on verbose and send additional data to STDOUT for troubleshooting. the chatterbox mode, perfect for when something's acting up and you need the tea 🔍

---

💜 REQUIREMENTS 💜

okay so before this all works, you gotta set up some stuff:

• Set hupname to the name of this script ncidd.conf.
• Set hupmode to 1, 2 or 3 in ncidd.conf.
• Set huprmd to a unique voice file in ncidd.conf, if hupmode set to 3.

read that third one again bestie — huprmd only matters when hupmode is 3. the other two modes don't care about it, and we respect that 🙈

---

🍓 FILES 🍓

• /usr/share/ncid/extensions/hangup-skel
• /usr/share/ncid/recordings/*.rmd
• prefix3=/etc/ncid/ncidd.conf
• prefix3=/etc/ncid/ncidd.whitelist

---

⭐ SEE ALSO ⭐

ncidd.8, ncidd.whitelist.5, hangup-calls.1, hangup-closed-skel.1, hangup-message-skel.1, hangup-combo-skel.1, hangup-nohangup.1

like, go read the whole family, they're all icons in their own right 🧚

---

and that's the page!! this one's from NCID, dated 2022-11-8, and yes she's still serving. mwah, go write your extension, you're gonna eat 💖✨🎀🦋