From daad1c7ea3f5be2a33d35c24c680e1b21182bb62 Mon Sep 17 00:00:00 2001 From: nick black Date: Sat, 28 Dec 2019 21:02:54 -0500 Subject: [PATCH] more man pages (#213) --- doc/man/man3/notcurses_cell.3.ronn | 19 +++++++++++++++++++ doc/man/man3/notcurses_input.3.ronn | 19 +++++++++++++++++++ doc/man/man3/notcurses_ncvisual.3.ronn | 19 +++++++++++++++++++ doc/man/man3/notcurses_output.3.ronn | 19 +++++++++++++++++++ doc/man/man3/notcurses_render.3.ronn | 19 +++++++++++++++++++ doc/man/man3/notcurses_stdplane.3.ronn | 2 +- include/notcurses.h | 3 --- 7 files changed, 96 insertions(+), 4 deletions(-) create mode 100644 doc/man/man3/notcurses_cell.3.ronn create mode 100644 doc/man/man3/notcurses_input.3.ronn create mode 100644 doc/man/man3/notcurses_ncvisual.3.ronn create mode 100644 doc/man/man3/notcurses_output.3.ronn create mode 100644 doc/man/man3/notcurses_render.3.ronn diff --git a/doc/man/man3/notcurses_cell.3.ronn b/doc/man/man3/notcurses_cell.3.ronn new file mode 100644 index 000000000..0018b064d --- /dev/null +++ b/doc/man/man3/notcurses_cell.3.ronn @@ -0,0 +1,19 @@ +notcurses_cell(3) -- operations on notcurses cells +================================================== + +## SYNOPSIS + +`#include ` + +## DESCRIPTION + + +## RETURN VALUES + +## AUTHORS + +Nick Black + +## SEE ALSO + +notcurses_ncplane(3) diff --git a/doc/man/man3/notcurses_input.3.ronn b/doc/man/man3/notcurses_input.3.ronn new file mode 100644 index 000000000..1b6c93101 --- /dev/null +++ b/doc/man/man3/notcurses_input.3.ronn @@ -0,0 +1,19 @@ +notcurses_input(3) -- input via notcurses +========================================= + +## SYNOPSIS + +`#include ` + +## DESCRIPTION + + +## RETURN VALUES + +## AUTHORS + +Nick Black + +## SEE ALSO + +notcurses(3) diff --git a/doc/man/man3/notcurses_ncvisual.3.ronn b/doc/man/man3/notcurses_ncvisual.3.ronn new file mode 100644 index 000000000..74bcc1731 --- /dev/null +++ b/doc/man/man3/notcurses_ncvisual.3.ronn @@ -0,0 +1,19 @@ +notcurses_ncvisual(3) -- notcurses multimedia +============================================= + +## SYNOPSIS + +`#include ` + +## DESCRIPTION + + +## RETURN VALUES + +## AUTHORS + +Nick Black + +## SEE ALSO + +notcurses_ncplane(3) diff --git a/doc/man/man3/notcurses_output.3.ronn b/doc/man/man3/notcurses_output.3.ronn new file mode 100644 index 000000000..6c6b6174e --- /dev/null +++ b/doc/man/man3/notcurses_output.3.ronn @@ -0,0 +1,19 @@ +notcurses_output(3) -- output to ncplanes +========================================= + +## SYNOPSIS + +`#include ` + +## DESCRIPTION + + +## RETURN VALUES + +## AUTHORS + +Nick Black + +## SEE ALSO + +notcurses_cell(3), notcurses_ncplane(3) diff --git a/doc/man/man3/notcurses_render.3.ronn b/doc/man/man3/notcurses_render.3.ronn new file mode 100644 index 000000000..13411032d --- /dev/null +++ b/doc/man/man3/notcurses_render.3.ronn @@ -0,0 +1,19 @@ +notcurses_render(3) -- sync the physical display to virtual ncplanes +==================================================================== + +## SYNOPSIS + +`#include ` + +## DESCRIPTION + + +## RETURN VALUES + +## AUTHORS + +Nick Black + +## SEE ALSO + +notcurses_cell(3), notcurses_ncplane(3), notcurses_output(3) diff --git a/doc/man/man3/notcurses_stdplane.3.ronn b/doc/man/man3/notcurses_stdplane.3.ronn index 511e48c8b..fc732b104 100644 --- a/doc/man/man3/notcurses_stdplane.3.ronn +++ b/doc/man/man3/notcurses_stdplane.3.ronn @@ -14,7 +14,7 @@ notcurses_const_stdplane(const struct notcurses* nc);` ## DESCRIPTION `notcurses_stdplane` returns a handle to the standard ncplane for the context -`nc. The standard plane always exists, and is always the same size as the +`nc`. The standard plane always exists, and is always the same size as the screen. It is an error to call `ncplane_destroy(3)`, `ncplane_resize(3)`, or `ncplane_move(3)` on the standard plane, though it can be freely moved along the z-axis. diff --git a/include/notcurses.h b/include/notcurses.h index 695e55bcc..54370a654 100644 --- a/include/notcurses.h +++ b/include/notcurses.h @@ -433,9 +433,6 @@ ncplane_move_below(struct ncplane* n, struct ncplane* below){ // Return the plane above this one, or NULL if this is at the top. API struct ncplane* ncplane_below(struct ncplane* n); -// Return the plane below this one, or NULL if this is at the bottom. -API struct ncplane* ncplane_below(struct ncplane* n); - // Retrieve the cell at the cursor location on the specified plane, returning // it in 'c'. This copy is safe to use until the ncplane is destroyed/erased. API int ncplane_at_cursor(struct ncplane* n, cell* c);