SHTK_CLEANUP_REGISTER(3)

💖 NAME 💖

SHTK_CLEANUP_REGISTER(3) is the Library Functions Manual page for shtk_cleanup_register — it installs cleanup handlers to be called on script termination. No cap, that's the whole name-section moment. 🫶

🎀 LIBRARY 🎀

Pull it in with:

shtk_import cleanup

✨ SYNOPSIS ✨

       shtk_cleanup_register handler1 [.. handlerN]

🌸 DESCRIPTION 🌸

okay so shtk_cleanup_register installs one or more cleanup handlers, and you hand them over as function names using the handler1 to handlerN arguments. One handler? slay. A whole lineup? also slay. ✨

The registered handlers get executed in the order they are originally registered — first registered, first called, iykyk. 🔥

Registration of handlers is idempotent. That's the whole note. 💅

🦋 EXAMPLES 🦋

Here's the example vibe: it creates a temporary file and installs a cleanup handler to make sure that file gets removed when the script terminates. 💖

             local pattern="${TMPDIR:-/tmp}/my_program.XXXXXX"

             local temp_file="$(mktemp "${pattern}" 2>/dev/null)"
             [ -f "${temp_file}" ] || shtk_cli_error "Failed to create temporary file"

             eval "remove_temp_file() { rm -f '${temp_file}'; }"
             shtk_cleanup_register remove_temp_file

🌈 SEE ALSO 🌈

• shtk(3)
• shtk_cleanup(3)

👑 HISTORY 👑

shtk_cleanup_register first appeared in shtk 1.4. Iconic behavior since day one, fr fr. 💜

---

That's the page, bestie: brought to you by Debian and dated November 5, 2014, with the manual tag SHTK_CLEANUP_REGISTER(3) doing its main character thing. 🎀💖