X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_clear.3x.html;h=a6e944107774bd487d039104273707d5edde13ff;hp=e8516cd52a18d5dcaa630bdaac63d4788fb3a483;hb=81304798ee736c467839c779c9ca5dca48db7bea;hpb=bca50d0d8592defee6c584fdedd25f4b1a31345b diff --git a/doc/html/man/curs_clear.3x.html b/doc/html/man/curs_clear.3x.html index e8516cd5..a6e94410 100644 --- a/doc/html/man/curs_clear.3x.html +++ b/doc/html/man/curs_clear.3x.html @@ -1,6 +1,7 @@ - @@ -34,7 +35,7 @@ curs_clear 3x - + @@ -51,16 +52,19 @@

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

@@ -84,12 +88,14 @@

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,  functions
-       using a window pointer parameter return an error if it is null.
+       X/Open defines no error conditions.  In this implementation,
+
+       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 +108,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 is set", referring to the return-value of wre-
+       fresh.  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.