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. 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: src/usr.bin/tput/tput.1,v 1.5.2.3 2001/08/16 13:17:08 ru Exp $ 30.\" 31.Dd March 19, 1994 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 46command makes terminal-dependent information available to users or shell 47applications. When invoked as the 48.Nm clear 49utility, the screen will be cleared as if 50.Dl tput clear 51had been executed. 52The options to 53.Nm 54are as follows: 55.Bl -tag -width Ds 56.It Fl T 57The terminal name as specified in the 58.Xr termcap 5 59database, for example, 60.Dq vt100 61or 62.Dq xterm . 63If not specified, 64.Nm 65retrieves the 66.Dq Ev TERM 67variable from the environment. 68.El 69.Pp 70The 71.Nm 72command outputs a string if the 73.Ar attribute 74is of type string; a number if it is of type integer. 75Otherwise, 76.Nm 77exits 0 if the terminal has the capability and 1 if it does not, 78without further action. 79.Pp 80If the 81.Ar attribute 82is of type string, and takes arguments (e.g. cursor movement, 83the termcap 84.Dq cm 85sequence) the arguments are taken from the command line immediately 86following the attribute. 87.Pp 88The following special attributes are available: 89.Bl -tag -width Ar 90.It clear 91Clear the screen (the 92.Xr termcap 5 93.Dq cl 94sequence). 95.It init 96Initialize the terminal (the 97.Xr termcap 5 98.Dq is 99sequence). 100.It longname 101Print the descriptive name of the user's terminal type. 102.It reset 103Reset the terminal (the 104.Xr termcap 5 105.Dq rs 106sequence). 107.El 108.Sh EXIT STATUS 109The exit value of 110.Nm 111is based on the last attribute specified. 112If the attribute is of type string or of type integer, 113.Nm 114exits 0 if the attribute is defined for this terminal type and 1 115if it is not. 116If the attribute is of type boolean, 117.Nm 118exits 0 if the terminal has this attribute, and 1 if it does not. 119The 120.Nm 121command exits 2 if any error occurred. 122.Sh SEE ALSO 123.Xr termcap 5 , 124.Xr terminfo 5 125.Sh HISTORY 126The 127.Nm 128command appeared in 129.Bx 4.4 . 130.Sh BUGS 131The 132.Nm 133command can't really distinguish between different types of attributes. 134.Pp 135Some termcap entries depend upon having a 136.Sq % 137in them that is just a 138.Sq % 139and nothing more. Right now we just warn about them if they don't 140have a valid type declaration. These warnings are sent to 141stderr. 142