ncurses 5.7 - patch 20100731
[ncurses.git] / doc / html / man / curs_clear.3x.html
index 6838d5b99c3e882706005be51fa8b2aef0f05ba8..db11128f8f5a352f82ec1b87faad5956fe9d4280 100644 (file)
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
 <!-- 
   ****************************************************************************
-  * Copyright (c) 1998 Free Software Foundation, Inc.                        *
+  * Copyright (c) 1998-2007,2010 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            *
@@ -27,7 +27,7 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_clear.3x,v 1.7 1998/03/11 21:12:53 juergen Exp @
+  * @Id: curs_clear.3x,v 1.12 2010/07/31 16:12:01 tom Exp @
 -->
 <HTML>
 <HEAD>
 <HR>
 <PRE>
 <!-- Manpage converted by man2html 3.0.1 -->
-<STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>                                     <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>
+<STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>                                           <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>
 
 
 
 
 </PRE>
 <H2>NAME</H2><PRE>
-       <STRONG>erase</STRONG>,  <STRONG>werase</STRONG>,  <STRONG>clear</STRONG>,  <STRONG>wclear</STRONG>, <STRONG>clrtobot</STRONG>, <STRONG>wclrtobot</STRONG>, <STRONG>clr-</STRONG>
-       <STRONG>toeol</STRONG>, <STRONG>wclrtoeol</STRONG> - clear all or part of a <STRONG>curses</STRONG> window
+       <STRONG>erase</STRONG>, <STRONG>werase</STRONG>, <STRONG>clear</STRONG>, <STRONG>wclear</STRONG>, <STRONG>clrtobot</STRONG>, <STRONG>wclrtobot</STRONG>,
+       <STRONG>clrtoeol</STRONG>, <STRONG>wclrtoeol</STRONG> - clear all or part of a <STRONG>curses</STRONG> window
 
 
 </PRE>
 
 </PRE>
 <H2>RETURN VALUE</H2><PRE>
-       All routines return the integer  <STRONG>OK</STRONG>.   The  SVr4.0  manual
-       says  "or  a  non-negative integer if <STRONG>immedok</STRONG> is set", but
-       this appears to be an error.
+       All routines return the integer <STRONG>OK</STRONG> on success and  <STRONG>ERR</STRONG>  on
+       failure.   The SVr4.0 manual says "or a non-negative inte-
+       ger if <STRONG>immedok</STRONG> is set", but this appears to be an error.
+
+       X/Open defines no error conditions.  In  this  implementa-
+       tion, functions using a window pointer parameter return an
+       error if it is null.
 
 
 </PRE>
        <STRONG>clearok(...,</STRONG>  <STRONG>1)</STRONG>  by saying <STRONG>touchwin(stdscr)</STRONG> or <STRONG>clear(std-</STRONG>
        <STRONG>scr)</STRONG>.  This will not work under ncurses.
 
+       This implementation, and others such as Solaris, sets  the
+       current  position  to  0,0  after erasing via <STRONG>werase()</STRONG> and
+       <STRONG>wclear()</STRONG>.  That fact is not documented in other  implemen-
+       tations, 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 <STRONG>wclear</STRONG> even for a subwindow or de-
+       rived window.  If you do not want to clear the screen dur-
+       ing the next <STRONG>wrefresh</STRONG>, use <STRONG>werase</STRONG> instead.
+
 
 </PRE>
 <H2>SEE ALSO</H2><PRE>
 
 
 
-                                                   <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>
+                                                         <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>
 </PRE>
 <HR>
 <ADDRESS>