]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/clear.1.html
ncurses 6.3 - patch 20220813
[ncurses.git] / doc / html / man / clear.1.html
index 97d4596e74a3ac4c2ce69a6eda0fbc84ee17714e..8e13a37ce7d3a0f42553ae96ac4eeb9b83b163ad 100644 (file)
@@ -1,6 +1,7 @@
-<!-- 
+<!--
   ****************************************************************************
   ****************************************************************************
-  * Copyright (c) 1998-2013,2016 Free Software Foundation, Inc.              *
+  * Copyright 2018-2021,2022 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            *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
   * copy of this software and associated documentation files (the            *
@@ -26,7 +27,7 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: clear.1,v 1.16 2016/12/31 16:09:34 tom Exp @
+  * @Id: clear.1,v 1.27 2022/02/12 20:07:29 tom Exp @
   * these would be fallbacks for DS/DE,
   * but groff changed the meaning of the macros.
 -->
   * these would be fallbacks for DS/DE,
   * but groff changed the meaning of the macros.
 -->
 <HTML>
 <HEAD>
 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
 <HTML>
 <HEAD>
 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
-<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
 <TITLE>clear 1</TITLE>
 <TITLE>clear 1</TITLE>
-<link rev=made href="mailto:bug-ncurses@gnu.org">
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
+
 </HEAD>
 <BODY>
 <H1 class="no-header">clear 1</H1>
 <PRE>
 </HEAD>
 <BODY>
 <H1 class="no-header">clear 1</H1>
 <PRE>
-<STRONG><A HREF="clear.1.html">clear(1)</A></STRONG>                                                              <STRONG><A HREF="clear.1.html">clear(1)</A></STRONG>
+<STRONG><A HREF="clear.1.html">clear(1)</A></STRONG>                    General Commands Manual                   <STRONG><A HREF="clear.1.html">clear(1)</A></STRONG>
 
 
 
 
 
 
 
 
 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
-       <STRONG>clear</STRONG>
+       <STRONG>clear</STRONG> [<STRONG>-T</STRONG><EM>type</EM>] [<STRONG>-V</STRONG>] [<STRONG>-x</STRONG>]
 
 
 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
-       <STRONG>clear</STRONG>  clears your screen if this is possible, including its scrollback
-       buffer (if the extended "E3" capability is defined).   <STRONG>clear</STRONG>  looks  in
-       the environment for the terminal type given by the environment variable
-       <STRONG>TERM</STRONG>, and then in the <STRONG>terminfo</STRONG> database to determine how to  clear  the
-       screen.
+       <STRONG>clear</STRONG>  clears your terminal's screen if this is possible, including the
+       terminal's scrollback  buffer  (if  the  extended  "E3"  capability  is
+       defined).   <STRONG>clear</STRONG>  looks in the environment for the terminal type given
+       by the environment variable <STRONG>TERM</STRONG>, and then in the <STRONG>terminfo</STRONG> database  to
+       determine how to clear the screen.
 
        <STRONG>clear</STRONG>  writes  to  the  standard output.  You can redirect the standard
        output to a file (which  prevents  <STRONG>clear</STRONG>  from  actually  clearing  the
        screen),  and  later  <STRONG>cat</STRONG>  the  file to the screen, clearing it at that
        point.
 
 
        <STRONG>clear</STRONG>  writes  to  the  standard output.  You can redirect the standard
        output to a file (which  prevents  <STRONG>clear</STRONG>  from  actually  clearing  the
        screen),  and  later  <STRONG>cat</STRONG>  the  file to the screen, clearing it at that
        point.
 
-       <STRONG>clear</STRONG> ignores any command-line parameters that  may  be  present.   The
-       analogous  "<STRONG>tput</STRONG>  clear"  has  command-line parameters including <STRONG>-T</STRONG> for
-       overriding the <STRONG>TERM</STRONG> environment variable.
+
+</PRE><H2><a name="h2-OPTIONS">OPTIONS</a></H2><PRE>
+       <STRONG>-T</STRONG> <EM>type</EM>
+            indicates  the  <EM>type</EM>  of  terminal.   Normally  this   option   is
+            unnecessary,  because  the  default  is taken from the environment
+            variable <STRONG>TERM</STRONG>.  If <STRONG>-T</STRONG> is specified, then the shell variables <STRONG>LINES</STRONG>
+            and <STRONG>COLUMNS</STRONG> will also be ignored.
+
+       <STRONG>-V</STRONG>   reports the version of ncurses which was used in this program, and
+            exits.  The options are as follows:
+
+       <STRONG>-x</STRONG>   do not attempt to clear the terminal's scrollback buffer using the
+            extended "E3" capability.
 
 
 </PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
-       A <STRONG>clear</STRONG> command appeared in 2.79BSD dated  February  24,  1979.   Later
+       A  <STRONG>clear</STRONG>  command  appeared  in 2.79BSD dated February 24, 1979.  Later
        that was provided in Unix 8th edition (1985).
 
        that was provided in Unix 8th edition (1985).
 
-       AT&amp;T  adapted  a  different  BSD  program  (<STRONG>tset</STRONG>) to make a new command
-       (<STRONG>tput</STRONG>), and used this to replace the <STRONG>clear</STRONG> command with a shell  script
+       AT&amp;T adapted a different BSD program  (<STRONG>tset</STRONG>)  to  make  a  new  command
+       (<STRONG>tput</STRONG>),  and used this to replace the <STRONG>clear</STRONG> command with a shell script
        which calls <STRONG>tput</STRONG> <STRONG>clear</STRONG>, e.g.,
 
        which calls <STRONG>tput</STRONG> <STRONG>clear</STRONG>, e.g.,
 
-         /usr/bin/tput ${1:+-T$1} clear 2&gt; /dev/null
-         exit
+           /usr/bin/tput ${1:+-T$1} clear 2&gt; /dev/null
+           exit
 
 
-       In 1989, when Keith Bostic revised the BSD <STRONG>tput</STRONG> command to make it sim-
-       ilar to the AT&amp;T <STRONG>tput</STRONG>, he added a shell script for the <STRONG>clear</STRONG> command:
+       In 1989, when Keith Bostic revised the BSD  <STRONG>tput</STRONG>  command  to  make  it
+       similar  to  the  AT&amp;T  <STRONG>tput</STRONG>,  he  added  a  shell script for the <STRONG>clear</STRONG>
+       command:
 
 
-         exec tput clear
+           exec tput clear
 
        The remainder of the script in each case is a copyright notice.
 
 
        The remainder of the script in each case is a copyright notice.
 
 
        The <STRONG>E3</STRONG> extension came later:
 
 
        The <STRONG>E3</STRONG> extension came later:
 
-       <STRONG>o</STRONG>   In  June  1999, xterm provided an extension to the standard control
+       <STRONG>o</STRONG>   In  June  1999, <STRONG>xterm</STRONG> provided an extension to the standard control
            sequence for clearing the screen.  Rather than  clearing  just  the
            visible part of the screen using
 
            sequence for clearing the screen.  Rather than  clearing  just  the
            visible part of the screen using
 
-             printf '\033[2J'
+               printf '\033[2J'
 
            one could clear the <EM>scrollback</EM> using
 
 
            one could clear the <EM>scrollback</EM> using
 
-             printf '\033[<STRONG>3</STRONG>J'
+               printf '\033[<STRONG>3</STRONG>J'
 
 
-           This  is  documented in <EM>XTerm</EM> <EM>Control</EM> <EM>Sequences</EM> as a feature origi-
-           nating with xterm.
+           This  is  documented  in  <EM>XTerm</EM>  <EM>Control</EM>  <EM>Sequences</EM>  as  a  feature
+           originating with <STRONG>xterm</STRONG>.
 
        <STRONG>o</STRONG>   A few other terminal developers adopted the feature, e.g., PuTTY in
            2006.
 
        <STRONG>o</STRONG>   In  April  2011, a Red Hat developer submitted a patch to the Linux
            kernel, modifying its console driver to do  the  same  thing.   The
 
        <STRONG>o</STRONG>   A few other terminal developers adopted the feature, e.g., PuTTY in
            2006.
 
        <STRONG>o</STRONG>   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,
+           Linux  change,  part  of  the  3.0  release, did not mention <STRONG>xterm</STRONG>,
            although it was cited in the Red Hat bug report (#683733) which led
            to the change.
 
            although it was cited in the Red Hat bug report (#683733) which led
            to the change.
 
 
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
-       <STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
+       <STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>, <STRONG>xterm(1)</STRONG>.
 
 
-       This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20170812).
+       This describes <STRONG>ncurses</STRONG> version 6.3 (patch 20220813).
 
 
 
 
 
 
 <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-NAME">NAME</a></li>
 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
+<li><a href="#h2-OPTIONS">OPTIONS</a></li>
 <li><a href="#h2-HISTORY">HISTORY</a></li>
 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 <li><a href="#h2-HISTORY">HISTORY</a></li>
 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>