X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_clear.3x.html;h=e63e5583c35f6ac46972ca7a66e84040b5bb70f7;hb=bd2d9c5734d2c66abe0b2ddd766695b200c154fe;hp=82491d365b85de309023edf2550eb1a3b0e98d2a;hpb=9f479192e3ca3413d235c66bf058f8cc63764898;p=ncurses.git diff --git a/doc/html/man/curs_clear.3x.html b/doc/html/man/curs_clear.3x.html index 82491d36..e63e5583 100644 --- a/doc/html/man/curs_clear.3x.html +++ b/doc/html/man/curs_clear.3x.html @@ -1,6 +1,6 @@ -curs_clear 3X +curs_clear 3x 2024-01-05 ncurses 6.4 Library calls - + -

curs_clear 3X

curs_clear 3x 2024-01-05 ncurses 6.4 Library calls

-curs_clear(3X)                                                  curs_clear(3X)
+curs_clear(3x)                   Library calls                  curs_clear(3x)

NAME

-       erase, werase, clear, wclear, clrtobot, wclrtobot, clrtoeol, 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 erase(void);
+       int werase(WINDOW *win);
 
-       int clear(void);
-       int wclear(WINDOW *win);
+       int clear(void);
+       int wclear(WINDOW *win);
 
-       int clrtobot(void);
-       int wclrtobot(WINDOW *win);
+       int clrtobot(void);
+       int wclrtobot(WINDOW *win);
 
-       int clrtoeol(void);
-       int wclrtoeol(WINDOW *win);
+       int clrtoeol(void);
+       int wclrtoeol(WINDOW *win);

DESCRIPTION

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

erase, werase

+       The erase and werase routines copy blanks  to  every  position  in  the
+       window, clearing the screen.
+
+       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.
+
 
-       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
+

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

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.

RETURN VALUE

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

NOTES

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

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.
+       These functions are described in the XSI Curses standard, Issue 4.
 
-       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
+       The SVr4.0 manual says that these functions could  return  "or  a  non-
+       negative  integer  if immedok 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.
+       the  ability  to  do  the  equivalent  of  clearok(...,  1)  by  saying
+       touchwin(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-
-       tions which were not derived from SVr4 source.
+       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   implementations,  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 derived window.  If you do not
-       want to clear the screen during the next wrefresh, use werase instead.
+       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.