ncurses 6.2 - patch 20201205

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

diff --git a/man/curs_clear.3x b/man/curs_clear.3x
index 2cce06ea489acade0cf0f6b45679f7d733e4ce08..d86acbde6b000392b698140a1130d2e22d3d6f9d 100644 (file)
--- a/man/curs_clear.3x
+++ b/man/curs_clear.3x
@@ -27,10 +27,14 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_clear.3x,v 1.17 2020/02/02 23:34:34 tom Exp $
+.\" $Id: curs_clear.3x,v 1.20 2020/10/24 09:19:37 tom Exp $

 .TH curs_clear 3X ""
 .na
 .hy 0
 .TH curs_clear 3X ""
 .na
 .hy 0

+.de bP
+.ie n  .IP \(bu 4
+.el    .IP \(bu 2
+..

 .SH NAME
 \fBerase\fR,
 \fBwerase\fR,
 .SH NAME
 \fBerase\fR,
 \fBwerase\fR,


@@ -43,23 +47,23 @@
 .ad
 .hy
 .SH SYNOPSIS
 .ad
 .hy
 .SH SYNOPSIS

-\fB# include <curses.h>\fR
+\fB#include <curses.h>\fR

 .sp
 \fBint erase(void);\fR
 .br
 .sp
 \fBint erase(void);\fR
 .br

-\fBint werase(WINDOW *win);\fR
-.br
+\fBint werase(WINDOW *\fP\fIwin\fP\fB);\fR
+.sp

 \fBint clear(void);\fR
 .br
 \fBint clear(void);\fR
 .br

-\fBint wclear(WINDOW *win);\fR
-.br
+\fBint wclear(WINDOW *\fP\fIwin\fP\fB);\fR
+.sp

 \fBint clrtobot(void);\fR
 .br
 \fBint clrtobot(void);\fR
 .br

-\fBint wclrtobot(WINDOW *win);\fR
-.br
+\fBint wclrtobot(WINDOW *\fP\fIwin\fP\fB);\fR
+.sp

 \fBint clrtoeol(void);\fR
 .br
 \fBint clrtoeol(void);\fR
 .br

-\fBint wclrtoeol(WINDOW *win);\fR
+\fBint wclrtoeol(WINDOW *\fP\fIwin\fP\fB);\fR

 .br
 .SH DESCRIPTION
 The \fBerase\fR and \fBwerase\fR routines copy blanks to every
 .br
 .SH DESCRIPTION
 The \fBerase\fR and \fBwerase\fR routines copy blanks to every


@@ -82,12 +86,14 @@ Blanks created by erasure have the current background rendition (as set
 by \fBwbkgdset\fR) merged into them.
 .SH RETURN VALUE
 All routines return the integer \fBOK\fR on success and \fBERR\fP on failure.
 by \fBwbkgdset\fR) merged into them.
 .SH RETURN VALUE
 All routines return the integer \fBOK\fR on success and \fBERR\fP on failure.

-The SVr4.0 manual says "or a
-non-negative integer if \fBimmedok\fR is set", but this appears to be an error.

 .PP
 X/Open defines no error conditions.
 In this implementation,
 .PP
 X/Open defines no error conditions.
 In this implementation,

-functions using a window pointer parameter return an error if it is null.
+.bP
+functions using a window pointer parameter return an error if it is null
+.bP
+\fBwclrtoeol\fP returns an error
+if the cursor position is about to wrap.

 .SH NOTES
 Note that \fBerase\fR, \fBwerase\fR, \fBclear\fR, \fBwclear\fR,
 \fBclrtobot\fR, and \fBclrtoeol\fR may be macros.
 .SH NOTES
 Note that \fBerase\fR, \fBwerase\fR, \fBclear\fR, \fBwclear\fR,
 \fBclrtobot\fR, and \fBclrtoeol\fR may be macros.


@@ -97,6 +103,12 @@ The
 standard specifies that they return \fBERR\fR on failure, but specifies no
 error conditions.
 .PP
 standard specifies that they return \fBERR\fR on failure, but specifies no
 error conditions.
 .PP

+The SVr4.0 manual says that these functions could
+return "a non-negative integer if \fBimmedok\fR 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.
+.PP

 Some historic curses implementations had, as an undocumented feature, the
 ability to do the equivalent of \fBclearok(..., 1)\fR by saying
 \fBtouchwin(stdscr)\fR or \fBclear(stdscr)\fR.
 Some historic curses implementations had, as an undocumented feature, the
 ability to do the equivalent of \fBclearok(..., 1)\fR by saying
 \fBtouchwin(stdscr)\fR or \fBclear(stdscr)\fR.