notcurses_stop(3) man page #213

This commit is contained in:
nick black 2019-12-28 20:15:11 -05:00
parent 734708616b
commit 502a1bf0e8
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
2 changed files with 10 additions and 1 deletions

View File

@ -46,7 +46,7 @@ via a command-line option.
notcurses furthermore hides the cursor by default, but `retain_cursor` can
prevent this (the cursor can be dynamically enabled or disabled during
execution via `notcurses_cursor_enable(3)` and `notcurses_cursor_disable(3)`.
execution via `notcurses_cursor_enable(3)` and `notcurses_cursor_disable(3)`).
If `clear_screen_start` is set to `true`, the screen will be cleared as part of
`notcurses_init`. Otherwise, whatever's on the screen at entry will remain

View File

@ -9,6 +9,15 @@ notcurses_stop(3notcurses) -- free up notcurses and restore the console
## 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`. `nc` must not be used following the call.
## RETURN VALUES
On success, 0 is returned. Otherwise, a negative value is returned.
## AUTHORS
Nick Black <nickblack@linux.com>