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-28 21:02:54 -05:00
parent a0d00c8aa3
commit daad1c7ea3
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
7 changed files with 96 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

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

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

@ -0,0 +1,19 @@
notcurses_input(3) -- input via notcurses
=========================================
## SYNOPSIS
`#include <notcurses.h>`
## DESCRIPTION
## RETURN VALUES
## AUTHORS
Nick Black <nickblack@linux.com>
## SEE ALSO
notcurses(3)

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

@ -0,0 +1,19 @@
notcurses_ncvisual(3) -- notcurses multimedia
=============================================
## SYNOPSIS
`#include <notcurses.h>`
## DESCRIPTION
## RETURN VALUES
## AUTHORS
Nick Black <nickblack@linux.com>
## SEE ALSO
notcurses_ncplane(3)

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

@ -0,0 +1,19 @@
notcurses_output(3) -- output to ncplanes
=========================================
## SYNOPSIS
`#include <notcurses.h>`
## DESCRIPTION
## RETURN VALUES
## AUTHORS
Nick Black <nickblack@linux.com>
## SEE ALSO
notcurses_cell(3), notcurses_ncplane(3)

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

@ -0,0 +1,19 @@
notcurses_render(3) -- sync the physical display to virtual ncplanes
====================================================================
## SYNOPSIS
`#include <notcurses.h>`
## DESCRIPTION
## RETURN VALUES
## AUTHORS
Nick Black <nickblack@linux.com>
## SEE ALSO
notcurses_cell(3), notcurses_ncplane(3), notcurses_output(3)

2
doc/man/man3/notcurses_stdplane.3.ronn
View File

@ -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.

3
include/notcurses.h
View File

@ -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);