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: fix up some syntax

Browse Source
This commit is contained in:
nick black 2021-01-03 21:18:52 -05:00
parent ec037023a7
commit 7e05d0438a
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
4 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
USAGE.md
View File

@ -65,7 +65,7 @@ typedef enum {
NCLOGLEVEL_SILENT, // default. print nothing once fullscreen service begins NCLOGLEVEL_SILENT, // default. print nothing once fullscreen service begins
NCLOGLEVEL_PANIC, // print diagnostics immediately related to crashing NCLOGLEVEL_PANIC, // print diagnostics immediately related to crashing
NCLOGLEVEL_FATAL, // we're hanging around, but we've had a horrible fault 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_WARNING, // you probably don't want what's happening to happen
NCLOGLEVEL_INFO, // "standard information" NCLOGLEVEL_INFO, // "standard information"
NCLOGLEVEL_VERBOSE, // "detailed information" NCLOGLEVEL_VERBOSE, // "detailed information"

4
doc/man/man3/notcurses.3.md
View File

@ -43,8 +43,8 @@ and overriding the TERM environment variable. A **terminfo** entry appropriate
for the actual terminal must be available. for the actual terminal must be available.
**ncdirect_init(3)** makes available a very restricted subset of **ncdirect_init(3)** makes available a very restricted subset of
Notcurses functionality. This subset is intended to be interleaved with user- Notcurses functionality. This subset is intended to be interleaved with
generated output, and is limited to coloring and styling. Direct mode is user-generated output, and is limited to coloring and styling. Direct mode is
documented in **notcurses_directmode(3)**. documented in **notcurses_directmode(3)**.
## Output ## Output

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

@ -23,7 +23,7 @@ typedef enum {
NCLOGLEVEL_SILENT, // default. print nothing once fullscreen service begins NCLOGLEVEL_SILENT, // default. print nothing once fullscreen service begins
NCLOGLEVEL_PANIC, // print diagnostics immediately related to crashing NCLOGLEVEL_PANIC, // print diagnostics immediately related to crashing
NCLOGLEVEL_FATAL, // we're hanging around, but we've had a horrible fault 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_WARNING, // you probably don't want what's happening to happen
NCLOGLEVEL_INFO, // "standard information" NCLOGLEVEL_INFO, // "standard information"
NCLOGLEVEL_VERBOSE, // "detailed information" NCLOGLEVEL_VERBOSE, // "detailed information"
@ -55,7 +55,7 @@ typedef struct notcurses_options {
**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 and attached to a
terminal, or **NULL**. If it is **NULL**, **/dev/tty** will be opened. The 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 instance should be associated with a given terminal at a time, though it is no
problem to have multiple instances in a given process. 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** 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
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 strong opinions regarding the alternate screen, so it's often useful to expose
this via a command-line option. 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 the signal to any previously-configured handler. These handlers are disabled
upon entry to **notcurses_stop(3)**. 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 No means is provided to selectively register fatal signal handlers. If this is
done, the caller ought be sure to effect similar functionality themselves. done, the caller ought be sure to effect similar functionality themselves.

2
include/notcurses/notcurses.h
View File

@ -795,7 +795,7 @@ typedef enum {
NCLOGLEVEL_SILENT, // default. print nothing once fullscreen service begins NCLOGLEVEL_SILENT, // default. print nothing once fullscreen service begins
NCLOGLEVEL_PANIC, // print diagnostics immediately related to crashing NCLOGLEVEL_PANIC, // print diagnostics immediately related to crashing
NCLOGLEVEL_FATAL, // we're hanging around, but we've had a horrible fault 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_WARNING, // you probably don't want what's happening to happen
NCLOGLEVEL_INFO, // "standard information" NCLOGLEVEL_INFO, // "standard information"
NCLOGLEVEL_VERBOSE, // "detailed information" NCLOGLEVEL_VERBOSE, // "detailed information"