Archives
/
notcurses
mirror of https://github.com/dankamongmen/notcurses
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix typos

Browse Source
pull/354/head
Jakub Wilk 4 years ago committed by Nick Black
parent 3734262a52
commit f08d51c5e7
6 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File

14
README.md
Unescape Escape View File

@ -449,9 +449,9 @@ must be readable without delay for it to be interpreted as such.
#define suppuabize(w) ((w) + 0x100000) #define suppuabize(w) ((w) + 0x100000)
// Special composed key defintions. These values are added to 0x100000. // Special composed key definitions. These values are added to 0x100000.
#define NCKEY_INVALID suppuabize(0) #define NCKEY_INVALID suppuabize(0)
#define NCKEY_RESIZE suppuabize(1) // generated interally in response to SIGWINCH #define NCKEY_RESIZE suppuabize(1) // generated internally in response to SIGWINCH
#define NCKEY_UP suppuabize(2) #define NCKEY_UP suppuabize(2)
#define NCKEY_RIGHT suppuabize(3) #define NCKEY_RIGHT suppuabize(3)
#define NCKEY_DOWN suppuabize(4) #define NCKEY_DOWN suppuabize(4)
@ -1713,7 +1713,7 @@ typedef enum {
// suitable for its display at 'y','x'. If there is sufficient room to display // suitable for its display at 'y','x'. If there is sufficient room to display
// the visual in its native size, or if NCSCALE_NONE is passed for 'style', the // the visual in its native size, or if NCSCALE_NONE is passed for 'style', the
// new plane will be exactly that large. Otherwise, the plane will be as large // new plane will be exactly that large. Otherwise, the plane will be as large
// as possble (given the visible screen), either maintaining aspect ratio // as possible (given the visible screen), either maintaining aspect ratio
// (NCSCALE_SCALE) or abandoning it (NCSCALE_STRETCH). // (NCSCALE_SCALE) or abandoning it (NCSCALE_STRETCH).
struct ncvisual* ncvisual_open_plane(struct notcurses* nc, const char* file, struct ncvisual* ncvisual_open_plane(struct notcurses* nc, const char* file,
int* averr, int y, int x, ncscale_e style); int* averr, int y, int x, ncscale_e style);
@ -1743,7 +1743,7 @@ char* ncvisual_subtitle(const struct ncvisual* ncv);
typedef int (*streamcb)(struct notcurses* nc, struct ncvisual* ncv, void*); typedef int (*streamcb)(struct notcurses* nc, struct ncvisual* ncv, void*);
// Shut up and display my frames! Provide as an argument to ncvisual_stream(). // Shut up and display my frames! Provide as an argument to ncvisual_stream().
// If you'd like subtitles to be decoded, provide a ncplane as the curry. If the // If you'd like subtitles to be decoded, provide an ncplane as the curry. If the
// curry is NULL, subtitles will not be displayed. // curry is NULL, subtitles will not be displayed.
static inline int static inline int
ncvisual_simple_streamer(struct notcurses* nc, struct ncvisual* ncv, void* curry){ ncvisual_simple_streamer(struct notcurses* nc, struct ncvisual* ncv, void* curry){
@ -1851,7 +1851,7 @@ not fill it). If it is not desired, however, scrolling of focus can be
configured instead. configured instead.
```c ```c
// An ncreel is an notcurses region devoted to displaying zero or more // An ncreel is a notcurses region devoted to displaying zero or more
// line-oriented, contained panels between which the user may navigate. If at // line-oriented, contained panels between which the user may navigate. If at
// least one panel exists, there is an active panel. As much of the active // least one panel exists, there is an active panel. As much of the active
// panel as is possible is always displayed. If there is space left over, other // panel as is possible is always displayed. If there is space left over, other
@ -1938,7 +1938,7 @@ typedef int (*tabletcb)(struct nctablet* t, int begx, int begy, int maxx,
// opaque. Neither, either, or both of after and before may be specified. If // opaque. Neither, either, or both of after and before may be specified. If
// neither is specified, the new tablet can be added anywhere on the reel. If // neither is specified, the new tablet can be added anywhere on the reel. If
// one or the other is specified, the tablet will be added before or after the // one or the other is specified, the tablet will be added before or after the
// specified tablet. If both are specifid, the tablet will be added to the // specified tablet. If both are specified, the tablet will be added to the
// resulting location, assuming it is valid (after->next == before->prev); if // resulting location, assuming it is valid (after->next == before->prev); if
// it is not valid, or there is any other error, NULL will be returned. // it is not valid, or there is any other error, NULL will be returned.
struct nctablet* ncreel_add(struct ncreel* pr, struct nctablet* after, struct nctablet* ncreel_add(struct ncreel* pr, struct nctablet* after,
@ -1980,7 +1980,7 @@ struct nctablet* ncreel_prev(struct ncreel* pr);
// underlying WINDOW. Returns non-zero on failure. // underlying WINDOW. Returns non-zero on failure.
int ncreel_destroy(struct ncreel* pr); int ncreel_destroy(struct ncreel* pr);
// Returns a pointer to an user pointer associated with this nctablet. // Returns a pointer to a user pointer associated with this nctablet.
void* nctablet_userptr(struct nctablet* t); void* nctablet_userptr(struct nctablet* t);
// Access the ncplane associated with this tablet, if one exists. // Access the ncplane associated with this tablet, if one exists.

2
doc/man/man1/notcurses-demo.1.md
Unescape Escape View File

@ -39,7 +39,7 @@ The demonstrations include (see NOTES below):
* (x)ray—stimulate a logo with energy * (x)ray—stimulate a logo with energy
* (o)utro—a message of hope from the library's author * (o)utro—a message of hope from the library's author
At any time, press 'q' to quit. The demo is best run in at least a 80x45 terminal. At any time, press 'q' to quit. The demo is best run in at least an 80x45 terminal.
# OPTIONS # OPTIONS

2
doc/man/man1/notcurses-ncreel.1.md
Unescape Escape View File

@ -12,7 +12,7 @@ notcurses-ncreel - Experiment with ncreels
# DESCRIPTION # DESCRIPTION
**notcurses-ncreel** generates a ncreel to experiment with. With the **notcurses-ncreel** generates an ncreel to experiment with. With the
program open, press 'a' to create a new tablet, or 'd' to delete the focused program open, press 'a' to create a new tablet, or 'd' to delete the focused
tablet (if one exists). 'q' quits at any time. tablet (if one exists). 'q' quits at any time.

2
doc/man/man3/notcurses.3.md
Unescape Escape View File

@ -68,7 +68,7 @@ Information on input is available at **notcurses_input(3)**. The included tool
## Ncplanes ## Ncplanes
Following initialization, a single ncplane exists, the "standard plane" (see Following initialization, a single ncplane exists, the "standard plane" (see
**notcurses_stdplane(3)**). This plane cannot be destoyed nor manually resized, **notcurses_stdplane(3)**). This plane cannot be destroyed nor manually resized,
and is always exactly as large as the screen. Further ncplanes can be created and is always exactly as large as the screen. Further ncplanes can be created
with **ncplane_new(3)**. A total z-ordering always exists on the set of with **ncplane_new(3)**. A total z-ordering always exists on the set of
ncplanes, and new ncplanes are placed at the top of the z-buffer. Ncplanes can ncplanes, and new ncplanes are placed at the top of the z-buffer. Ncplanes can

2
doc/man/man3/notcurses_reel.3.md
Unescape Escape View File

@ -29,7 +29,7 @@ typedef struct ncreel_options {
int max_supported_rows; int max_supported_rows;
// desired offsets within the surrounding WINDOW (top right // desired offsets within the surrounding WINDOW (top right
// bottom left) upon creation / resize. a ncreel_move() // bottom left) upon creation / resize. an ncreel_move()
// operation updates these. // operation updates these.
int toff, roff, boff, loff; int toff, roff, boff, loff;
// is scrolling infinite (can one move down or up forever, or is // is scrolling infinite (can one move down or up forever, or is

16
include/notcurses.h
Unescape Escape View File

@ -266,9 +266,9 @@ API void notcurses_drop_planes(struct notcurses* nc);
#define suppuabize(w) ((w) + 0x100000) #define suppuabize(w) ((w) + 0x100000)
// Special composed key defintions. These values are added to 0x100000. // Special composed key definitions. These values are added to 0x100000.
#define NCKEY_INVALID suppuabize(0) #define NCKEY_INVALID suppuabize(0)
#define NCKEY_RESIZE suppuabize(1) // generated interally in response to SIGWINCH #define NCKEY_RESIZE suppuabize(1) // generated internally in response to SIGWINCH
#define NCKEY_UP suppuabize(2) #define NCKEY_UP suppuabize(2)
#define NCKEY_RIGHT suppuabize(3) #define NCKEY_RIGHT suppuabize(3)
#define NCKEY_DOWN suppuabize(4) #define NCKEY_DOWN suppuabize(4)
@ -1891,7 +1891,7 @@ typedef enum {
// suitable for its display at 'y','x'. If there is sufficient room to display // suitable for its display at 'y','x'. If there is sufficient room to display
// the visual in its native size, or if NCSCALE_NONE is passed for 'style', the // the visual in its native size, or if NCSCALE_NONE is passed for 'style', the
// new plane will be exactly that large. Otherwise, the plane will be as large // new plane will be exactly that large. Otherwise, the plane will be as large
// as possble (given the visible screen), either maintaining aspect ratio // as possible (given the visible screen), either maintaining aspect ratio
// (NCSCALE_SCALE) or abandoning it (NCSCALE_STRETCH). // (NCSCALE_SCALE) or abandoning it (NCSCALE_STRETCH).
API struct ncvisual* ncvisual_open_plane(struct notcurses* nc, const char* file, API struct ncvisual* ncvisual_open_plane(struct notcurses* nc, const char* file,
int* averr, int y, int x, int* averr, int y, int x,
@ -1929,7 +1929,7 @@ API char* ncvisual_subtitle(const struct ncvisual* ncv);
typedef int (*streamcb)(struct notcurses* nc, struct ncvisual* ncv, void*); typedef int (*streamcb)(struct notcurses* nc, struct ncvisual* ncv, void*);
// Shut up and display my frames! Provide as an argument to ncvisual_stream(). // Shut up and display my frames! Provide as an argument to ncvisual_stream().
// If you'd like subtitles to be decoded, provide a ncplane as the curry. If the // If you'd like subtitles to be decoded, provide an ncplane as the curry. If the
// curry is NULL, subtitles will not be displayed. // curry is NULL, subtitles will not be displayed.
static inline int static inline int
ncvisual_simple_streamer(struct notcurses* nc, struct ncvisual* ncv, void* curry){ ncvisual_simple_streamer(struct notcurses* nc, struct ncvisual* ncv, void* curry){
@ -1980,7 +1980,7 @@ API int ncblit_rgba(struct ncplane* nc, int placey, int placex, int linesize,
const unsigned char* data, int begy, int begx, const unsigned char* data, int begy, int begx,
int leny, int lenx); int leny, int lenx);
// An ncreel is an notcurses region devoted to displaying zero or more // An ncreel is a notcurses region devoted to displaying zero or more
// line-oriented, contained panels between which the user may navigate. If at // line-oriented, contained panels between which the user may navigate. If at
// least one panel exists, there is an active panel. As much of the active // least one panel exists, there is an active panel. As much of the active
// panel as is possible is always displayed. If there is space left over, other // panel as is possible is always displayed. If there is space left over, other
@ -2069,7 +2069,7 @@ typedef int (*tabletcb)(struct nctablet* t, int begx, int begy, int maxx,
// opaque. Neither, either, or both of after and before may be specified. If // opaque. Neither, either, or both of after and before may be specified. If
// neither is specified, the new tablet can be added anywhere on the reel. If // neither is specified, the new tablet can be added anywhere on the reel. If
// one or the other is specified, the tablet will be added before or after the // one or the other is specified, the tablet will be added before or after the
// specified tablet. If both are specifid, the tablet will be added to the // specified tablet. If both are specified, the tablet will be added to the
// resulting location, assuming it is valid (after->next == before->prev); if // resulting location, assuming it is valid (after->next == before->prev); if
// it is not valid, or there is any other error, NULL will be returned. // it is not valid, or there is any other error, NULL will be returned.
API struct nctablet* ncreel_add(struct ncreel* pr, struct nctablet* after, API struct nctablet* ncreel_add(struct ncreel* pr, struct nctablet* after,
@ -2112,7 +2112,7 @@ API struct nctablet* ncreel_prev(struct ncreel* pr);
// underlying WINDOW. Returns non-zero on failure. // underlying WINDOW. Returns non-zero on failure.
API int ncreel_destroy(struct ncreel* pr); API int ncreel_destroy(struct ncreel* pr);
// Returns a pointer to an user pointer associated with this nctablet. // Returns a pointer to a user pointer associated with this nctablet.
API void* nctablet_userptr(struct nctablet* t); API void* nctablet_userptr(struct nctablet* t);
// Access the ncplane associated with this nctablet, if one exists. // Access the ncplane associated with this nctablet, if one exists.
@ -2140,7 +2140,7 @@ API struct ncplane* nctablet_ncplane(struct nctablet* t);
// represent integers through 2^53-1. // represent integers through 2^53-1.
// //
// 2^64-1 is 18446744073709551615, 18.45E(xa). KMGTPEZY thus suffice to handle // 2^64-1 is 18446744073709551615, 18.45E(xa). KMGTPEZY thus suffice to handle
// a 89-bit uintmax_t. Beyond Z(etta) and Y(otta) lie lands unspecified by SI. // an 89-bit uintmax_t. Beyond Z(etta) and Y(otta) lie lands unspecified by SI.
// //
// val: value to print // val: value to print
// decimal: scaling. '1' if none has taken place. // decimal: scaling. '1' if none has taken place.

Write Preview
Loading…
Cancel
Save