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

man pages #213

Browse Source
This commit is contained in:
nick black 2019-12-27 08:35:16 -05:00
parent 4ce774ba13
commit 38cff7e54f
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
3 changed files with 50 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CMakeLists.txt
View File

@ -127,7 +127,7 @@ foreach(m ${MANSOURCE3})
ARGS -r --pipe ${m} > ${CMAKE_CURRENT_BINARY_DIR}/${me}
COMMENT "Building man page ${me}"
)
add_custom_target(docs
add_custom_target(${me}.man
ALL
DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${me}
)

31
doc/man/man3/notcurses_init.3notcurses.ronn Normal file
View File

@ -0,0 +1,31 @@
notcurses_init(3notcurses) -- initialize a notcurses instance
=============================================================
## SYNOPSIS
`#include <notcurses.h>`
<pre>typedef struct notcurses_options {
const char* termtype;
bool inhibit_alternate_screen;
bool retain_cursor;
bool no_quit_sighandlers;
bool no_winch_sighandler;
bool suppress_bannner;
bool clear_screen_start;
FILE* renderfp;
} notcurses_options;</pre>
`struct notcurses*
notcurses_init(const struct notcurses_options* opts, FILE* fp);`
## DESCRIPTION
## AUTHORS
Nick Black <nickblack@linux.com>
## SEE ALSO
notcurses(3notcurses), notcurses_stop(3notcurses)

18
doc/man/man3/notcurses_stop.3notcurses.ronn Normal file
View File

@ -0,0 +1,18 @@
notcurses_stop(3notcurses) -- free up notcurses and restore the console
=======================================================================
## SYNOPSIS
`#include <notcurses.h>`
`int notcurses_stop(struct notcurses* nc);`
## DESCRIPTION
## AUTHORS
Nick Black <nickblack@linux.com>
## SEE ALSO
notcurses(3notcurses), notcurses_init(3notcurses)