X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_clear.3x.html;h=237d4a27c4548cc3eeb512623b2c944f1a0b4e4d;hp=6838d5b99c3e882706005be51fa8b2aef0f05ba8;hb=c3b21f65a2687f3894a0d3217006c23f162c893a;hpb=a8987e73ec254703634802b4f7ee30d3a485524d;ds=sidebyside diff --git a/doc/html/man/curs_clear.3x.html b/doc/html/man/curs_clear.3x.html index 6838d5b9..237d4a27 100644 --- a/doc/html/man/curs_clear.3x.html +++ b/doc/html/man/curs_clear.3x.html @@ -1,7 +1,6 @@ - + + + curs_clear 3x -

curs_clear 3x

-
+

curs_clear 3x

-
-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
+

NAME

+       erase, werase, clear, wclear, clrtobot, wclrtobot,
+       clrtoeol, wclrtoeol - clear all or part of a curses window
 
 
-
-

SYNOPSIS

+

SYNOPSIS

        # include <curses.h>
 
        int erase(void);
@@ -65,8 +63,7 @@
        int wclrtoeol(WINDOW *win);
 
 
-
-

DESCRIPTION

+

DESCRIPTION

        The erase and werase routines copy blanks to  every  posi-
        tion in the window, clearing the screen.
 
@@ -88,21 +85,22 @@
        dition (as set by wbkgdset) merged into them.
 
 
-
-

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.
+

RETURN VALUE

+       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.
 
-
-

NOTES

+
+

NOTES

        Note that erase, werase, clear, wclear, clrtobot, and clr-
        toeol may be macros.
 
 
-
-

PORTABILITY

+

PORTABILITY

        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.
@@ -112,19 +110,36 @@
        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  implementa-
+       tions,  and  may not be true of implementations which were
+       not derived from SVr4 source.
 
-
-

SEE ALSO

-       curses(3x), curs_outopts(3x), curs_refresh(3x)
+       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)
+                                                         curs_clear(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +