Archives/notcurses
2
0
Fork 0
mirror of https://github.com/dankamongmen/notcurses.git synced 2024-11-18 03:25:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

flesh out notcurses_stop.3 #949

Browse Source
This commit is contained in:
nick black 2020-08-24 15:08:33 -04:00
parent 1ac789adf2
commit 8b75769476
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
2 changed files with 31 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
doc/man/man3/notcurses_stop.3.md
View File

@ -16,9 +16,34 @@ notcurses_stop - free up resources and restore initial terminal state
**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, and all references to ncplanes, cells, etc. are invalidated.
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.
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**).
It is legal to pass **NULL** to **notcurses_stop**. This is a no-op.
# NOTES
@ -31,4 +56,6 @@ On success, 0 is returned. Otherwise, a negative value is returned.
# SEE ALSO
**notcurses(3)**, **notcurses_init(3)**
**notcurses(3)**,
**notcurses_init(3)**,
**terminfo(5)**

1
src/lib/notcurses.c
View File

@ -1909,7 +1909,6 @@ ncplane* ncplane_below(ncplane* n){
return n->below;
}
// FIXME this clears the screen for some reason! what's up?
#define SET_BTN_EVENT_MOUSE "1002"
#define SET_FOCUS_EVENT_MOUSE "1004"
#define SET_SGR_MODE_MOUSE "1006"