1.\" Copyright (c) 1989, 1990, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 4. Neither the name of the University nor the names of its contributors 13.\" may be used to endorse or promote products derived from this software 14.\" without specific prior written permission. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.\" @(#)tput.1 8.2 (Berkeley) 3/19/94 29.\" $FreeBSD$ 30.\" 31.Dd June 15, 2002 32.Dt TPUT 1 33.Os 34.Sh NAME 35.Nm tput , 36.Nm clear 37.Nd terminal capability interface 38.Sh SYNOPSIS 39.Nm 40.Op Fl T Ar term 41.Ar attribute ... 42.Nm clear 43.Sh DESCRIPTION 44The 45.Nm 46utility makes terminal-dependent information available to users or shell 47applications. 48When invoked as the 49.Nm clear 50utility, the screen will be cleared as if 51.Dl tput clear 52had been executed. 53The options to 54.Nm 55are as follows: 56.Bl -tag -width Ds 57.It Fl T 58The terminal name as specified in the 59.Xr termcap 5 60database, for example, 61.Dq vt100 62or 63.Dq xterm . 64If not specified, 65.Nm 66retrieves the 67.Dq Ev TERM 68variable from the environment. 69.El 70.Pp 71The 72.Nm 73utility outputs a string for each 74.Ar attribute 75that is of type string; a number for each of type integer. 76Otherwise, 77.Nm 78exits 0 if the terminal has the capability and 1 if it does not, 79without further action. 80.Pp 81If an 82.Ar attribute 83is of type string, and takes arguments (e.g.\& cursor movement, 84the termcap 85.Dq cm 86sequence) the arguments are taken from the command line immediately 87following the attribute. 88.Pp 89The following special attributes are available: 90.Bl -tag -width Ar 91.It Cm clear 92Clear the screen (the 93.Xr termcap 5 94.Dq cl 95sequence). 96.It Cm init 97Initialize the terminal (the 98.Xr termcap 5 99.Dq is 100sequence). 101.It Cm longname 102Print the descriptive name of the user's terminal type. 103.It Cm reset 104Reset the terminal (the 105.Xr termcap 5 106.Dq rs 107sequence). 108.El 109.Sh EXIT STATUS 110The exit status of 111.Nm 112is as follows: 113.Bl -tag -width indent 114.It 0 115If the last attribute 116.Ar attribute 117argument is of type string or integer, its value was successfully written 118to standard output. 119If the argument is of type boolean, the terminal has this attribute. 120.It 1 121This terminal does not have the specified boolean 122.Ar attribute . 123.It 2 124Usage error. 125.It 3 126No information is available about the specified terminal type. 127.El 128.Sh SEE ALSO 129.Xr termcap 5 , 130.Xr terminfo 5 131.Sh STANDARDS 132The 133.Nm 134utility conforms to 135.St -p1003.1-2001 . 136.Sh HISTORY 137The 138.Nm 139utility appeared in 140.Bx 4.4 . 141.Sh BUGS 142The 143.Nm 144utility cannot really distinguish between different types of attributes. 145.Pp 146Some termcap entries depend upon having a 147.Sq % 148in them that is just a 149.Sq % 150and nothing more. 151Right now we just warn about them if they do not 152have a valid type declaration. 153These warnings are sent to 154stderr. 155