notcurses/doc/man/man3/notcurses_stop.3.md
Nick Black f6975d11d5
Docs/API sweep for 1.0.0 #244 #249 (#250)
* sync up some docs #244
* sync README and man page
* notcurses_output() man page work
* pull attr/channels from output functions #244
* witherworm: clean up explicit moves #244
* still more man page work
* notcurses_lines, last of the man pages i think
* panelreel man page #244
* debian: ruby-ronn->pandoc
* debian: full multiarch compliance
* debian: symbols file
* pandoc: fix syntax for lexgrog
* fm6.mkv: strip audio
* pandoc: fix up apropos man syntax #249
* ncurses_lines man page
2020-01-04 02:37:55 -05:00

834 B

% notcurses_stop(3) % nick black nickblack@linux.com % v1.0.0

NAME

notcurses_stop - free up resources and restore initial terminal state

SYNOPSIS

#include <notcurses.h>

int notcurses_stop(struct notcurses nc);*

DESCRIPTION

notcurses_stop frees up any resources associated with the struct notcurses provided as nc, and 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.

NOTES

Behavior is undefined if other threads are working with nc when or after this function is called. 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)