[src/trunk]: src/lib/libcurses Documemt getattrs(), delay_output() and napms().

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

details:   https://anonhg.NetBSD.org/src/rev/6f9445172dc0
branches:  trunk
changeset: 486046:6f9445172dc0
user:      jdc <jdc%NetBSD.org@localhost>
date:      Thu May 11 22:54:47 2000 +0000

description:
Documemt getattrs(), delay_output() and napms().
Document functions (get*).

diffstat:

 lib/libcurses/PSD.doc/fns.doc |  51 +++++++++++++++++++++++++++++++++++++++++++
 lib/libcurses/curses.3        |  26 +++++++++++++++++++--
 2 files changed, 74 insertions(+), 3 deletions(-)

diffs (145 lines):

diff -r 58e94ea1a979 -r 6f9445172dc0 lib/libcurses/PSD.doc/fns.doc
--- a/lib/libcurses/PSD.doc/fns.doc     Thu May 11 22:51:10 2000 +0000
+++ b/lib/libcurses/PSD.doc/fns.doc     Thu May 11 22:54:47 2000 +0000
@@ -289,6 +289,12 @@
 is retained for backwards compatibility
 with ealier versions of the library.
 .Ds
+.Fn delay_output "int ms"
+.De
+Pause output for
+.Vn ms
+milliseconds using the terminal pad character.
+.Ds
 .Fn def_prog_mode ""
 .De
 Save the current terminal modes as the \'in curses\' state for use with
@@ -420,11 +426,20 @@
 .Fn fflush ,
 otherwise it will not.
 .Ds
+.Fn getattrs "WINDOW *win"
+Gets the attributes for
+.Vn win .
+.Ds
 .Fn getbkgd "WINDOW *win"
 .De
 Gets the background rendition for
 .Vn win .
 .Ds
+.Fn getcap "char *name"
+.De
+Get the terminal capability
+.Vn name .
+.Ds
 .Fn getch "" \(dg
 .De
 Gets a character from the terminal and (if necessary)
@@ -447,6 +462,36 @@
 for you,
 and then reset to the original mode when finished.
 .Ds
+.Fn getcury "WINDOW *win"
+.Ds
+Get current y position on
+.Vn win .
+.Ds
+.Fn getcurx "WINDOW *win"
+.Ds
+Get current x position on
+.Vn win .
+.Ds
+.Fn getbegy "WINDOW *win"
+.Ds
+Get start y position on
+.Vn win .
+.Ds
+.Fn getbegx "WINDOW *win"
+.Ds
+Get start x position on
+.Vn win .
+.Ds
+.Fn getmaxy "WINDOW *win"
+.Ds
+Get maximum y position on
+.Vn win .
+.Ds
+.Fn getmaxx "WINDOW *win"
+.Ds
+Get maximum x position on
+.Vn win .
+.Ds
 .Fn getstr "char *str" \(dg
 .De
 Get a string through the window
@@ -776,6 +821,12 @@
 scanw(fmt, ...);
 .)l
 .Ds
+.Fn napms "int ms"
+.De
+Sleep for
+.Vn ms
+milliseconds.
+.Ds
 .Ft "WINDOW *"
 .Fn newwin "int lines" "int cols" "int begin_y" "int begin_x"
 .De
diff -r 58e94ea1a979 -r 6f9445172dc0 lib/libcurses/curses.3
--- a/lib/libcurses/curses.3    Thu May 11 22:51:10 2000 +0000
+++ b/lib/libcurses/curses.3    Thu May 11 22:54:47 2000 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: curses.3,v 1.27 2000/05/05 11:57:46 blymn Exp $
+.\"    $NetBSD: curses.3,v 1.28 2000/05/11 22:54:47 jdc Exp $
 .\"
 .\" Copyright (c) 1985, 1991, 1993
 .\"    The Regents of the University of California.  All rights reserved.
@@ -114,6 +114,9 @@
 If overlay is true then copy is nondestructive.
 .It curs_set(vis)      change cursor visibility, 0 is invisible, 1 is
 normal, 2 is high visibility.  Returns previous value on success.
+.It delay_output(ms)   pause output for
+.Em ms
+milliseconds using terminal pad character.
 .It def_prog_mode()    define program (in curses) terminal modes
 .It def_shell_mode()   define shell (not in curses) terminal modes
 .It delch()    delete a character
@@ -137,12 +140,26 @@
 .Em win
 .It fullname(termbuf,name)     get full name from
 .Em termbuf
+.It getattrs(win)      get attributes for
+.Em win
 .It getbkgd(win)       get background rendition for
 .Em win
+.It getcap(name)       get terminal capability
+.Em name
 .It getch()    get a char through
 .Em stdscr
-.It getcap(name)       get terminal capability
-.Em name
+.It getcury(win)       get current y position on
+.Em win
+.It getcurx(win)       get current x position on
+.Em win
+.It getbegy(win)       get start y position on
+.Em win
+.It getbegx(win)       get start x position on
+.Em win
+.It getmaxy(win)       get maximum y position on
+.Em win
+.It getmaxx(win)       get maximum x position on
+.Em win
 .It getstr(str)        get a string through
 .Em stdscr
 .It gettmode() get tty modes
@@ -210,6 +227,9 @@
 .Em count
 characters on window
 .Em win .
+.It napms(ms)  sleep for
+.Em ms
+milliseconds.
 .It newwin(lines,cols,begin_y,begin_x)\        create a new window
 .It nl()       set newline mapping
 .It nocbreak() unset cbreak mode