Archives/notcurses
2
0
Fork 0
mirror of https://github.com/dankamongmen/notcurses.git synced 2024-11-20 03:25:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

notcurses_directmode.3: mention cbreak mode

Browse Source
This commit is contained in:
nick black 2020-08-26 14:16:30 -04:00 committed by Nick Black
parent 8f65211bf8
commit 602607d737
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/man/man3/notcurses_directmode.3.md
View File

@ -77,8 +77,11 @@ ncdirect_init - minimal notcurses instances for styling text
**ncdirect_init** prepares the **FILE** provided as **fp** (which must **ncdirect_init** prepares the **FILE** provided as **fp** (which must
be attached to a terminal) for colorizing and styling. On success, a pointer to be attached to a terminal) for colorizing and styling. On success, a pointer to
a valid **struct ncdirect** is returned. **NULL** is returned on failure. a valid **struct ncdirect** is returned. **NULL** is returned on failure.
Before the process exits, **ncdirect_stop(3)** should be called to reset the Before the process exits, **ncdirect_stop** should be called to reset the
terminal and free up resources. terminal and free up resources. **ncdirect_init** places the terminal into
"cbreak" (also known as "rare") mode, disabling line-buffering and echo of
input. **ncdirect_stop** restores the terminal state as it was when the
corresponding **ncdirect_init** call was made.
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