summaryrefslogtreecommitdiff
path: root/man/curs_refresh.3x
diff options
context:
space:
mode:
Diffstat (limited to 'man/curs_refresh.3x')
-rw-r--r--man/curs_refresh.3x33
1 files changed, 20 insertions, 13 deletions
diff --git a/man/curs_refresh.3x b/man/curs_refresh.3x
index ac81d1e6393e..37fd5f19f17b 100644
--- a/man/curs_refresh.3x
+++ b/man/curs_refresh.3x
@@ -1,5 +1,5 @@
.\"***************************************************************************
-.\" Copyright 2018-2023,2024 Thomas E. Dickey *
+.\" 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 *
@@ -27,8 +27,8 @@
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_refresh.3x,v 1.46 2024/04/20 21:20:07 tom Exp $
-.TH curs_refresh 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
+.\" $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
@@ -129,27 +129,34 @@ 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
-(SVr4 specifies only
-\*(``an integer value other than \fBERR\fP\*('')
-upon successful completion.
.PP
-X/Open Curses does not specify any error conditions.
In this implementation
.RS 3
.TP 5
\fBwnoutrefresh\fP
-returns an error
+returns
+.B ERR
if the window pointer is null, or
if the window is really a pad.
.TP 5
\fBwredrawln\fP
-returns an error
-if the associated call to \fBtouchln\fP returns an error.
+return
+.B ERR
+if the associated call to \fBtouchln\fP returns
+.BR ERR "."
.RE
.SH NOTES
-Note that \fBrefresh\fP and \fBredrawwin\fP may be macros.
+.B \%refresh
+and
+.B \%redrawwin
+may be implemented as macros.
.SH PORTABILITY
-X/Open Curses, Issue 4 describes these functions.
+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
@@ -161,5 +168,5 @@ 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_outopts\fP(3X),
\fB\%curs_variables\fP(3X)