ncurses 6.0 - patch 20171028
[ncurses.git] / doc / html / man / clear.1.html
index 36beee1fb112deaf11e7e6d3f72bc0d764dd1827..2f499b75b6056f009ed2051cbadb853ba94c0552 100644 (file)
@@ -1,6 +1,6 @@
 <!-- 
   ****************************************************************************
-  * Copyright (c) 1998-2013,2016 Free Software Foundation, Inc.              *
+  * Copyright (c) 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,7 +26,7 @@
   * 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.18 2017/10/07 21:30:17 tom Exp @
   * these would be fallbacks for DS/DE,
   * but groff changed the meaning of the macros.
 -->
@@ -52,7 +52,7 @@
 
 
 </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>
        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  unneces-
+            sary,  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>COL-</STRONG>
+            <STRONG>UMNS</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>
-       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).
 
-       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.,
 
          /usr/bin/tput ${1:+-T$1} clear 2&gt; /dev/null
 
        The remainder of the script in each case is a copyright notice.
 
-       The ncurses <STRONG>clear</STRONG> command began in 1995 by adapting  the  original  BSD
+       The  ncurses  <STRONG>clear</STRONG>  command began in 1995 by adapting the original BSD
        <STRONG>clear</STRONG> command (with terminfo, of course).
 
        The <STRONG>E3</STRONG> extension came later:
 
-       <STRONG>o</STRONG>   In  June  1999, xterm provided an extension to the standard control
-           sequence for clearing the screen.  Rather than  clearing  just  the
+       <STRONG>o</STRONG>   In June 1999, xterm provided an extension to the  standard  control
+           sequence  for  clearing  the screen.  Rather than clearing just the
            visible part of the screen using
 
              printf '\033[2J'
 
              printf '\033[<STRONG>3</STRONG>J'
 
-           This  is  documented in <EM>XTerm</EM> <EM>Control</EM> <EM>Sequences</EM> as a feature origi-
+           This is documented in <EM>XTerm</EM> <EM>Control</EM> <EM>Sequences</EM> as a  feature  origi-
            nating with xterm.
 
        <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,
+       <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,
            although it was cited in the Red Hat bug report (#683733) which led
            to the change.
 
-       <STRONG>o</STRONG>   Again,  a  few  other terminal developers adopted the feature.  But
+       <STRONG>o</STRONG>   Again, a few other terminal developers adopted  the  feature.   But
            the next relevant step was a change to the <STRONG>clear</STRONG> program in 2013 to
            incorporate this extension.
 
-       <STRONG>o</STRONG>   In  2013,  the <STRONG>E3</STRONG> extension was overlooked in <STRONG>tput</STRONG> with the "clear"
-           parameter.  That was addressed in  2016  by  reorganizing  <STRONG>tput</STRONG>  to
+       <STRONG>o</STRONG>   In 2013, the <STRONG>E3</STRONG> extension was overlooked in <STRONG>tput</STRONG> with  the  "clear"
+           parameter.   That  was  addressed  in  2016 by reorganizing <STRONG>tput</STRONG> to
            share its logic with <STRONG>clear</STRONG> and <STRONG>tset</STRONG>.
 
 
        Neither IEEE Std 1003.1/The Open  Group  Base  Specifications  Issue  7
        (POSIX.1-2008) nor X/Open Curses Issue 7 documents tset or reset.
 
-       The latter documents <STRONG>tput</STRONG>, which could be used to replace this  utility
-       either  via  a shell script or by an alias (such as a symbolic link) to
+       The  latter documents <STRONG>tput</STRONG>, which could be used to replace this utility
+       either via a shell script or by an alias (such as a symbolic  link)  to
        run <STRONG>tput</STRONG> as <STRONG>clear</STRONG>.
 
 
 </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>
 
-       This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20170506).
+       This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20171028).
 
 
 
 <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>