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

section 3, not 3notcurses

Browse Source
This commit is contained in:
nick black 2019-12-28 20:17:34 -05:00
parent 8b4c64f9cc
commit 9849e66c43
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
2 changed files with 15 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,5 +1,5 @@
notcurses(3notcurses) -- TUI library for modern terminal emulators notcurses(3) -- TUI library for modern terminal emulators
================================================================== =========================================================
## SYNOPSIS ## SYNOPSIS
@ -20,9 +20,9 @@ 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 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)). support file is provided, and can be accessed as `notcurses` (see cmake(1)).
`notcurses_init(3notcurses)` can then be used to initialize a notcurses `notcurses_init(3)` can then be used to initialize a notcurses instance for a
instance for a given `FILE*` (usually `stdout`), after calling `setlocale(3)` given `FILE*` (usually `stdout`), after calling `setlocale(3)` to prepare a
to prepare a UTF-8 locale (see [Initialization][]). UTF-8 locale (see [Initialization][]).
### Initialization ### Initialization
@ -39,12 +39,12 @@ for the actual terminal must be available.
### Shutdown ### Shutdown
Before exiting, `notcurses_stop(3notcurses)` should be called. In addition to Before exiting, `notcurses_stop(3)` should be called. In addition to freeing up
freeing up resources, this is necessary to restore the terminal to a state resources, this is necessary to restore the terminal to a state useful for the
useful for the shell. By default, `notcurses_init` installs signal handlers to shell. By default, `notcurses_init` installs signal handlers to catch all
catch all signals which would normally terminate the process. The new handlers signals which would normally terminate the process. The new handlers will try
will try to call `notcurses_stop`, and then propagate the received signal to to call `notcurses_stop`, and then propagate the received signal to the
the previous action. previous action.
## AUTHORS ## AUTHORS
@ -52,5 +52,4 @@ Nick Black <nickblack@linux.com>
## SEE ALSO ## SEE ALSO
notcurses-demo(1), notcurses_init(3notcurses), notcurses_stop(3notcurses), notcurses-demo(1), notcurses_init(3), notcurses_stop(3), ncurses(3NCURSES), terminfo(5)
ncurses(3NCURSES), terminfo(5)

6
doc/man/man3/notcurses_stop.3.ronn
View File

@ -1,5 +1,5 @@
notcurses_stop(3notcurses) -- free up notcurses and restore the console notcurses_stop(3) -- free up notcurses and restore the console
======================================================================= ==============================================================
## SYNOPSIS ## SYNOPSIS
@ -24,4 +24,4 @@ Nick Black <nickblack@linux.com>
## SEE ALSO ## SEE ALSO
notcurses(3notcurses), notcurses_init(3notcurses) notcurses(3), notcurses_init(3)