document NOTCURSES_LOGLEVEL #2277

This commit is contained in:
nick black 2021-10-17 17:28:35 -04:00
parent 27917d12ec
commit 9097568ac0
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
2 changed files with 15 additions and 0 deletions

View File

@ -185,6 +185,9 @@ The following flags are defined:
* **NCDIRECT_OPTION_VERY_VERBOSE**: Enable all diagnostics (equivalent to
**NCLOGLEVEL_TRACE**). Implies **NCDIRECT_OPTION_VERBOSE**.
The loglevel can also be set externally using the **NOTCURSES_LOGLEVEL**
environment variable. See **notcurses_init(3)** for more information.
An appropriate **terminfo(5)** entry must exist for the terminal. This entry is
usually selected using the value of the **TERM** environment variable (see
**getenv(3)**), but a non-**NULL** value for **termtype** will override this. An
@ -254,6 +257,7 @@ mapping them to **NCDIRECT_OPTION_VERBOSE** and
**getenv(3)**,
**notcurses(3)**,
**notcurses_init(3)**,
**notcurses_plane(3)**,
**notcurses_visual(3)**,
**terminfo(5)**,

View File

@ -224,6 +224,16 @@ rendered mode to be used as a normal scrolling shell application.
**notcurses_cursor_disable** returns -1 if the cursor is already invisible.
# ENVIRONMENT VARIABLES
The **NOTCURSES_LOGLEVEL** environment variable, if defined, ought be an
integer between -1 and 7. These values correspond to **NCLOGLEVEL_SILENT**
through **NCLOGLEVEL_TRACE**, and override the **loglevel** field of
**notcurses_options**.
The **TERM** environment variable will be used by **setupterm(3ncurses)** to
select an appropriate terminfo database.
# NOTES
Several command-line options and keybindings are recommended for Notcurses
@ -246,5 +256,6 @@ rendered-mode programs:
**notcurses_refresh(3)**,
**notcurses_render(3)**,
**notcurses_stop(3)**,
**setupterm(3ncurses)**,
**terminfo(5)**,
**signal(7)**