X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_clear.3x;h=8668feb8225d7e068444e5425ffc14f9585c51e7;hp=fa7723af4fe8a00e8ca69a6805f33837ca04544e;hb=6b4f5830b7910188b532d661f79775306715f67e;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8 diff --git a/man/curs_clear.3x b/man/curs_clear.3x index fa7723af..8668feb8 100644 --- a/man/curs_clear.3x +++ b/man/curs_clear.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998,2005 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2016,2018 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -26,7 +26,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_clear.3x,v 1.10 2005/10/01 19:34:43 tom Exp $ +.\" $Id: curs_clear.3x,v 1.16 2018/07/28 21:34:06 tom Exp $ .TH curs_clear 3X "" .na .hy 0 @@ -38,7 +38,7 @@ \fBclrtobot\fR, \fBwclrtobot\fR, \fBclrtoeol\fR, -\fBwclrtoeol\fR - clear all or part of a \fBcurses\fR window +\fBwclrtoeol\fR \- clear all or part of a \fBcurses\fR window .ad .hy .SH SYNOPSIS @@ -70,7 +70,8 @@ cleared completely on the next call to \fBwrefresh\fR for that window and repainted from scratch. .PP The \fBclrtobot\fR and \fBwclrtobot\fR routines erase from the cursor to the -end of screen. That is, they erase all lines below the cursor in the window. +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. .PP The \fBclrtoeol\fR and \fBwclrtoeol\fR routines erase the current line @@ -90,26 +91,31 @@ functions using a window pointer parameter return an error if it is null. Note that \fBerase\fR, \fBwerase\fR, \fBclear\fR, \fBwclear\fR, \fBclrtobot\fR, and \fBclrtoeol\fR may be macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. The +These functions are described in the XSI Curses standard, Issue 4. +The standard specifies that they return \fBERR\fR on failure, but specifies no error conditions. .PP Some historic curses implementations had, as an undocumented feature, the ability to do the equivalent of \fBclearok(..., 1)\fR by saying -\fBtouchwin(stdscr)\fR or \fBclear(stdscr)\fR. This will not work under +\fBtouchwin(stdscr)\fR or \fBclear(stdscr)\fR. +This will not work under ncurses. .PP This implementation, and others such as Solaris, sets the current position to 0,0 after erasing -via \fBwerase()\fP and \fBwclear()\fP. +via \fBwerase\fP and \fBwclear\fP. That fact is not documented in other implementations, and may not be true of implementations which were not derived from SVr4 source. +.PP +Not obvious from the description, +most implementations clear the screen after \fBwclear\fP +even for a subwindow or derived window. +If you do not want to clear the screen during the next \fBwrefresh\fP, +use \fBwerase\fP instead. .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_outopts\fR(3X), \fBcurs_refresh\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurses\fR(3X), +\fBcurs_outopts\fR(3X), +\fBcurs_refresh\fR(3X), +\fBcurs_variables\fR(3X)