X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_clear.3x;h=2e3f2be6899fd69085b305e9fd7bb3ea0404a2cb;hb=725169bda4d3b4c3fde0d4a94f76d017812c7ea6;hp=d2af035169c70bce2abfa4619258b1387e5fe4c1;hpb=894a177fd5228cdbe790bd1dc9435bd435c29681;p=ncurses.git diff --git a/man/curs_clear.3x b/man/curs_clear.3x index d2af0351..2e3f2be6 100644 --- a/man/curs_clear.3x +++ b/man/curs_clear.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2022,2023 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 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,19 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_clear.3x,v 1.38 2023/10/07 21:19:07 tom Exp $ -.TH curs_clear 3X 2023-10-07 "ncurses 6.4" "Library calls" +.\" $Id: curs_clear.3x,v 1.46 2024/03/16 15:35:01 tom Exp $ +.TH curs_clear 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} +. .de bP .ie n .IP \(bu 4 .el .IP \(bu 2 @@ -60,23 +71,23 @@ clear all or part of a \fIcurses\fR window \fBint wclrtoeol(WINDOW *\fIwin\fP); .fi .SH DESCRIPTION -.SS erase/werase +.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 +.SS "clear, wclear" The \fBclear\fP and \fBwclear\fP routines are like \fBerase\fP and \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 +.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. -.SS clrtoeol/wclrtoeol +.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. .SH RETURN VALUE @@ -94,12 +105,9 @@ Note that \fBerase\fP, \fBwerase\fP, \fBclear\fP, \fBwclear\fP, \fBclrtobot\fP, and \fBclrtoeol\fP may be macros. .SH PORTABILITY These functions are described in the XSI Curses standard, Issue 4. -The -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(3X) is set", +The SVr4.0 manual says that these functions could return +\*(``or a non-negative integer if \fB\%immedok\fP 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. @@ -108,7 +116,7 @@ Some historic curses implementations had, as an undocumented feature, the ability to do the equivalent of \fBclearok(..., 1)\fP by saying \fBtouchwin(stdscr)\fP or \fBclear(stdscr)\fP. This will not work under -ncurses. +\fI\%ncurses\fP. .PP This implementation, and others such as Solaris, sets the current position to 0,0 after erasing