Seth Woolley's Man Viewer

clrtobot(3x) - clear, clrtobot, clrtoeol, erase, wclear, wclrtobot, wclrtoeol, werase - clear all or part of a curses window - man 3x clrtobot

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

curs_clear(3X)                                                  curs_clear(3X)



NAME
       erase,  werase, clear(1,3x,3x clrtobot), wclear, clrtobot, wclrtobot, clrtoeol, wclrtoeol
       - clear(1,3x,3x clrtobot) all or part of a curses window

SYNOPSIS
       # include <curses.h>

       int erase(void);
       int werase(WINDOW *win);
       int clear(1,3x,3x clrtobot)(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 position in(1,8) the win-
       dow, clearing the screen.

       The  clear(1,3x,3x clrtobot) 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 to the end of
       screen.  That is, they erase all lines below the cursor in(1,8) 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(7,n,1 builtins)
       by wbkgdset) merged into them.

RETURN VALUE
       All routines return the integer OK.  The SVr4.0 manual says "or a  non-
       negative integer if(3,n) immedok is set(7,n,1 builtins)", but this appears to be an error.

NOTES
       Note  that  erase, werase, clear(1,3x,3x clrtobot), wclear, clrtobot, and clrtoeol may be
       macros.

PORTABILITY
       These functions are described in(1,8) the XSI Curses standard, Issue 4.  The
       standard  specifies  that  they return ERR on failure, but specifies no
       error(8,n) conditions.

       Some historic curses implementations had, as an  undocumented(2,3)  feature,
       the  ability  to  do the equivalent of clearok(..., 1) by saying touch-
       win(stdscr) or clear(1,3x,3x clrtobot)(stdscr).  This will not work under ncurses.

SEE ALSO
       curses(3X), curs_outopts(3X), curs_refresh(3X)



                                                                curs_clear(3X)

References for this manual (incoming links)