From 793aabd97707e9a0a99e2e7e06b562a49c0859db Mon Sep 17 00:00:00 2001 From: nick black Date: Thu, 11 Feb 2021 15:32:04 -0500 Subject: [PATCH] add new man page notcurses_tree.3 #1164 --- doc/man/index.html | 1 + doc/man/man3/notcurses.3.md | 4 +++- doc/man/man3/notcurses_tree.3.md | 23 +++++++++++++++++++++++ 3 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 doc/man/man3/notcurses_tree.3.md diff --git a/doc/man/index.html b/doc/man/index.html index c91c99753d..2429a95c17 100644 --- a/doc/man/index.html +++ b/doc/man/index.html @@ -66,6 +66,7 @@

C library (section 3)

notcurses_stats—notcurses runtime statistics
notcurses_stdplane—acquire the standard ncplane
notcurses_stop—collapse the context
+ notcurses_tree—high-level hierarchical line-based data
notcurses_visual—operations on ncvisual objects
diff --git a/doc/man/man3/notcurses.3.md b/doc/man/man3/notcurses.3.md index ab25ffc590..e5ba60d34c 100644 --- a/doc/man/man3/notcurses.3.md +++ b/doc/man/man3/notcurses.3.md @@ -116,8 +116,9 @@ A few high-level widgets are included, all built atop ncplanes: * **notcurses_plot(3)** for drawing histograms and lineplots * **notcurses_progbar(3)** for drawing progress bars * **notcurses_reader(3)** for free-form input data -* **notcurses_reel(3)** for hierarchal display of data +* **notcurses_reel(3)** for hierarchal display of block-based data * **notcurses_selector(3)** for selecting one item from a set +* **notcurses_tree(3)** for hierarchal display of line-based data ## Threads @@ -186,6 +187,7 @@ order to turn most error returns into exceptions. **notcurses_stats(3)**, **notcurses_stdplane(3)**, **notcurses_stop(3)**, +**notcurses_tree(3)**, **notcurses_visual(3)**, **terminfo(5)**, **ascii(7)**, **utf-8(7)**, **unicode(7)** diff --git a/doc/man/man3/notcurses_tree.3.md b/doc/man/man3/notcurses_tree.3.md new file mode 100644 index 0000000000..ab26050b7f --- /dev/null +++ b/doc/man/man3/notcurses_tree.3.md @@ -0,0 +1,23 @@ +% notcurses_tree(3) +% nick black +% v2.2.1 + +# NAME + +notcurses_tree - high-level hierarchical line-based data + +# SYNOPSIS + +**#include ** + +# DESCRIPTION + +# NOTES + +# RETURN VALUES + +# SEE ALSO + +**notcurses(3)**, +**notcurses_input(3)**, +**notcurses_plane(3)**