ncurses 6.3 - patch 20221126

[ncurses.git] / man / curs_clear.3x

diff --git a/man/curs_clear.3x b/man/curs_clear.3x
index fd30771117753b98b9e424428a6bc11b658e96a7..36ff2781e77043650cc35a3c6b02312b49765229 100644 (file)
--- a/man/curs_clear.3x
+++ b/man/curs_clear.3x
@@ -27,7 +27,7 @@
 .\" 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
@@ -66,24 +66,28 @@
 \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
@@ -104,7 +108,7 @@ standard specifies that they return \fBERR\fP on failure, but specifies no
 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.