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