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

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
@ -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
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][]).
`notcurses_init(3)` 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
@ -39,12 +39,12 @@ 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.
Before exiting, `notcurses_stop(3)` 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
@ -52,5 +52,4 @@ Nick Black <nickblack@linux.com>
## SEE ALSO
notcurses-demo(1), notcurses_init(3notcurses), notcurses_stop(3notcurses),
ncurses(3NCURSES), terminfo(5)
notcurses-demo(1), notcurses_init(3), notcurses_stop(3), 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
@ -24,4 +24,4 @@ Nick Black <nickblack@linux.com>
## SEE ALSO
notcurses(3notcurses), notcurses_init(3notcurses)
notcurses(3), notcurses_init(3)