X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_clear.3x.html;h=e70f7757289e1f41401c40a69d2ba1d52e014474;hp=1a874f2e8e430ad0901647f9aa757d05cea6cb73;hb=55ccd2b959766810cf7db8d1c4462f338ce0afc8;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/curs_clear.3x.html b/doc/html/man/curs_clear.3x.html index 1a874f2e..e70f7757 100644 --- a/doc/html/man/curs_clear.3x.html +++ b/doc/html/man/curs_clear.3x.html @@ -1,129 +1,135 @@ + + + +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

SYNOPSIS

-       # include <curses.h>
+       # include <curses.h>
 
-       int erase(void);
-       int werase(WINDOW *win);
-       int clear(void);
-       int wclear(WINDOW *win);
-       int clrtobot(void);
-       int wclrtobot(WINDOW *win);
-       int clrtoeol(void);
-       int wclrtoeol(WINDOW *win);
+       int erase(void);
+       int werase(WINDOW *win);
+       int clear(void);
+       int wclear(WINDOW *win);
+       int clrtobot(void);
+       int wclrtobot(WINDOW *win);
+       int clrtoeol(void);
+       int wclrtoeol(WINDOW *win);

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
+       The clrtoeol and wclrtoeol routines erase the current line
+       to  the  right of the cursor, inclusive, to the end of the
        current line.
 
        Blanks created by erasure have the current background ren-
-       dition (as set by wbkgdset) merged into them.
+       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.
+       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

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

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(stdscr).  This will not work under ncurses.
+       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.