.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_clear.3x,v 1.23 2022/02/12 20:06:41 tom Exp $
+.\" $Id: curs_clear.3x,v 1.27 2022/11/26 16:23:47 tom Exp $
.TH curs_clear 3X ""
.na
.hy 0
\fBint wclrtoeol(WINDOW *\fIwin\fB);\fR
.br
.SH DESCRIPTION
+.SS erase/werase
The \fBerase\fP and \fBwerase\fP routines copy blanks to every
position in the window, clearing the screen.
.PP
+Blanks created by erasure have the current background rendition (as set
+by \fBwbkgdset\fP(3X)) merged into them.
+.SS clear/wclear
+.PP
The \fBclear\fP and \fBwclear\fP routines are like \fBerase\fP and
-\fBwerase\fP, but they also call \fBclearok\fP, so that the screen is
+\fBwerase\fP, but they also call \fBclearok\fP(3X), so that the screen is
cleared completely on the next call to \fBwrefresh\fP for that window
and repainted from scratch.
+.SS clrtobot/wclrtobot
.PP
The \fBclrtobot\fP and \fBwclrtobot\fP routines erase from the cursor to the
end of screen.
That is, they erase all lines below the cursor in the window.
Also, the current line to the right of the cursor, inclusive, is erased.
+.SS clrtoeol/wclrtoeol
.PP
The \fBclrtoeol\fP and \fBwclrtoeol\fP routines erase the current line
to the right of the cursor, inclusive, to the end of the current line.
-.PP
-Blanks created by erasure have the current background rendition (as set
-by \fBwbkgdset\fP) merged into them.
.SH RETURN VALUE
All routines return the integer \fBOK\fP on success and \fBERR\fP on failure.
.PP
error conditions.
.PP
The SVr4.0 manual says that these functions could
-return "a non-negative integer if \fBimmedok\fP is set",
+return "a non-negative integer if \fBimmedok\fP(3X) is set",
referring to the return-value of \fBwrefresh\fP.
In that implementation, \fBwrefresh\fP would return a count of
the number of characters written to the terminal.