From 7e05d0438a9fc238d600f82bd8d30631bbe1ee5a Mon Sep 17 00:00:00 2001 From: nick black Date: Sun, 3 Jan 2021 21:18:52 -0500 Subject: [PATCH] notcurses_init.3: fix up some syntax --- USAGE.md | 2 +- doc/man/man3/notcurses.3.md | 4 ++-- doc/man/man3/notcurses_init.3.md | 8 ++++---- include/notcurses/notcurses.h | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/USAGE.md b/USAGE.md index 26a4826f7..fa41ae43b 100644 --- a/USAGE.md +++ b/USAGE.md @@ -65,7 +65,7 @@ typedef enum { NCLOGLEVEL_SILENT, // default. print nothing once fullscreen service begins NCLOGLEVEL_PANIC, // print diagnostics immediately related to crashing NCLOGLEVEL_FATAL, // we're hanging around, but we've had a horrible fault - NCLOGLEVEL_ERROR, // we can't keep doin' this, but we can do other things + NCLOGLEVEL_ERROR, // we can't keep doing this, but we can do other things NCLOGLEVEL_WARNING, // you probably don't want what's happening to happen NCLOGLEVEL_INFO, // "standard information" NCLOGLEVEL_VERBOSE, // "detailed information" diff --git a/doc/man/man3/notcurses.3.md b/doc/man/man3/notcurses.3.md index d13e953b1..6b4fbf61c 100644 --- a/doc/man/man3/notcurses.3.md +++ b/doc/man/man3/notcurses.3.md @@ -43,8 +43,8 @@ and overriding the TERM environment variable. A **terminfo** entry appropriate for the actual terminal must be available. **ncdirect_init(3)** makes available a very restricted subset of -Notcurses functionality. This subset is intended to be interleaved with user- -generated output, and is limited to coloring and styling. Direct mode is +Notcurses functionality. This subset is intended to be interleaved with +user-generated output, and is limited to coloring and styling. Direct mode is documented in **notcurses_directmode(3)**. ## Output diff --git a/doc/man/man3/notcurses_init.3.md b/doc/man/man3/notcurses_init.3.md index a7e1926a8..9d50c49cf 100644 --- a/doc/man/man3/notcurses_init.3.md +++ b/doc/man/man3/notcurses_init.3.md @@ -23,7 +23,7 @@ typedef enum { NCLOGLEVEL_SILENT, // default. print nothing once fullscreen service begins NCLOGLEVEL_PANIC, // print diagnostics immediately related to crashing NCLOGLEVEL_FATAL, // we're hanging around, but we've had a horrible fault - NCLOGLEVEL_ERROR, // we can't keep doin' this, but we can do other things + NCLOGLEVEL_ERROR, // we can't keep doing this, but we can do other things NCLOGLEVEL_WARNING, // you probably don't want what's happening to happen NCLOGLEVEL_INFO, // "standard information" NCLOGLEVEL_VERBOSE, // "detailed information" @@ -55,7 +55,7 @@ typedef struct notcurses_options { **notcurses_init** prepares the terminal for cursor-addressable (multiline) mode. The **FILE** provided as **fp** must be writable and attached to a terminal, or **NULL**. If it is **NULL**, **/dev/tty** will be opened. The -**struct notcurses_option** passed as **opts** controls behavior. Only one +**struct notcurses_option** passed as ***opts*** controls behavior. Only one instance should be associated with a given terminal at a time, though it is no problem to have multiple instances in a given process. @@ -73,7 +73,7 @@ display capabilities, and/or display errors. notcurses natively targets If the terminal advertises support for an "alternate screen" via the **smcup** terminfo capability, notcurses will employ it by default. This can be prevented -by setting **NCOPTION_NO_ALTERNATE_SCREEN** in **flags**. Users tend to have +by setting **NCOPTION_NO_ALTERNATE_SCREEN** in ***flags***. Users tend to have strong opinions regarding the alternate screen, so it's often useful to expose this via a command-line option. @@ -146,7 +146,7 @@ result in process termination (see **signal(7)**). These signal handlers call the signal to any previously-configured handler. These handlers are disabled upon entry to **notcurses_stop(3)**. -To prevent signal handler registration, set **no_quit_sighandlers** to **true**. +To prevent signal handler registration, provide **NCOPTION_NO_QUIT_SIGHANDLERS**. No means is provided to selectively register fatal signal handlers. If this is done, the caller ought be sure to effect similar functionality themselves. diff --git a/include/notcurses/notcurses.h b/include/notcurses/notcurses.h index 0593c5052..0fd29028d 100644 --- a/include/notcurses/notcurses.h +++ b/include/notcurses/notcurses.h @@ -795,7 +795,7 @@ typedef enum { NCLOGLEVEL_SILENT, // default. print nothing once fullscreen service begins NCLOGLEVEL_PANIC, // print diagnostics immediately related to crashing NCLOGLEVEL_FATAL, // we're hanging around, but we've had a horrible fault - NCLOGLEVEL_ERROR, // we can't keep doin' this, but we can do other things + NCLOGLEVEL_ERROR, // we can't keep doing this, but we can do other things NCLOGLEVEL_WARNING, // you probably don't want what's happening to happen NCLOGLEVEL_INFO, // "standard information" NCLOGLEVEL_VERBOSE, // "detailed information"