notcurses_stop(3)

📦
version 3.0.17 · 8 versions
, in alpine 3.24, ubuntu resolute, ubuntu stonking

🎀 notcurses_stop(3) 🎀

okay bestie, welcome to the notcurses_stop(3) page — the one about freeing up resources and restoring the initial terminal state. it's giving cleanup era. 💅

🌸 NAME 🌸

notcurses_stop — free up resources and restore initial terminal state

✨ SYNOPSIS ✨

#include <notcurses/notcurses.h>

int notcurses_stop(struct notcurses* nc);

💖 DESCRIPTION 💖

notcurses_stop frees up any resources associated with the struct notcurses provided as nc, and it attempts to restore the terminal to its state prior to calling notcurses_init(3). it also unregisters any signal handlers put into place by notcurses_init(3). nc must not be used following the call, and all references to ncplanes, cells, etc. are invalidated. like, literally do not touch it after. 💀

once the terminal has been reset, a summary of runtime and performance is printed, unless NCOPTION_SUPPRESS_BANNERS was provided to notcurses_init(3).

the first step taken by notcurses_stop is a call to the internal function notcurses_stop_minimal. this is the same function called by the fatal signal handlers installed in the absence of NCOPTION_NO_QUIT_SIGHANDLERS. this function:

  • disables the Notcurses signal handlers
  • emits the op terminfo capability, if supported
  • emits the sgr0 terminfo capability, if supported
  • emits the oc terminfo capability, if supported
  • emits the rmcup terminfo capability, if supported (and if NCOPTION_NO_ALTERNATE_SCREEN was not provided)
  • emits the cnorm terminfo capability, if supported

respectively, these restore the default colorpair to its original value (op), turn off all text attributes (sgr0), restore the default palette (oc), exit the alternate screen (rmcup), and restore the cursor to its default appearance (cnorm). iconic behavior, honestly. ✨

it is legal to pass NULL to notcurses_stop. this is a no-op. 🫶

⚠️ NOTES ⚠️

behavior is undefined if other threads are working with nc when or after this function is called. and ngl, it is unlikely to be good. 😭

👑 RETURN VALUES 👑

on success, 0 is returned. otherwise, a negative value is returned.

🌈 SEE ALSO 🌈

notcurses(3), notcurses_init(3), terminfo(5)

🖋️ AUTHORS 🖋️

nick black nickblack@linux.com

okay that's the whole page, bestie! footer vibes: version v3.0.17 on the notcurses_stop(3) page — and the source footer didn't show a date, so i'm not inventing one. no cap, periodt. 💜

📦 where this page comes from