vasilito
ff4ff35918
Red Bear OS is a full fork. All sources must be available from git clone with zero network access. Removed gitignore rules that excluded fetched source trees under recipes/*/source/, local/recipes/kde/*/source/, local/recipes/qt/*/source/, and vendor source trees. Build artifacts (target/, build/, source.tar, *.o, *.so) remain excluded. 127291 files added — kernel, relibc, base, bootloader, pkgar, all KDE/Qt frameworks, mesa, wayland, DRM drivers, and every other recipe source.
173 lines
6.7 KiB
Plaintext
173 lines
6.7 KiB
Plaintext
.\"***************************************************************************
|
|
.\" Copyright 2018-2024,2025 Thomas E. Dickey *
|
|
.\" Copyright 1998-2010,2016 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 *
|
|
.\" "Software"), to deal in the Software without restriction, including *
|
|
.\" without limitation the rights to use, copy, modify, merge, publish, *
|
|
.\" distribute, distribute with modifications, sublicense, and/or sell *
|
|
.\" copies of the Software, and to permit persons to whom the Software is *
|
|
.\" furnished to do so, subject to the following conditions: *
|
|
.\" *
|
|
.\" The above copyright notice and this permission notice shall be included *
|
|
.\" in all copies or substantial portions of the Software. *
|
|
.\" *
|
|
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|
.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|
.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|
.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|
.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|
.\" *
|
|
.\" Except as contained in this notice, the name(s) of the above copyright *
|
|
.\" holders shall not be used in advertising or otherwise to promote the *
|
|
.\" sale, use or other dealings in this Software without prior written *
|
|
.\" authorization. *
|
|
.\"***************************************************************************
|
|
.\"
|
|
.\" $Id: curs_refresh.3x,v 1.58 2025/01/19 00:51:10 tom Exp $
|
|
.TH curs_refresh 3X 2025-01-18 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
|
|
.ie \n(.g \{\
|
|
.ds `` \(lq
|
|
.ds '' \(rq
|
|
.\}
|
|
.el \{\
|
|
.ie t .ds `` ``
|
|
.el .ds `` ""
|
|
.ie t .ds '' ''
|
|
.el .ds '' ""
|
|
.\}
|
|
.
|
|
.de bP
|
|
.ie n .IP \(bu 4
|
|
.el .IP \(bu 2
|
|
..
|
|
.SH NAME
|
|
\fB\%doupdate\fP,
|
|
\fB\%redrawwin\fP,
|
|
\fB\%refresh\fP,
|
|
\fB\%wnoutrefresh\fP,
|
|
\fB\%wredrawln\fP,
|
|
\fB\%wrefresh\fP \-
|
|
refresh \fIcurses\fR windows or lines thereupon
|
|
.SH SYNOPSIS
|
|
.nf
|
|
\fB#include <curses.h>
|
|
.PP
|
|
\fBint refresh(void);
|
|
\fBint wrefresh(WINDOW *\fIwin\fP);
|
|
\fBint wnoutrefresh(WINDOW *\fIwin\fP);
|
|
\fBint doupdate(void);
|
|
.PP
|
|
\fBint redrawwin(WINDOW *\fIwin\fP);
|
|
\fBint wredrawln(WINDOW *\fIwin\fP, int \fIbeg_line\fP, int \fInum_lines\fP);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
.SS "refresh, wrefresh"
|
|
The \fBrefresh\fP and \fBwrefresh\fP routines (or \fBwnoutrefresh\fP and
|
|
\fBdoupdate\fP) must be called to get actual output to the terminal,
|
|
as other routines merely manipulate data structures.
|
|
The routine \fBwrefresh\fP copies
|
|
the named window to the \fIphysical screen\fP,
|
|
taking into account what is already there to do optimizations.
|
|
The \fBrefresh\fP routine is the
|
|
same, using \fBstdscr\fP as the default window.
|
|
Unless \fBleaveok\fP(3X) has been
|
|
enabled, the physical cursor of the terminal is left at the location of the
|
|
cursor for that window.
|
|
.SS "wnoutrefresh, doupdate"
|
|
The \fBwnoutrefresh\fP and \fBdoupdate\fP routines allow multiple updates with
|
|
more efficiency than \fBwrefresh\fP alone.
|
|
In addition to all the window
|
|
structures, \fBcurses\fP keeps two data structures representing the terminal
|
|
screen:
|
|
.bP
|
|
a \fIphysical screen\fP,
|
|
describing what is actually on the screen, and
|
|
.bP
|
|
a \fIvirtual screen\fP,
|
|
describing what the programmer wants to have on the screen.
|
|
.PP
|
|
The routine \fBwrefresh\fP works by
|
|
.bP
|
|
first calling \fBwnoutrefresh\fP,
|
|
which copies the named window to the \fIvirtual screen\fP, and
|
|
.bP
|
|
then calling \fBdoupdate\fP, which compares
|
|
the \fIvirtual screen\fP to the \fIphysical screen\fP
|
|
and does the actual update.
|
|
.PP
|
|
If the programmer wishes to output several windows at once, a series
|
|
of calls to \fBwrefresh\fP results in alternating calls to \fBwnoutrefresh\fP
|
|
and \fBdoupdate\fP, causing several bursts of output to the screen.
|
|
By first
|
|
calling \fBwnoutrefresh\fP for each window, it is then possible to call
|
|
\fBdoupdate\fP once, resulting in only one burst of output, with fewer total
|
|
characters transmitted and less CPU time used.
|
|
.PP
|
|
If the \fIwin\fP argument to
|
|
\fBwrefresh\fP is the \fIphysical screen\fP
|
|
(i.e., the global variable \fBcurscr\fP),
|
|
the screen is immediately cleared and repainted from scratch.
|
|
.PP
|
|
The phrase \*(``copies the named window
|
|
to the virtual screen\*('' above is ambiguous.
|
|
What actually happens is that all \fItouched\fP (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 modified only when it is explicitly
|
|
changed.
|
|
(But see the section on \fBPORTABILITY\fP below for a warning about
|
|
exploiting this behavior.)
|
|
.SS "wredrawln, redrawwin"
|
|
The \fBwredrawln\fP routine indicates to \fBcurses\fP 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 routine \fBredrawwin\fP touches the entire window.
|
|
.SH RETURN VALUE
|
|
These routines return the integer \fBERR\fP upon failure and \fBOK\fP
|
|
.PP
|
|
In this implementation
|
|
.RS 3
|
|
.TP 5
|
|
\fBwnoutrefresh\fP
|
|
returns
|
|
.B ERR
|
|
if the window pointer is null, or
|
|
if the window is really a pad.
|
|
.TP 5
|
|
\fBwredrawln\fP
|
|
return
|
|
.B ERR
|
|
if the associated call to \fBtouchln\fP returns
|
|
.BR ERR "."
|
|
.RE
|
|
.SH NOTES
|
|
.B \%refresh
|
|
and
|
|
.B \%redrawwin
|
|
may be implemented as macros.
|
|
.SH PORTABILITY
|
|
X/Open Curses Issue\ 4 describes these functions.
|
|
It specifies no error conditions for them.
|
|
.PP
|
|
SVr4 describes a successful return value only as
|
|
\*(``an integer value other than
|
|
.IR ERR \*(''. \" Courier roman in source; SVID 4, vol. 3, p. 527
|
|
.PP
|
|
Whether \fBwnoutrefresh\fP 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 \fBtouchwin\fP before the
|
|
\fBwnoutrefresh\fP call to guarantee an entire-contents copy anywhere.
|
|
.SH SEE ALSO
|
|
\fB\%curses\fP(3X),
|
|
\fB\%curs_outopts\fP(3X),
|
|
\fB\%curs_variables\fP(3X)
|