ncurses 6.0 - patch 20171118
[ncurses.git] / man / clear.1
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2016,2017 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: clear.1,v 1.19 2017/11/18 23:51:59 tom Exp $
30 .TH @CLEAR@ 1 ""
31 .\" these would be fallbacks for DS/DE,
32 .\" but groff changed the meaning of the macros.
33 .de NS
34 .ie n  .sp
35 .el    .sp .5
36 .ie n  .in +4
37 .el    .in +2
38 .nf
39 .ft C                   \" Courier
40 ..
41 .de NE
42 .fi
43 .ft R
44 .in -4
45 ..
46 .ie \n(.g .ds `` \(lq
47 .el       .ds `` ``
48 .ie \n(.g .ds '' \(rq
49 .el       .ds '' ''
50 .de bP
51 .ie n  .IP \(bu 4
52 .el    .IP \(bu 2
53 ..
54 .ds n 5
55 .SH NAME
56 \fB@CLEAR@\fR \- clear the terminal screen
57 .SH SYNOPSIS
58 \fB@CLEAR@\fR [\fB\-T\fR\fItype\fR] [\fB\-V\fP] [\fB\-x\fP]
59 .br
60 .SH DESCRIPTION
61 \fB@CLEAR@\fR clears your screen if this is possible,
62 including its scrollback buffer (if the extended \*(``E3\*('' capability is defined).
63 \fB@CLEAR@\fR looks in the environment for the terminal type
64 given by the environment variable \fBTERM\fP,
65 and then in the
66 \fBterminfo\fR database to determine how to clear the screen.
67 .PP
68 \fB@CLEAR@\fR writes to the standard output.
69 You can redirect the standard output to a file (which prevents
70 \fB@CLEAR@\fR from actually clearing the screen),
71 and later \fBcat\fP the file to the screen, clearing it at that point.
72 .SH OPTIONS
73 .PP
74 .TP 5
75 .B \-T \fItype\fP
76 indicates the \fItype\fR of terminal.
77 Normally this option is
78 unnecessary, because the default is taken from the environment
79 variable \fBTERM\fR.
80 If \fB\-T\fR is specified, then the shell
81 variables \fBLINES\fR and \fBCOLUMNS\fR will also be ignored.
82 .TP
83 .B \-V
84 reports the version of ncurses which was used in this program, and exits.
85 The options are as follows:
86 .TP
87 .B \-x
88 do not attempt to clear the terminal's scrollback buffer
89 using the extended \*(``E3\*('' capability.
90 .SH HISTORY
91 A \fBclear\fP command appeared in 2.79BSD dated February 24, 1979.
92 Later that was provided in Unix 8th edition (1985).
93 .PP
94 AT&T adapted a different BSD program (\fBtset\fP) to make
95 a new command (\fBtput\fP),
96 and used this to replace the \fBclear\fP command with a shell script
97 which calls \fBtput clear\fP, e.g.,
98 .NS
99 /usr/bin/tput ${1:+-T$1} clear 2> /dev/null
100 exit
101 .NE
102 .PP
103 In 1989, when Keith Bostic revised the BSD \fBtput\fP command
104 to make it similar to the AT&T \fBtput\fP,
105 he added a shell script for the \fBclear\fP command:
106 .NS
107 exec tput clear
108 .NE
109 .PP
110 The remainder of the script in each case is a copyright notice.
111 .PP
112 The ncurses \fBclear\fP command began in 1995 by adapting the original
113 BSD \fBclear\fP command (with terminfo, of course).
114 .PP
115 The \fBE3\fP extension came later:
116 .bP
117 In June 1999, xterm provided an extension to the standard control
118 sequence for clearing the screen.
119 Rather than clearing just the visible part of the screen using
120 .NS
121 printf '\\033[2J'
122 .NE
123 .IP
124 one could clear the \fIscrollback\fP using
125 .NS
126 printf '\\033[\fB3\fPJ'
127 .NE
128 .IP
129 This is documented in \fIXTerm Control Sequences\fP as a feature originating
130 with xterm.
131 .bP
132 A few other terminal developers adopted the feature, e.g., PuTTY in 2006.
133 .bP
134 In April 2011, a Red Hat developer submitted a patch to the Linux
135 kernel, modifying its console driver to do the same thing.
136 The Linux change, part of the 3.0 release, did not mention xterm,
137 although it was cited in the Red Hat bug report (#683733)
138 which led to the change.
139 .bP
140 Again, a few other terminal developers adopted the feature.  But the
141 next relevant step was a change to the \fBclear\fP program in 2013
142 to incorporate this extension.
143 .bP
144 In 2013, the \fBE3\fP extension was overlooked in \fB@TPUT@\fP with
145 the \*(``clear\*('' parameter.
146 That was addressed in 2016 by reorganizing \fB@TPUT@\fP to share
147 its logic with \fB@CLEAR@\fP and \fB@TSET@\fP.
148 .SH PORTABILITY
149 Neither IEEE Std 1003.1/The Open  Group  Base  Specifications  Issue  7
150 (POSIX.1-2008) nor X/Open Curses Issue 7 documents @TSET@ or @RESET@.
151 .PP
152 The latter documents \fBtput\fP, which could be used to replace this utility
153 either via a shell script or by an alias (such as a symbolic link) to
154 run \fB@TPUT@\fP as \fB@CLEAR@\fP.
155 .SH SEE ALSO
156 \fB@TPUT@\fR(1), \fBterminfo\fR(\*n)
157 .PP
158 This describes \fBncurses\fR
159 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).