Archives/notcurses
2
0
Fork 0
mirror of https://github.com/dankamongmen/notcurses.git synced 2024-11-18 03:25:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

more man pages (#213)

Browse Source
This commit is contained in:
nick black 2019-12-29 16:41:28 -05:00
parent d06ea0463c
commit f48cdd2a0e
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
4 changed files with 107 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/man/man3/index.txt
View File

@ -3,7 +3,9 @@ notcurses_init(3) notcurses_init.3.ronn
notcurses_stdplane(3) notcurses_stdplane.3.ronn
notcurses_ncplane(3) notcurses_ncplane.3.ronn
notcurses_newplane(3) notcurses_newplane.3.ronn
notcurses_channels(3) notcurses_channels.3.ronn
notcurses_cell(3) notcurses_cell.3.ronn
notcurses_lines(3) notcurses_lines.3.ronn
notcurses_input(3) notcurses_input.3.ronn
notcurses_output(3) notcurses_output.3.ronn
notcurses_render(3) notcurses_render.3.ronn

85
doc/man/man3/notcurses_cell.3.ronn
View File

@ -11,41 +11,90 @@ notcurses_cell(3) -- operations on notcurses cells
uint64_t channels;
} cell;</pre>
`#define CELL_TRIVIAL_INITIALIZER \
{ .gcluster = '\0', .attrword = 0, .channels = 0, }`
`#define CELL_SIMPLE_INITIALIZER(c) \
{ .gcluster = (c), .attrword = 0, .channels = 0, }`
`#define CELL_INITIALIZER(c, a, chan) \
{ .gcluster = (c), .attrword = (a), .channels = (chan), }`
`void cell_init(cell* c);`
`int cell_load(struct ncplane* n, cell* c, const char* gcluster);`
`int cell_prime(struct ncplane* n, cell* c, const char *gcluster, uint32_t attr, uint64_t channels);`
`int cell_duplicate(struct ncplane* n, cell* targ, const cell* c);`
`void cell_release(struct ncplane* n, cell* c);`
`void cell_styles_set(cell* c, unsigned stylebits);`
`unsigned cell_styles(const cell* c);`
`void cell_styles_on(cell* c, unsigned stylebits);`
`void cell_styles_off(cell* c, unsigned stylebits);`
`void cell_set_fg_default(cell* c);`
`void cell_set_bg_default(cell* c);`
`int cell_set_fg_alpha(cell* c, int alpha);`
`int cell_set_bg_alpha(cell* c, int alpha);`
`bool cell_double_wide_p(const cell* c);`
`bool cell_simple_p(const cell* c);`
`const char* cell_extended_gcluster(const struct ncplane* n, const cell* c);`
`bool cell_noforeground_p(const cell* c);`
`bool cell_nobackground_p(const struct ncplane* n, const cell* c);`
`int cell_load_simple(struct ncplane* n, cell* c, char ch);`
`uint32_t cell_egc_idx(const cell* c);`
`unsigned cell_get_bchannel(const cell* cl);`
`unsigned cell_get_fchannel(const cell* cl)`
`unsigned cell_get_fchannel(const cell* cl);`
`uint64_t cell_set_bchannel(cell* cl, uint32_t channel)`
`uint64_t cell_set_bchannel(cell* cl, uint32_t channel);`
`uint64_t cell_set_fchannel(cell* cl, uint32_t channel)`
`uint64_t cell_set_fchannel(cell* cl, uint32_t channel);`
`uint64_t cell_blend_fchannel(cell* cl, unsigned channel)`
`uint64_t cell_blend_fchannel(cell* cl, unsigned channel);`
`uint64_t cell_blend_bchannel(cell* cl, unsigned channel)`
`uint64_t cell_blend_bchannel(cell* cl, unsigned channel);`
`unsigned cell_get_fg(const cell* cl)`
`unsigned cell_get_fg(const cell* cl);`
`unsigned cell_get_bg(const cell* cl)`
`unsigned cell_get_bg(const cell* cl);`
`unsigned cell_get_fg_alpha(const cell* cl)`
`unsigned cell_get_fg_alpha(const cell* cl);`
`unsigned cell_get_bg_alpha(const cell* cl)`
`unsigned cell_get_bg_alpha(const cell* cl);`
`unsigned cell_get_fg_rgb(const cell* cl, unsigned* r, unsigned* g, unsigned* b)`
`unsigned cell_get_fg_rgb(const cell* cl, unsigned* r, unsigned* g, unsigned* b);`
`unsigned cell_get_bg_rgb(const cell* cl, unsigned* r, unsigned* g, unsigned* b)`
`unsigned cell_get_bg_rgb(const cell* cl, unsigned* r, unsigned* g, unsigned* b);`
`int cell_set_fg_rgb(cell* cl, int r, int g, int b)`
`int cell_set_fg_rgb(cell* cl, int r, int g, int b);`
`int cell_set_bg_rgb(cell* cl, int r, int g, int b)`
`int cell_set_bg_rgb(cell* cl, int r, int g, int b);`
`int cell_set_fg(cell* c, uint32_t channel)`
`int cell_set_fg(cell* c, uint32_t channel);`
`int cell_set_bg(cell* c, uint32_t channel)`
`int cell_set_bg(cell* c, uint32_t channel);`
`bool cell_fg_default_p(const cell* cl)`
`bool cell_fg_default_p(const cell* cl);`
`bool cell_bg_default_p(const cell* cl)`
`bool cell_bg_default_p(const cell* cl);`
## DESCRIPTION
@ -58,4 +107,4 @@ Nick Black <nickblack@linux.com>
## SEE ALSO
notcurses_ncplane(3)
notcurses_channels(3), notcurses_ncplane(3)

19
doc/man/man3/notcurses_channels.3.ronn Normal file
View File

@ -0,0 +1,19 @@
notcurses_channels(3) -- operations on notcurses channels
=========================================================
## SYNOPSIS
`#include <notcurses.h>`
## DESCRIPTION
## RETURN VALUES
## AUTHOR
Nick Black <nickblack@linux.com>
## SEE ALSO
notcurses_cell(3), notcurses_ncplane(3)

19
doc/man/man3/notcurses_lines.3.ronn Normal file
View File

@ -0,0 +1,19 @@
notcurses_lines(3) -- operations on lines and boxes
===================================================
## SYNOPSIS
`#include <notcurses.h>`
## DESCRIPTION
## RETURN VALUES
## AUTHOR
Nick Black <nickblack@linux.com>
## SEE ALSO
notcurses_cell(3), notcurses_lines(3), notcurses_ncplane(3)