Module Name: src
Committed By: drochner
Date: Wed Feb 24 13:02:13 UTC 2010
Modified Files:
src/lib/libcurses: curses_cursor.3 curses_touch.3
Log Message:
document wsyncup/wsyncdown/wcursyncup
To generate a diff of this commit:
cvs rdiff -u -r1.6 -r1.7 src/lib/libcurses/curses_cursor.3
cvs rdiff -u -r1.7 -r1.8 src/lib/libcurses/curses_touch.3
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/lib/libcurses/curses_cursor.3
diff -u src/lib/libcurses/curses_cursor.3:1.6 src/lib/libcurses/curses_cursor.3:1.7
--- src/lib/libcurses/curses_cursor.3:1.6 Fri Jul 23 13:42:16 2004
+++ src/lib/libcurses/curses_cursor.3 Wed Feb 24 13:02:13 2010
@@ -1,4 +1,4 @@
-.\" $NetBSD: curses_cursor.3,v 1.6 2004/07/23 13:42:16 wiz Exp $
+.\" $NetBSD: curses_cursor.3,v 1.7 2010/02/24 13:02:13 drochner Exp $
.\"
.\" Copyright (c) 2002
.\" Brett Lymn ([email protected], [email protected])
@@ -30,7 +30,7 @@
.\" SUCH DAMAGE.
.\"
.\"
-.Dd July 23, 2004
+.Dd February 23, 2010
.Dt CURSES 3
.Os
.Sh NAME
@@ -49,7 +49,8 @@
.Nm getparyx ,
.Nm move ,
.Nm wmove ,
-.Nm mvcur
+.Nm mvcur ,
+.Nm wcursyncup
.Nd curses cursor and window location and positioning routines
.Sh LIBRARY
.Lb libcurses
@@ -85,6 +86,8 @@
.Fn wmove "WINDOW *win" "int y" "int x"
.Ft int
.Fn mvcur "int oldy" "int oldx" "int y" "int x"
+.Ft void
+.Fn wcursyncup "WINDOW *win"
.Sh DESCRIPTION
These functions and macros locate and position cursors and windows.
.Pp
@@ -177,6 +180,13 @@
.Fn mvcur
exceed the terminal bounds an error will be returned and the cursor
position will be unchanged.
+.Pp
+The
+.Fn wcursyncup
+function sets the cursor positions of all ancestors of
+.Fa win
+to that of
+.Fa win .
.Sh RETURN VALUES
Functions returning pointers will return
.Dv NULL
Index: src/lib/libcurses/curses_touch.3
diff -u src/lib/libcurses/curses_touch.3:1.7 src/lib/libcurses/curses_touch.3:1.8
--- src/lib/libcurses/curses_touch.3:1.7 Fri Mar 4 11:41:36 2005
+++ src/lib/libcurses/curses_touch.3 Wed Feb 24 13:02:13 2010
@@ -1,4 +1,4 @@
-.\" $NetBSD: curses_touch.3,v 1.7 2005/03/04 11:41:36 wiz Exp $
+.\" $NetBSD: curses_touch.3,v 1.8 2010/02/24 13:02:13 drochner Exp $
.\"
.\" Copyright (c) 2002
.\" Brett Lymn ([email protected], [email protected])
@@ -30,7 +30,7 @@
.\" SUCH DAMAGE.
.\"
.\"
-.Dd March 4, 2005
+.Dd February 23, 2010
.Dt CURSES_TOUCH 3
.Os
.Sh NAME
@@ -43,7 +43,9 @@
.Nm is_linetouched ,
.Nm is_wintouched ,
.Nm redrawwin ,
-.Nm wredrawln
+.Nm wredrawln ,
+.Nm wsyncup ,
+.Nm wsyncdown
.Nd curses window modification routines
.Sh LIBRARY
.Lb libcurses
@@ -67,6 +69,10 @@
.Fn redrawwin "WINDOW *win"
.Ft int
.Fn wredrawln "WINDOW *win" "int line" "int n"
+.Ft void
+.Fn wsyncup "WINDOW *win"
+.Ft void
+.Fn wsyncdown "WINDOW *win"
.Sh DESCRIPTION
These functions mark lines and windows as modified and check the modification
status of lines and windows.
@@ -157,6 +163,17 @@
in the given window as corrupted.
It is equivalent to
.Fn wtouchln win line n 1 .
+.Pp
+The
+.Fn wsyncup
+function touches all ancestors of
+.Fa win .
+.Pp
+The
+.Fn wsyncdown
+function touches
+.Fa win
+if any of its ancestors is touched.
.Sh RETURN VALUES
Functions returning pointers will return
.Dv NULL
