src - FreeBSD source tree

diff options


context:
space:
mode:

author	Baptiste Daroussin <bapt@FreeBSD.org>	2020-02-07 08:36:41 +0000
committer	Baptiste Daroussin <bapt@FreeBSD.org>	2020-02-07 08:36:41 +0000
commit	f0179cb6083cc92e5947ae56e6a0a5c5328aead0 (patch)
tree	bcee0ba9c2149b71f0bfc036df1e61e3105bf980 /doc/html/man/curs_refresh.3x.html
parent	cea297eb34d2361e79529034397465068ae34ecd (diff)
download	src-f0179cb6083cc92e5947ae56e6a0a5c5328aead0.tar.gz src-f0179cb6083cc92e5947ae56e6a0a5c5328aead0.zip

Vendor import ncurses 6.1-20200118vendor/ncurses/6.1-20200118

Notes

Notes: svn path=/vendor/ncurses/dist/; revision=357645 svn path=/vendor/ncurses/6.1-20200118/; revision=357646; tag=vendor/ncurses/6.1-20200118

Diffstat (limited to 'doc/html/man/curs_refresh.3x.html')

-rw-r--r--

doc/html/man/curs_refresh.3x.html

208

1 files changed, 109 insertions, 99 deletions

diff --git a/doc/html/man/curs_refresh.3x.html b/doc/html/man/curs_refresh.3x.html
index ad8874992203..04ca3d0da9e2 100644
--- a/doc/html/man/curs_refresh.3x.html
+++ b/doc/html/man/curs_refresh.3x.html

@@ -1,7 +1,6 @@

-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">

<!--

****************************************************************************

* *

* Permission is hereby granted, free of charge, to any person obtaining a *

* copy of this software and associated documentation files (the *

@@ -27,32 +26,31 @@

* sale, use or other dealings in this Software without prior written *

* authorization. *

****************************************************************************

- * @Id: curs_refresh.3x,v 1.15 2010/12/04 18:38:55 tom Exp @

+ * @Id: curs_refresh.3x,v 1.20 2019/11/30 21:06:30 tom Exp @

-->

+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">

<HTML>

<HEAD>

+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">

+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">

<TITLE>curs_refresh 3x</TITLE>

-<link rev=made href="mailto:bug-ncurses@gnu.org">

+<link rel="author" href="mailto:bug-ncurses@gnu.org">

</HEAD>

<BODY>

-<H1>curs_refresh 3x</H1>

-<HR>

+<H1 class="no-header">curs_refresh 3x</H1>

<PRE>

-

-<A HREF="curs_refresh.3x.html">curs_refresh(3x)</A> <A HREF="curs_refresh.3x.html">curs_refresh(3x)</A>

+<A HREF="curs_refresh.3x.html">curs_refresh(3x)</A> <A HREF="curs_refresh.3x.html">curs_refresh(3x)</A>

-</PRE>

-<H2>NAME</H2><PRE>

- doupdate, redrawwin, refresh, wnoutrefresh, wredrawln,

- wrefresh - refresh curses windows and lines

+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>

+ doupdate, redrawwin, refresh, wnoutrefresh, wredrawln, wrefresh -

+ refresh curses windows and lines

-</PRE>

-<H2>SYNOPSIS</H2><PRE>

+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>

#include <curses.h>

int refresh(void);

@@ -63,108 +61,120 @@

int wredrawln(WINDOW *win, int beg_line, int num_lines);

-</PRE>

-<H2>DESCRIPTION</H2><PRE>

- The refresh and wrefresh routines (or wnoutrefresh and

- doupdate) must be called to get actual output to the ter-

- minal, as other routines merely manipulate data struc-

- tures. The routine wrefresh copies the named window to

- the physical terminal screen, taking into account what is

- already there to do optimizations. The refresh routine is

- the same, using stdscr as the default window. Unless

- leaveok has been enabled, the physical cursor of the ter-

- minal is left at the location of the cursor for that win-

- dow.

- The wnoutrefresh and doupdate routines allow multiple up-

- dates with more efficiency than wrefresh alone. In addi-

- tion to all the window structures, curses 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.

- The routine wrefresh works by first calling wnoutrefresh,

- which copies the named window to the virtual screen, and

- then calling doupdate, 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 se-

- ries of calls to wrefresh results in alternating calls to

- wnoutrefresh and doupdate, causing several bursts of out-

- put to the screen. By first calling wnoutrefresh for each

- window, it is then possible to call doupdate once, result-

- ing in only one burst of output, with fewer total charac-

- ters transmitted and less CPU time used. If the win argu-

- ment to wrefresh is the global variable curscr, 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

- touched (changed) lines in the window are copied to the

- virtual screen. This affects programs that use overlap-

- ping 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 PORTABILITY below for a warning about

- exploiting this behavior.)

- The wredrawln routine indicates to curses that some screen

- lines are corrupted and should be thrown away before any-

- thing is written over them. It touches the indicated

- lines (marking them changed). The routine redrawwin()

- touches the entire window.

+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>

+</PRE><H3><a name="h3-refresh_wrefresh">refresh/wrefresh</a></H3><PRE>

+ The refresh and wrefresh routines (or wnoutrefresh and doupdate) must

+ be called to get actual output to the terminal, as other routines mere-

+ ly manipulate data structures. The routine wrefresh copies the named

+ window to the physical screen, taking into account what is already

+ there to do optimizations. The refresh routine is the same, using std-

+ scr as the default window. Unless leaveok has been enabled, the physi-

+ cal cursor of the terminal is left at the location of the cursor for

+ that window.

-</PRE>

-<H2>RETURN VALUE</H2><PRE>

- Routines that return an integer return ERR upon failure,

- and OK (SVr4 only specifies "an integer value other than

- ERR") upon successful completion.

- X/Open does not define any error conditions. In this im-

- plementation

+</PRE><H3><a name="h3-wnoutrefresh_doupdate">wnoutrefresh/doupdate</a></H3><PRE>

+ The wnoutrefresh and doupdate routines allow multiple updates with more

+ efficiency than wrefresh alone. In addition to all the window struc-

+ tures, curses keeps two data structures representing the terminal

+ screen:

- wnoutrefresh

- returns an error if the window pointer is

- null, or if the window is really a pad.

+ o a physical screen, describing what is actually on the screen, and

- wredrawln

- returns an error if the associated call to

- touchln returns an error.

+ o a virtual screen, describing what the programmer wants to have on

+ the screen.

+ The routine wrefresh works by

-</PRE>

-<H2>NOTES</H2><PRE>

+ o first calling wnoutrefresh, which copies the named window to the

+ virtual screen, and

+ o then calling doupdate, 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 of

+ calls to wrefresh results in alternating calls to wnoutrefresh and

+ doupdate, causing several bursts of output to the screen. By first

+ calling wnoutrefresh for each window, it is then possible to call doup-

+ date once, resulting in only one burst of output, with fewer total

+ characters transmitted and less CPU time used.

+ If the win argument to wrefresh is the physical screen (i.e., the glob-

+ al variable curscr), the screen is immediately cleared and repainted

+ from scratch.

+ The phrase "copies the named window to the virtual screen" above is am-

+ biguous. What actually happens is that all touched (changed) lines in

+ the window 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 modi-

+ fied only when it is explicitly changed. (But see the section on

+ PORTABILITY below for a warning about exploiting this behavior.)

+</PRE><H3><a name="h3-wredrawln_redrawwin">wredrawln/redrawwin</a></H3><PRE>

+ The wredrawln routine indicates to curses that some screen lines are

+ corrupted and should be thrown away before anything is written over

+ them. It touches the indicated lines (marking them changed). The rou-

+ tine redrawwin touches the entire window.

+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>

+ Routines that return an integer return ERR upon failure, and OK (SVr4

+ only specifies "an integer value other than ERR") upon successful com-

+ pletion.

+ X/Open does not define any error conditions. In this implementation

+ wnoutrefresh

+ returns an error if the window pointer is null, or if the win-

+ dow is really a pad.

+ wredrawln

+ returns an error if the associated call to touchln returns an

+ error.

+</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>

Note that refresh and redrawwin may be macros.

-</PRE>

-<H2>PORTABILITY</H2><PRE>

- The XSI Curses standard, Issue 4 describes these func-

- tions.

+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>

+ The XSI Curses standard, Issue 4 describes these functions.

- Whether wnoutrefresh() 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 either

- behavior in programs that might have to be linked with

- other curses implementations. Instead, you can do an ex-

- plicit touchwin() before the wnoutrefresh() call to guar-

- antee an entire-contents copy anywhere.

+ Whether wnoutrefresh 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 either behavior in programs that might have to be linked with

+ other curses implementations. Instead, you can do an explicit touchwin

+ before the wnoutrefresh call to guarantee an entire-contents copy any-

+ where.

-</PRE>

-<H2>SEE ALSO</H2><PRE>

+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>

<A HREF="ncurses.3x.html">curses(3x)</A>, <A HREF="curs_outopts.3x.html">curs_outopts(3x)</A> <A HREF="curs_variables.3x.html">curs_variables(3x)</A>.

- <A HREF="curs_refresh.3x.html">curs_refresh(3x)</A>

+ <A HREF="curs_refresh.3x.html">curs_refresh(3x)</A>

</PRE>

-<HR>

-<ADDRESS>

-Man(1) output converted with

-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>

-</ADDRESS>

+<div class="nav">

+<ul>

+<li><a href="#h2-NAME">NAME</a></li>

+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>

+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>

+<ul>

+<li><a href="#h3-refresh_wrefresh">refresh/wrefresh</a></li>

+<li><a href="#h3-wnoutrefresh_doupdate">wnoutrefresh/doupdate</a></li>

+<li><a href="#h3-wredrawln_redrawwin">wredrawln/redrawwin</a></li>

+</ul>

+</li>

+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>

+<li><a href="#h2-NOTES">NOTES</a></li>

+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>

+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>

+</ul>

+</div>

</BODY>

</HTML>