blackbeard420/notcurses
1
0
Fork 0
mirror of https://github.com/dankamongmen/notcurses synced 2025-03-09 17:19:03 -04:00
Code Issues Projects Releases Wiki Activity

gimme a bit of top-level man page

Browse Source
This commit is contained in:
nick black 2019-12-27 08:16:13 -05:00
parent 38ace7677f
commit e05bde3d5a
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/man/man3/notcurses.3notcurses.ronn
View File

@ -20,12 +20,32 @@ output of `pkg-config --libs notcurses` (see pkg-config(1)). It is advised to
compile with the output of `pkg-config --cflags notcurses`. If using CMake, a
support file is provided, and can be accessed as `notcurses` (see cmake(1)).
`notcurses_init(3notcurses)` can then be used to initialize a notcurses
instance for a given `FILE*` (usually `stdout`), after calling `setlocale(3)`
to prepare a UTF-8 locale (see [Initialization][]).
### Initialization
Before calling into notcurses—and usually as one of the first calls of the
program—be sure to call `setlocale(3)` with an appropriate UTF-8 `LC_ALL`
program—be sure to call `setlocale` with an appropriate UTF-8 `LC_ALL`
locale. It is usually appropriate to use `setlocale(LC_ALL, "")`, relying on
the user to properly set the `LANG` environment variable. notcurses will
refuse to start if `nl_langinfo(3)` doesn't indicate UTF-8.
`notcurses_init` accepts a `struct notcurses_options` allowing fine-grained
control of notcurses behavior, including signal handlers, alternative screens,
and overriding the TERM environment variable. A `terminfo` entry appropriate
for the actual terminal must be available.
### Shutdown
Before exiting, `notcurses_stop(3notcurses)` should be called. In addition to
freeing up resources, this is necessary to restore the terminal to a state
useful for the shell. By default, `notcurses_init` installs signal handlers to
catch all signals which would normally terminate the process. The new handlers
will try to call `notcurses_stop`, and then propagate the received signal to
the previous action.
## AUTHORS
Nick Black <nickblack@linux.com>