aboutsummaryrefslogtreecommitdiff
path: root/contrib/ncurses/man/curs_refresh.3x
diff options
context:
space:
mode:
authorPeter Wemm <peter@FreeBSD.org>2002-05-21 05:30:25 +0000
committerPeter Wemm <peter@FreeBSD.org>2002-05-21 05:30:25 +0000
commit39f2269fcb4873fd97d70af944ec49f4230fadea (patch)
treebd986d58f5a6e348466b5362637ba93e6cd5bf8c /contrib/ncurses/man/curs_refresh.3x
parent7e6a63408cfb0b48f0e41f77ed82f5d0ca60bda5 (diff)
downloadsrc-39f2269fcb4873fd97d70af944ec49f4230fadea.tar.gz
src-39f2269fcb4873fd97d70af944ec49f4230fadea.zip
Import ncurses-5.2-20020518 onto the vendor branch.
Obtained from: ftp://dickey.his.com/ncurses/
Notes
Notes: svn path=/vendor/ncurses/dist/; revision=97049
Diffstat (limited to 'contrib/ncurses/man/curs_refresh.3x')
-rw-r--r--contrib/ncurses/man/curs_refresh.3x45
1 files changed, 28 insertions, 17 deletions
diff --git a/contrib/ncurses/man/curs_refresh.3x b/contrib/ncurses/man/curs_refresh.3x
index 9b4cb1df1c98..210b326a618a 100644
--- a/contrib/ncurses/man/curs_refresh.3x
+++ b/contrib/ncurses/man/curs_refresh.3x
@@ -1,5 +1,5 @@
.\"***************************************************************************
-.\" Copyright (c) 1998,2000 Free Software Foundation, Inc. *
+.\" Copyright (c) 1998,2000,2001 Free Software Foundation, Inc. *
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
.\" copy of this software and associated documentation files (the *
@@ -26,15 +26,15 @@
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_refresh.3x,v 1.8 2000/07/01 20:06:14 tom Exp $
+.\" $Id: curs_refresh.3x,v 1.10 2001/11/03 18:57:12 tom Exp $
.TH curs_refresh 3X ""
.SH NAME
-\fBrefresh\fR,
-\fBwrefresh\fR,
-\fBwnoutrefresh\fR,
\fBdoupdate\fR,
\fBredrawwin\fR,
-\fBwredrawln\fR - refresh \fBcurses\fR windows and lines
+\fBrefresh\fR,
+\fBwnoutrefresh\fR,
+\fBwredrawln\fR,
+\fBwrefresh\fR - refresh \fBcurses\fR windows and lines
.SH SYNOPSIS
\fB#include <curses.h>\fR
@@ -53,15 +53,19 @@
.SH DESCRIPTION
The \fBrefresh\fR and \fBwrefresh\fR routines (or \fBwnoutrefresh\fR and
\fBdoupdate\fR) must be called to get actual output to the terminal, as other
-routines merely manipulate data structures. The routine \fBwrefresh\fR copies
+routines merely manipulate data structures.
+The routine \fBwrefresh\fR copies
the named window to the physical terminal screen, taking into account what is
-already there in order to do optimizations. The \fBrefresh\fR routine is the
-same, using \fBstdscr\fR as the default window. Unless \fBleaveok\fR has been
+already there to do optimizations.
+The \fBrefresh\fR routine is the
+same, using \fBstdscr\fR as the default window.
+Unless \fBleaveok\fR has been
enabled, the physical cursor of the terminal is left at the location of the
cursor for that window.
The \fBwnoutrefresh\fR and \fBdoupdate\fR routines allow multiple updates with
-more efficiency than \fBwrefresh\fR alone. In addition to all the window
+more efficiency than \fBwrefresh\fR alone.
+In addition to all the window
structures, \fBcurses\fR keeps two data structures representing the terminal
screen: a physical screen, describing what is actually on the screen, and a
virtual screen, describing what the programmer wants to have on the screen.
@@ -69,21 +73,26 @@ virtual screen, describing what the programmer wants to have on the screen.
The routine \fBwrefresh\fR works by first calling \fBwnoutrefresh\fR, which
copies the named window to the virtual screen, and then calling \fBdoupdate\fR,
which compares the virtual screen to the physical screen and does the actual
-update. If the programmer wishes to output several windows at once, a series
+update.
+If the programmer wishes to output several windows at once, a series
of calls to \fBwrefresh\fR results in alternating calls to \fBwnoutrefresh\fR
-and \fBdoupdate\fR, causing several bursts of output to the screen. By first
+and \fBdoupdate\fR, causing several bursts of output to the screen.
+By first
calling \fBwnoutrefresh\fR for each window, it is then possible to call
\fBdoupdate\fR once, resulting in only one burst of output, with fewer total
-characters transmitted and less CPU time used. If the \fIwin\fR argument to
+characters transmitted and less CPU time used.
+If the \fIwin\fR argument to
\fBwrefresh\fR is the global variable \fBcurscr\fR, the screen is immediately
cleared and repainted from scratch.
The phrase "copies the named window to the virtual screen" above is ambiguous.
What actually happens is that all \fItouched\fR (changed) lines in the window
-are copied to the virtual screen. This affects programs that use overlapping
+are copied to the virtual screen.
+This affects programs that use overlapping
windows; it means that if two windows overlap, you can refresh them in either
order and the overlap region will be modified only when it is explicitly
-changed. (But see the section on \fBPORTABILITY\fR below for a warning about
+changed.
+(But see the section on \fBPORTABILITY\fR below for a warning about
exploiting this behavior.)
The \fBwredrawln\fR routine indicates to \fBcurses\fR that some screen lines
@@ -101,9 +110,11 @@ The XSI Curses standard, Issue 4 describes these functions.
Whether \fBwnoutrefresh()\fR copies to the virtual screen the entire contents
of a window or just its changed portions has never been well-documented in
-historic curses versions (including SVr4). It might be unwise to rely on
+historic curses versions (including SVr4).
+It might be unwise to rely on
either behavior in programs that might have to be linked with other curses
-implementations. Instead, you can do an explicit \fBtouchwin()\fR before the
+implementations.
+Instead, you can do an explicit \fBtouchwin()\fR before the
\fBwnoutrefresh()\fR call to guarantee an entire-contents copy anywhere.
.SH SEE ALSO
\fBcurses\fR(3X), \fBcurs_outopts\fR(3X)