X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_clear.3x.html;h=86bb486851aa0e31b45cb658721de3fa2b958643;hp=6838d5b99c3e882706005be51fa8b2aef0f05ba8;hb=ca276baf720e3a44721b9e18955d3f546955c6c8;hpb=a8987e73ec254703634802b4f7ee30d3a485524d;ds=sidebyside
diff --git a/doc/html/man/curs_clear.3x.html b/doc/html/man/curs_clear.3x.html
index 6838d5b9..86bb4868 100644
--- a/doc/html/man/curs_clear.3x.html
+++ b/doc/html/man/curs_clear.3x.html
@@ -1,7 +1,7 @@
@@ -40,15 +40,15 @@
-curs_clear(3x) curs_clear(3x)
+curs_clear(3x) curs_clear(3x)
NAME
- erase, werase, clear, wclear, clrtobot, wclrtobot, clr-
- toeol, wclrtoeol - clear all or part of a curses window
+ erase, werase, clear, wclear, clrtobot, wclrtobot,
+ clrtoeol, wclrtoeol - clear all or part of a curses window
@@ -67,21 +67,21 @@
DESCRIPTION
- The erase and werase routines copy blanks to every posi-
+ The erase and werase routines copy blanks to every posi-
tion in the window, clearing the screen.
- The clear and wclear routines are like erase and werase,
- but they also call clearok, so that the screen is cleared
- completely on the next call to wrefresh for that window
+ The clear and wclear routines are like erase and werase,
+ but they also call clearok, so that the screen is cleared
+ completely on the next call to wrefresh for that window
and repainted from scratch.
- The clrtobot and wclrtobot routines erase from the cursor
+ The clrtobot and wclrtobot 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
+ the cursor in the window. Also, the current line to the
right of the cursor, inclusive, is erased.
The clrtoeol and wclrtoeol routines erase the current line
- to the right of the cursor, inclusive, to the end of the
+ to the right of the cursor, inclusive, to the end of the
current line.
Blanks created by erasure have the current background ren-
@@ -90,9 +90,13 @@
RETURN VALUE
- All routines return the integer OK. The SVr4.0 manual
- says "or a non-negative integer if immedok is set", but
- this appears to be an error.
+ All routines return the integer OK on success and ERR on
+ failure. The SVr4.0 manual says "or a non-negative inte-
+ ger if immedok is set", but this appears to be an error.
+
+ X/Open defines no error conditions. In this implementa-
+ tion, functions using a window pointer parameter return an
+ error if it is null.
@@ -103,15 +107,26 @@
PORTABILITY
- These functions are described in the XSI Curses standard,
- Issue 4. The standard specifies that they return ERR on
+ These functions are described in the XSI Curses standard,
+ Issue 4. The standard specifies that they return ERR on
failure, but specifies no error conditions.
- Some historic curses implementations had, as an undocu-
- mented feature, the ability to do the equivalent of
- clearok(..., 1) by saying touchwin(stdscr) or clear(std-
+ Some historic curses implementations had, as an undocu-
+ mented feature, the ability to do the equivalent of
+ clearok(..., 1) by saying touchwin(stdscr) or clear(std-
scr). This will not work under ncurses.
+ This implementation, and others such as Solaris, sets the
+ current position to 0,0 after erasing via werase() and
+ wclear(). That fact is not documented in other implemen-
+ tations, and may not be true of implementations which were
+ not derived from SVr4 source.
+
+ Not obvious from the description, most implementations
+ clear the screen after wclear even for a subwindow or de-
+ rived window. If you do not want to clear the screen dur-
+ ing the next wrefresh, use werase instead.
+
SEE ALSO
@@ -119,7 +134,7 @@
- curs_clear(3x)
+ curs_clear(3x)