X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_clear.3x.html;h=5162d2784c67889fbc79e8190360dffedf340bad;hb=c11444e368f1d5964bd0f81e6e3b0f8c8ccd09cc;hp=e8516cd52a18d5dcaa630bdaac63d4788fb3a483;hpb=bca50d0d8592defee6c584fdedd25f4b1a31345b;p=ncurses.git diff --git a/doc/html/man/curs_clear.3x.html b/doc/html/man/curs_clear.3x.html index e8516cd5..5162d278 100644 --- a/doc/html/man/curs_clear.3x.html +++ b/doc/html/man/curs_clear.3x.html @@ -1,6 +1,7 @@ - @@ -34,8 +35,8 @@ curs_clear 3x - - + +

curs_clear 3x

@@ -51,45 +52,58 @@

SYNOPSIS

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

DESCRIPTION

+
+

erase/werase

        The erase and werase routines copy blanks to every position in the win-
        dow, 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 and repainted from scratch.
+       Blanks created by erasure have the current background rendition (as set
+       by wbkgdset(3x)) merged into them.
+
+
+

clear/wclear

+       The clear and wclear routines are like erase and werase, but they  also
+       call  clearok(3x), so that the screen is cleared completely on the next
+       call to wrefresh for that window and repainted from scratch.
+
 
+

clrtobot/wclrtobot

        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  right  of the cursor, inclusive, is
+       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.
 
+
+

clrtoeol/wclrtoeol

        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 rendition (as set
-       by wbkgdset) merged into them.
-

RETURN VALUE

-       All routines return the integer OK on success and ERR on failure.   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.
+
+       X/Open defines no error conditions.  In this implementation,
 
-       X/Open defines no error conditions.  In this implementation,  functions
-       using a window pointer parameter return an error if it is null.
+       o   functions using a window pointer parameter return an error if it is
+           null
+
+       o   wclrtoeol returns an error if the cursor position is about to wrap.

NOTES

@@ -102,17 +116,22 @@
        standard  specifies  that  they return ERR on failure, but specifies no
        error conditions.
 
-       Some historic curses implementations had, as an  undocumented  feature,
-       the  ability  to  do the equivalent of clearok(..., 1) by saying touch-
+       The SVr4.0 manual says that these functions could return  "a  non-nega-
+       tive  integer  if immedok(3x) is set", referring to the return-value of
+       wrefresh.  In that implementation, wrefresh would return a count of the
+       number of characters written to the terminal.
+
+       Some  historic  curses implementations had, as an undocumented feature,
+       the ability to do the equivalent of clearok(..., 1)  by  saying  touch-
        win(stdscr) or clear(stdscr).  This will not work under ncurses.
 
        This implementation, and others such as Solaris, sets the current posi-
        tion to 0,0 after erasing via werase and wclear.  That fact is not doc-
-       umented in other implementations, and may not be  true  of  implementa-
+       umented  in  other  implementations, and may not be true of implementa-
        tions which were not derived from SVr4 source.
 
        Not obvious from the description, most implementations clear the screen
-       after wclear even for a subwindow or derived window.   If  you  do  not
+       after  wclear  even  for  a subwindow or derived window.  If you do not
        want to clear the screen during the next wrefresh, use werase instead.
 
 
@@ -127,7 +146,14 @@