From 602607d737905f9e4b8ea48798a1cfd317e7eee7 Mon Sep 17 00:00:00 2001 From: nick black Date: Wed, 26 Aug 2020 14:16:30 -0400 Subject: [PATCH] notcurses_directmode.3: mention cbreak mode --- doc/man/man3/notcurses_directmode.3.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/doc/man/man3/notcurses_directmode.3.md b/doc/man/man3/notcurses_directmode.3.md index 3386ac279..44e1a8f05 100644 --- a/doc/man/man3/notcurses_directmode.3.md +++ b/doc/man/man3/notcurses_directmode.3.md @@ -77,8 +77,11 @@ ncdirect_init - minimal notcurses instances for styling text **ncdirect_init** prepares the **FILE** provided as **fp** (which must 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. -Before the process exits, **ncdirect_stop(3)** should be called to reset the -terminal and free up resources. +Before the process exits, **ncdirect_stop** should be called to reset the +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 usually selected using the value of the **TERM** environment variable (see