8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man3curses / curs_clear.3curses
blob7f76131ad75ed0077a852435f1e7bbeee5f22f5a
1 '\" te
2 .\" Copyright 1989 AT&T
3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7 .TH CURS_CLEAR 3CURSES "Dec 31, 1996"
8 .SH NAME
9 curs_clear, erase, werase, clear, wclear, clrtobot, wclrtobot, clrtoeol,
10 wclrtoeol \- clear all or part of a curses window
11 .SH SYNOPSIS
12 .LP
13 .nf
14 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR ... \fB-lcurses\fR [ \fIlibrary\fR ... ]
15 #include <curses.h>
17 \fBint\fR \fBerase\fR(\fBvoid\fR);
18 .fi
20 .LP
21 .nf
22 \fBint\fR \fBwerase\fR(\fBWINDOW *\fR\fIwin\fR);
23 .fi
25 .LP
26 .nf
27 \fBint\fR \fBclear\fR(\fBvoid\fR);
28 .fi
30 .LP
31 .nf
32 \fBint\fR \fBwclear\fR(\fBWINDOW *\fR\fIwin\fR);
33 .fi
35 .LP
36 .nf
37 \fBint\fR \fBclrtobot\fR(\fBvoid\fR);
38 .fi
40 .LP
41 .nf
42 \fBint\fR \fBwclrtobot\fR(\fBWINDOW *\fR\fIwin\fR);
43 .fi
45 .LP
46 .nf
47 \fBint\fR \fBclrtoeol\fR(\fBvoid\fR);
48 .fi
50 .LP
51 .nf
52 \fBint\fR \fBwclrtoeol\fR(\fBWINDOW *\fR\fIwin\fR);
53 .fi
55 .SH DESCRIPTION
56 .sp
57 .LP
58 The \fBerase()\fR and \fBwerase()\fR routines copy blanks to every position in
59 the window.
60 .sp
61 .LP
62 The \fBclear()\fR and \fBwclear()\fR routines are like \fBerase()\fR and
63 \fBwerase()\fR, but they also call \fBclearok()\fR \fB,\fR so that the screen
64 is cleared completely on the next call to \fBwrefresh()\fR for that window and
65 repainted from scratch.
66 .sp
67 .LP
68 The \fBclrtobot()\fR and \fBwclrtobot()\fR routines erase all lines below the
69 cursor in the window. Also, the current line to the right of the cursor,
70 inclusive, is erased.
71 .sp
72 .LP
73 The \fBclrtoeol()\fR and \fBwclrtoeol()\fR routines erase the current line to
74 the right of the cursor, inclusive.
75 .SH RETURN VALUES
76 .sp
77 .LP
78 All routines return the integer \fBOK\fR, or a non-negative integer if
79 \fBimmedok()\fR is set. See \fBcurs_outopts\fR(3CURSES).
80 .SH ATTRIBUTES
81 .sp
82 .LP
83 See \fBattributes\fR(5) for descriptions of the following attributes:
84 .sp
86 .sp
87 .TS
88 box;
89 c | c
90 l | l .
91 ATTRIBUTE TYPE  ATTRIBUTE VALUE
93 MT-Level        Unsafe
94 .TE
96 .SH SEE ALSO
97 .sp
98 .LP
99 \fBcurs_outopts\fR(3CURSES), \fBcurs_refresh\fR(3CURSES),
100 \fBcurses\fR(3CURSES), \fBattributes\fR(5)
101 .SH NOTES
104 The header <\fBcurses.h\fR> automatically includes the headers  <\fBstdio.h\fR>
105 and <\fBunctrl.h\fR>.
108 Note that \fBerase()\fR, \fBwerase()\fR, \fBclear()\fR, \fBwclear()\fR,
109 \fBclrtobot()\fR, and \fBclrtoeol()\fR may be macros.