X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_clear.3x.html;h=ca581c2b0b142793b6592f22a8340cfee74aecf7;hb=e0881a7f395769f2ec89b8fa8c21c4292c1de7b5;hp=bb5ff2269a333c34bc45658bc432c36460070791;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01;p=ncurses.git
diff --git a/doc/html/man/curs_clear.3x.html b/doc/html/man/curs_clear.3x.html
index bb5ff226..ca581c2b 100644
--- a/doc/html/man/curs_clear.3x.html
+++ b/doc/html/man/curs_clear.3x.html
@@ -1,7 +1,7 @@
@@ -40,11 +40,15 @@
+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
@@ -86,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.
@@ -105,63 +113,29 @@
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(stdscr). This will not work under ncurses.
-
-
-
-SEE ALSO
- curses(3x), curs_outopts(3x), curs_refresh(3x)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+ 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
+ curses(3x), curs_outopts(3x), curs_refresh(3x), curs_vari-
+ ables(3x)
+ curs_clear(3x)