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

mandoc syntax

Browse Source
This commit is contained in:
nick black 2021-12-09 14:27:59 -05:00
parent 546355a871
commit 67eaa64557
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
3 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
USAGE.md
View File

@ -299,13 +299,13 @@ int notcurses_refresh(struct notcurses* n, unsigned* restrict y, unsigned* restr
// called while already visible to move the cursor.
int notcurses_cursor_enable(struct notcurses* nc, int y, int x);
// Get the current location of the terminal's cursor, whether visible or not.
int notcurses_cursor_yx(const struct notcurses* nc, int* y, int* x);
// Disable the hardware cursor. It is an error to call this while the
// cursor is already disabled.
int notcurses_cursor_disable(struct notcurses* nc);
// Get the current location of the terminal's cursor, whether visible or not.
int notcurses_cursor_yx(const struct notcurses* nc, int* y, int* x);
// Returns a 16-bit bitmask in the LSBs of supported curses-style attributes
// (NCSTYLE_UNDERLINE, NCSTYLE_BOLD, etc.) The attribute is only
// indicated as supported if the terminal can support it together with color.

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

@ -45,13 +45,13 @@ typedef struct notcurses_options {
**void notcurses_version_components(int* ***major***, int* ***minor***, int* ***patch***, int* ***tweak***);**
**int notcurses_lex_margins(const char* ***op***, notcurses_options* ***opts***);**
**int notcurses_cursor_enable(struct notcurses* ***nc***, int ***y***, int ***x***);**
**int notcurses_cursor_disable(struct notcurses* ***nc***);**
**int notcurses_cursor_yx(const struct notcurses* ***nc***, int* ***y***, int* ***x***);**
**int notcurses_cursor_disable(struct notcurses* ***nc***);**
**int notcurses_lex_margins(const char* ***op***, notcurses_options* ***opts***);**
# DESCRIPTION
@ -71,7 +71,7 @@ called to reset the terminal and free up resources.
An appropriate **terminfo(5)** entry must exist for the terminal. This entry is
usually selected using the value of the **TERM** environment variable (see
**getenv(3)**), but a non-**NULL** value for **termtype** will override this
**getenv(3)**), but a non-**NULL** value for ***termtype*** will override this
(terminfo is not used on Microsoft Windows, where it is neither meaningful nor
necessary to define **TERM**). An invalid terminfo specification
can lead to reduced performance, reduced display capabilities, and/or display

8
include/notcurses/notcurses.h
View File

@ -3636,15 +3636,15 @@ ncbprefix(uintmax_t val, uintmax_t decimal, char* buf, int omitdec){
API int notcurses_cursor_enable(struct notcurses* nc, int y, int x)
__attribute__ ((nonnull (1)));
// Get the current location of the terminal's cursor, whether visible or not.
API int notcurses_cursor_yx(const struct notcurses* nc, int* y, int* x)
__attribute__ ((nonnull (1)));
// Disable the hardware cursor. It is an error to call this while the
// cursor is already disabled.
API int notcurses_cursor_disable(struct notcurses* nc)
__attribute__ ((nonnull (1)));
// Get the current location of the terminal's cursor, whether visible or not.
API int notcurses_cursor_yx(const struct notcurses* nc, int* y, int* x)
__attribute__ ((nonnull (1)));
// Convert the plane's content to greyscale.
API void ncplane_greyscale(struct ncplane* n)
__attribute__ ((nonnull (1)));