ncurses 6.4 - patch 20230917

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

diff --git a/man/curs_clear.3x b/man/curs_clear.3x
index 234574f59c1d089a99bdf4797c881a0989afd685..1c8d3535f15c5613deb5978196bb2a04ae92c941 100644 (file)
--- a/man/curs_clear.3x
+++ b/man/curs_clear.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright 2018-2020,2021 Thomas E. Dickey                                *
+.\" Copyright 2018-2022,2023 Thomas E. Dickey                                *
 .\" Copyright 1998-2010,2016 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
@@ -27,63 +27,60 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_clear.3x,v 1.22 2021/12/25 21:41:58 tom Exp $
-.TH curs_clear 3X ""
-.na
-.hy 0
+.\" $Id: curs_clear.3x,v 1.35 2023/09/16 23:34:43 tom Exp $
+.TH curs_clear 3X 2023-09-16 "ncurses 6.4" "Library calls"
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
 .SH NAME
-\fBerase\fP,
-\fBwerase\fP,
-\fBclear\fP,
-\fBwclear\fP,
-\fBclrtobot\fP,
-\fBwclrtobot\fP,
-\fBclrtoeol\fP,
-\fBwclrtoeol\fP \- clear all or part of a \fBcurses\fP window
-.ad
-.hy
+\fB\%erase\fP,
+\fB\%werase\fP,
+\fB\%clear\fP,
+\fB\%wclear\fP,
+\fB\%clrtobot\fP,
+\fB\%wclrtobot\fP,
+\fB\%clrtoeol\fP,
+\fB\%wclrtoeol\fP \-
+clear all or part of a \fIcurses\fR window
 .SH SYNOPSIS
 \fB#include <curses.h>\fP
 .sp
 \fBint erase(void);\fP
 .br
-\fBint werase(WINDOW *\fP\fIwin\fP\fB);\fP
+\fBint werase(WINDOW *\fIwin\fB);\fR
 .sp
 \fBint clear(void);\fP
 .br
-\fBint wclear(WINDOW *\fP\fIwin\fP\fB);\fP
+\fBint wclear(WINDOW *\fIwin\fB);\fR
 .sp
 \fBint clrtobot(void);\fP
 .br
-\fBint wclrtobot(WINDOW *\fP\fIwin\fP\fB);\fP
+\fBint wclrtobot(WINDOW *\fIwin\fB);\fR
 .sp
 \fBint clrtoeol(void);\fP
 .br
-\fBint wclrtoeol(WINDOW *\fP\fIwin\fP\fB);\fP
-.br
+\fBint wclrtoeol(WINDOW *\fIwin\fB);\fR
 .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
 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.
-.PP
+.SS clrtobot/wclrtobot
 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.
-.PP
+.SS clrtoeol/wclrtoeol
 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 +101,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.