diff options
Diffstat (limited to 'doc/html/man/curs_clear.3x.html')
| -rw-r--r-- | doc/html/man/curs_clear.3x.html | 134 |
1 files changed, 63 insertions, 71 deletions
diff --git a/doc/html/man/curs_clear.3x.html b/doc/html/man/curs_clear.3x.html index 39f9ad929d9e..c760c1f03875 100644 --- a/doc/html/man/curs_clear.3x.html +++ b/doc/html/man/curs_clear.3x.html @@ -1,7 +1,6 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1998-2007,2010 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 * @@ -27,32 +26,31 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_clear.3x,v 1.14 2010/12/04 18:36:44 tom Exp @ + * @Id: curs_clear.3x,v 1.16 2018/07/28 21:34:06 tom Exp @ --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <HTML> <HEAD> +<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> +<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> <TITLE>curs_clear 3x</TITLE> -<link rev=made href="mailto:bug-ncurses@gnu.org"> +<link rel="author" href="mailto:bug-ncurses@gnu.org"> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> </HEAD> <BODY> -<H1>curs_clear 3x</H1> -<HR> +<H1 class="no-header">curs_clear 3x</H1> <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>clrtoeol</STRONG>, <STRONG>wclrtoeol</STRONG> - clear all or part of a <STRONG>curses</STRONG> window +</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> + <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> -<H2>SYNOPSIS</H2><PRE> +</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> <STRONG>#</STRONG> <STRONG>include</STRONG> <STRONG><curses.h></STRONG> <STRONG>int</STRONG> <STRONG>erase(void);</STRONG> @@ -65,82 +63,76 @@ <STRONG>int</STRONG> <STRONG>wclrtoeol(WINDOW</STRONG> <STRONG>*win);</STRONG> -</PRE> -<H2>DESCRIPTION</H2><PRE> - The <STRONG>erase</STRONG> and <STRONG>werase</STRONG> routines copy blanks to every posi- - tion in the window, clearing the screen. +</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> + The <STRONG>erase</STRONG> and <STRONG>werase</STRONG> routines copy blanks to every position in the win- + dow, clearing the screen. - The <STRONG>clear</STRONG> and <STRONG>wclear</STRONG> routines are like <STRONG>erase</STRONG> and <STRONG>werase</STRONG>, - but they also call <STRONG>clearok</STRONG>, so that the screen is cleared - completely on the next call to <STRONG>wrefresh</STRONG> for that window - and repainted from scratch. + The <STRONG>clear</STRONG> and <STRONG>wclear</STRONG> routines are like <STRONG>erase</STRONG> and <STRONG>werase</STRONG>, but they also + call <STRONG>clearok</STRONG>, so that the screen is cleared completely on the next call + to <STRONG>wrefresh</STRONG> for that window and repainted from scratch. - The <STRONG>clrtobot</STRONG> and <STRONG>wclrtobot</STRONG> 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 <STRONG>clrtobot</STRONG> and <STRONG>wclrtobot</STRONG> 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 <STRONG>clrtoeol</STRONG> and <STRONG>wclrtoeol</STRONG> routines erase the current line - to the right of the cursor, inclusive, to the end of the - current line. + The <STRONG>clrtoeol</STRONG> and <STRONG>wclrtoeol</STRONG> 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 ren- - dition (as set by <STRONG>wbkgdset</STRONG>) merged into them. + Blanks created by erasure have the current background rendition (as set + by <STRONG>wbkgdset</STRONG>) merged into them. -</PRE> -<H2>RETURN VALUE</H2><PRE> - 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. +</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> + 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 integer 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. + X/Open defines no error conditions. In this implementation, functions + using a window pointer parameter return an error if it is null. -</PRE> -<H2>NOTES</H2><PRE> - Note that <STRONG>erase</STRONG>, <STRONG>werase</STRONG>, <STRONG>clear</STRONG>, <STRONG>wclear</STRONG>, <STRONG>clrtobot</STRONG>, and <STRONG>clr-</STRONG> - <STRONG>toeol</STRONG> may be macros. +</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> + Note that <STRONG>erase</STRONG>, <STRONG>werase</STRONG>, <STRONG>clear</STRONG>, <STRONG>wclear</STRONG>, <STRONG>clrtobot</STRONG>, and <STRONG>clrtoeol</STRONG> may be + macros. -</PRE> -<H2>PORTABILITY</H2><PRE> - These functions are described in the XSI Curses standard, - Issue 4. The standard specifies that they return <STRONG>ERR</STRONG> on - failure, but specifies no error conditions. +</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> + These functions are described in the XSI Curses standard, Issue 4. The + standard specifies that they return <STRONG>ERR</STRONG> on failure, but specifies no + error conditions. - Some historic curses implementations had, as an undocu- - mented feature, the ability to do the equivalent of - <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. + Some historic curses implementations had, as an undocumented feature, + the ability to do the equivalent of <STRONG>clearok(...,</STRONG> <STRONG>1)</STRONG> by saying <STRONG>touch-</STRONG> + <STRONG>win(stdscr)</STRONG> or <STRONG>clear(stdscr)</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. + This implementation, and others such as Solaris, sets the current posi- + tion to 0,0 after erasing via <STRONG>werase</STRONG> and <STRONG>wclear</STRONG>. That fact is not doc- + umented in other implementations, and may not be true of implementa- + tions 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. + Not obvious from the description, most implementations clear the screen + after <STRONG>wclear</STRONG> even for a subwindow or derived window. If you do not + want to clear the screen during the next <STRONG>wrefresh</STRONG>, use <STRONG>werase</STRONG> instead. -</PRE> -<H2>SEE ALSO</H2><PRE> - <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG>curs_vari-</STRONG> - <STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG> +</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(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> -<HR> -<ADDRESS> -Man(1) output converted with -<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> -</ADDRESS> +<div class="nav"> +<ul> +<li><a href="#h2-NAME">NAME</a></li> +<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> +<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> +<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> +<li><a href="#h2-NOTES">NOTES</a></li> +<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> +<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> +</ul> +</div> </BODY> </HTML> |