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