X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fclear.1;h=9748fdd5a3aa29bc8b7092a84267a5abcc23245e;hb=88595a127ec2e56af0875eb04e0f2396d6d121c5;hp=3d2ffd98617b9e8c526da62a20d77384979600be;hpb=0485620c03e69b1b58a6b12e5e45c98415fc7575;p=ncurses.git diff --git a/man/clear.1 b/man/clear.1 index 3d2ffd98..9748fdd5 100644 --- a/man/clear.1 +++ b/man/clear.1 @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2016,2017 Free Software Foundation, Inc. * +.\" Copyright 2018-2022,2023 Thomas E. Dickey * +.\" Copyright 1998-2016,2017 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 * @@ -26,14 +27,14 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: clear.1,v 1.17 2017/08/19 14:12:50 tom Exp $ +.\" $Id: clear.1,v 1.29 2023/04/09 08:28:00 tom Exp $ .TH @CLEAR@ 1 "" .\" these would be fallbacks for DS/DE, .\" but groff changed the meaning of the macros. .de NS -.ie \n(.sp +.ie n .sp .el .sp .5 -.ie \n(.in +4 +.ie n .in +4 .el .in +2 .nf .ft C \" Courier @@ -41,41 +42,46 @@ .de NE .fi .ft R -.in -4 +.ie n .in -4 +.el .in -2 .. .ie \n(.g .ds `` \(lq .el .ds `` `` .ie \n(.g .ds '' \(rq .el .ds '' '' .de bP -.IP \(bu 4 +.ie n .IP \(bu 4 +.el .IP \(bu 2 .. .ds n 5 .SH NAME -\fB@CLEAR@\fR \- clear the terminal screen +\fB@CLEAR@\fP \- clear the terminal screen .SH SYNOPSIS -\fB@CLEAR@\fR [\fB\-T\fR\fItype\fR] [\fB\-V\fP] [\fB\-x\fP] +\fB@CLEAR@\fR [\fB\-T\fItype\fR] [\fB\-V\fR] [\fB\-x\fR] .br .SH DESCRIPTION -\fB@CLEAR@\fR clears your screen if this is possible, -including its scrollback buffer (if the extended \*(``E3\*('' capability is defined). -\fB@CLEAR@\fR looks in the environment for the terminal type +\fB@CLEAR@\fP clears your terminal's screen if this is possible, +including the terminal's scrollback buffer +(if the extended \*(``E3\*('' capability is defined). +\fB@CLEAR@\fP looks in the environment for the terminal type given by the environment variable \fBTERM\fP, and then in the -\fBterminfo\fR database to determine how to clear the screen. +\fBterminfo\fP database to determine how to clear the screen. .PP -\fB@CLEAR@\fR writes to the standard output. +\fB@CLEAR@\fP writes to the standard output. You can redirect the standard output to a file (which prevents -\fB@CLEAR@\fR from actually clearing the screen), +\fB@CLEAR@\fP from actually clearing the screen), and later \fBcat\fP the file to the screen, clearing it at that point. .SH OPTIONS .PP .TP 5 .B \-T \fItype\fP -indicates the \fItype\fR of terminal. +indicates the \fItype\fP of terminal. Normally this option is unnecessary, because the default is taken from the environment -variable \fBTERM\fR. +variable \fBTERM\fP. +If \fB\-T\fP is specified, then the shell +variables \fBLINES\fP and \fBCOLUMNS\fP will also be ignored. .TP .B \-V reports the version of ncurses which was used in this program, and exits. @@ -111,7 +117,7 @@ BSD \fBclear\fP command (with terminfo, of course). .PP The \fBE3\fP extension came later: .bP -In June 1999, xterm provided an extension to the standard control +In June 1999, \fBxterm\fP provided an extension to the standard control sequence for clearing the screen. Rather than clearing just the visible part of the screen using .NS @@ -124,17 +130,18 @@ printf '\\033[\fB3\fPJ' .NE .IP This is documented in \fIXTerm Control Sequences\fP as a feature originating -with xterm. +with \fBxterm\fP. .bP A few other terminal developers adopted the feature, e.g., PuTTY in 2006. .bP In April 2011, a Red Hat developer submitted a patch to the Linux kernel, modifying its console driver to do the same thing. -The Linux change, part of the 3.0 release, did not mention xterm, +The Linux change, part of the 3.0 release, did not mention \fBxterm\fP, although it was cited in the Red Hat bug report (#683733) which led to the change. .bP -Again, a few other terminal developers adopted the feature. But the +Again, a few other terminal developers adopted the feature. +But the next relevant step was a change to the \fBclear\fP program in 2013 to incorporate this extension. .bP @@ -150,7 +157,9 @@ The latter documents \fBtput\fP, which could be used to replace this utility either via a shell script or by an alias (such as a symbolic link) to run \fB@TPUT@\fP as \fB@CLEAR@\fP. .SH SEE ALSO -\fB@TPUT@\fR(1), \fBterminfo\fR(\*n) +\fB@TPUT@\fP(1), +\fBxterm\fP(1), +\fBterminfo\fP(\*n). .PP -This describes \fBncurses\fR +This describes \fBncurses\fP version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).