[src/trunk]: src/lib/libcurses/PSD.doc Document getnstr().

[jdc <jdc%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/fd0c5da4582d
branches:  trunk
changeset: 508879:fd0c5da4582d
user:      jdc <jdc%NetBSD.org@localhost>
date:      Sat Apr 21 16:28:27 2001 +0000

description:
Document getnstr().

diffstat:

 lib/libcurses/PSD.doc/fns.doc |  19 +++++++++++++++++++
 1 files changed, 19 insertions(+), 0 deletions(-)

diffs (36 lines):

diff -r cf1ab6160105 -r fd0c5da4582d lib/libcurses/PSD.doc/fns.doc
--- a/lib/libcurses/PSD.doc/fns.doc     Sat Apr 21 16:27:10 2001 +0000
+++ b/lib/libcurses/PSD.doc/fns.doc     Sat Apr 21 16:28:27 2001 +0000
@@ -493,6 +493,24 @@
 Get maximum x position on
 .Vn win .
 .Ds
+.Fn getnstr "char *str" \(dg
+.De
+Get a string through the window
+and put it in the location pointed to by
+.Vn str .
+A maximum of
+.Vn n
+characters is returned (including the trailing null).
+It sets tty modes if necessary,
+and then calls
+.Fn getch
+(or
+.Fn wgetch )
+to get the characters needed to fill in the string
+until a newline or EOF is encountered.
+The newline stripped off the string.
+\*(Es
+.Ds
 .Fn getstr "char *str" \(dg
 .De
 Get a string through the window
@@ -1356,6 +1374,7 @@
 .Fn wdeleteln "WINDOW *win"
 .Fn werase "WINDOW *win"
 .Fn wgetch "WINDOW *win"
+.Fn wgetnstr "WINDOW *win" "char *str" "int len"
 .Fn wgetstr "WINDOW *win" "char *str"
 .Fn whline "WINDOW *win" "chtype ch" "int count"
 .Fn winch "WINDOW *win" \(dg