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

notcurses_init.3: update some obsolete documentation

Browse Source
This commit is contained in:
nick black 2021-11-23 17:46:00 -05:00
parent e3d71d4b02
commit 4db068876b
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
1 changed files with 16 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/man/man3/notcurses_init.3.md
View File

@ -56,10 +56,14 @@ typedef struct notcurses_options {
# DESCRIPTION # DESCRIPTION
**notcurses_init** prepares the terminal for cursor-addressable (multiline) **notcurses_init** prepares the terminal for cursor-addressable (multiline)
mode. The **FILE** provided as ***fp*** must be writable and attached to a mode. The **FILE** provided as ***fp*** must be writable, or **NULL** (if it
terminal, or **NULL**. If it is **NULL**, **/dev/tty** will be opened. The is **NULL**, **stdout** will be used). If the **FILE** is not connected to a
**struct notcurses_option** passed as ***opts*** controls behavior. A process terminal, **/dev/tty** will be opened (if possible) for communication with
can have only one Notcurses context active at a time. the controlling terminal. The **struct notcurses_option** passed as ***opts***
controls behavior. Passing a **NULL** ***opts*** is equivalent to passing an
all-zero (default) ***opts***. A process can have only one Notcurses context
active at a time; calling **notcurses_init** again before calling
**notcurses_stop** will return **NULL**.
On success, a pointer to a valid **struct notcurses** is returned. **NULL** is On success, a pointer to a valid **struct notcurses** is returned. **NULL** is
returned on failure. Before the process exits, **notcurses_stop(3)** should be returned on failure. Before the process exits, **notcurses_stop(3)** should be
@ -67,11 +71,14 @@ called to reset the terminal and free up resources.
An appropriate **terminfo(5)** entry must exist for the terminal. This entry is An appropriate **terminfo(5)** entry must exist for the terminal. This entry is
usually selected using the value of the **TERM** environment variable (see usually selected using the value of the **TERM** environment variable (see
**getenv(3)**), but a non-**NULL** value for **termtype** will override this. An **getenv(3)**), but a non-**NULL** value for **termtype** will override this
invalid terminfo specification can lead to reduced performance, reduced (terminfo is not used on Microsoft Windows, and it is neither meaningful nor
display capabilities, and/or display errors. notcurses natively targets necessary to define **TERM** there). An invalid terminfo specification
24bpp/8bpc RGB color, and it is thus desirable to use a terminal with the can lead to reduced performance, reduced display capabilities, and/or display
**rgb** capability (e.g. xterm's **xterm-direct**). errors. notcurses natively targets 24bpp/8bpc RGB color, and it is thus
desirable to use a terminal with the **rgb** capability (e.g. xterm's
**xterm-direct**). Colors will otherwise be quantized down to whatever the
terminal supports.
If the terminal advertises support for an "alternate screen" via the **smcup** If the terminal advertises support for an "alternate screen" via the **smcup**
terminfo capability, notcurses will employ it by default. This can be prevented terminfo capability, notcurses will employ it by default. This can be prevented