diff options
| author | Lorry Tar Creator <lorry-tar-importer@lorry> | 2020-02-12 02:21:21 +0000 |
|---|---|---|
| committer | Lorry Tar Creator <lorry-tar-importer@lorry> | 2020-02-12 02:21:21 +0000 |
| commit | ff448436b2b70771d09b8d5ff34a509dcf02f81b (patch) | |
| tree | 2f7abbba7198a4e1c4a23955bc3a539db5a7d999 /man/curs_clear.3x | |
| parent | f6d73a10a980bc78969c3af93665cbe7d06c3646 (diff) | |
| download | ncurses-ff448436b2b70771d09b8d5ff34a509dcf02f81b.tar.gz | |
ncurses-6.2ncurses-6.2
Diffstat (limited to 'man/curs_clear.3x')
| -rw-r--r-- | man/curs_clear.3x | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/man/curs_clear.3x b/man/curs_clear.3x index 305c608..2cce06e 100644 --- a/man/curs_clear.3x +++ b/man/curs_clear.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * +.\" Copyright 2018,2020 Thomas E. Dickey * +.\" Copyright 1998-2010,2016 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 +27,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_clear.3x,v 1.14 2010/12/04 18:36:44 tom Exp $ +.\" $Id: curs_clear.3x,v 1.17 2020/02/02 23:34:34 tom Exp $ .TH curs_clear 3X "" .na .hy 0 @@ -70,7 +71,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,18 +92,20 @@ 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. |