ncurses 6.0 - patch 20170826
[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.17 2017/08/19 14:12:50 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 .IP \(bu 4
52 ..
53 .ds n 5
54 .SH NAME
55 \fB@CLEAR@\fR \- clear the terminal screen
56 .SH SYNOPSIS
57 \fB@CLEAR@\fR [\fB\-T\fR\fItype\fR] [\fB\-V\fP] [\fB\-x\fP]
58 .br
59 .SH DESCRIPTION
60 \fB@CLEAR@\fR clears your screen if this is possible,
61 including its scrollback buffer (if the extended \*(``E3\*('' capability is defined).
62 \fB@CLEAR@\fR looks in the environment for the terminal type
63 given by the environment variable \fBTERM\fP,
64 and then in the
65 \fBterminfo\fR database to determine how to clear the screen.
66 .PP
67 \fB@CLEAR@\fR writes to the standard output.
68 You can redirect the standard output to a file (which prevents
69 \fB@CLEAR@\fR from actually clearing the screen),
70 and later \fBcat\fP the file to the screen, clearing it at that point.
71 .SH OPTIONS
72 .PP
73 .TP 5
74 .B \-T \fItype\fP
75 indicates the \fItype\fR of terminal.
76 Normally this option is
77 unnecessary, because the default is taken from the environment
78 variable \fBTERM\fR.
79 .TP
80 .B \-V
81 reports the version of ncurses which was used in this program, and exits.
82 The options are as follows:
83 .TP
84 .B \-x
85 do not attempt to clear the terminal's scrollback buffer
86 using the extended \*(``E3\*('' capability.
87 .SH HISTORY
88 A \fBclear\fP command appeared in 2.79BSD dated February 24, 1979.
89 Later that was provided in Unix 8th edition (1985).
90 .PP
91 AT&T adapted a different BSD program (\fBtset\fP) to make
92 a new command (\fBtput\fP),
93 and used this to replace the \fBclear\fP command with a shell script
94 which calls \fBtput clear\fP, e.g.,
95 .NS
96 /usr/bin/tput ${1:+-T$1} clear 2> /dev/null
97 exit
98 .NE
99 .PP
100 In 1989, when Keith Bostic revised the BSD \fBtput\fP command
101 to make it similar to the AT&T \fBtput\fP,
102 he added a shell script for the \fBclear\fP command:
103 .NS
104 exec tput clear
105 .NE
106 .PP
107 The remainder of the script in each case is a copyright notice.
108 .PP
109 The ncurses \fBclear\fP command began in 1995 by adapting the original
110 BSD \fBclear\fP command (with terminfo, of course).
111 .PP
112 The \fBE3\fP extension came later:
113 .bP
114 In June 1999, xterm provided an extension to the standard control
115 sequence for clearing the screen.
116 Rather than clearing just the visible part of the screen using
117 .NS
118 printf '\\033[2J'
119 .NE
120 .IP
121 one could clear the \fIscrollback\fP using
122 .NS
123 printf '\\033[\fB3\fPJ'
124 .NE
125 .IP
126 This is documented in \fIXTerm Control Sequences\fP as a feature originating
127 with xterm.
128 .bP
129 A few other terminal developers adopted the feature, e.g., PuTTY in 2006.
130 .bP
131 In April 2011, a Red Hat developer submitted a patch to the Linux
132 kernel, modifying its console driver to do the same thing.
133 The Linux change, part of the 3.0 release, did not mention xterm,
134 although it was cited in the Red Hat bug report (#683733)
135 which led to the change.
136 .bP
137 Again, a few other terminal developers adopted the feature.  But the
138 next relevant step was a change to the \fBclear\fP program in 2013
139 to incorporate this extension.
140 .bP
141 In 2013, the \fBE3\fP extension was overlooked in \fB@TPUT@\fP with
142 the \*(``clear\*('' parameter.
143 That was addressed in 2016 by reorganizing \fB@TPUT@\fP to share
144 its logic with \fB@CLEAR@\fP and \fB@TSET@\fP.
145 .SH PORTABILITY
146 Neither IEEE Std 1003.1/The Open  Group  Base  Specifications  Issue  7
147 (POSIX.1-2008) nor X/Open Curses Issue 7 documents @TSET@ or @RESET@.
148 .PP
149 The latter documents \fBtput\fP, which could be used to replace this utility
150 either via a shell script or by an alias (such as a symbolic link) to
151 run \fB@TPUT@\fP as \fB@CLEAR@\fP.
152 .SH SEE ALSO
153 \fB@TPUT@\fR(1), \fBterminfo\fR(\*n)
154 .PP
155 This describes \fBncurses\fR
156 version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).