1 .\" Copyright (c) 1989, 1990, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
28 .\" @(#)tput.1 8.2 (Berkeley) 3/19/94
37 .Nd terminal capability interface
46 utility makes terminal-dependent information available to users or shell
53 command, ignoring any arguments.
60 The terminal name as specified in the
62 database, for example,
70 variable from the environment unless that too is not specified,
71 in which case an error message will be sent to standard error and
72 the error status will be 2.
77 utility outputs a string for each
79 that is of type string; a number for each of type integer.
82 exits 0 if the terminal has the capability and 1 if it does not,
83 without further action.
87 is of type string, and takes arguments (e.g.\& cursor movement,
90 capability) the arguments are taken from the command line immediately
91 following the attribute.
93 The following special attributes are available.
94 The first three use the capabilities of the specified terminal,
95 and only work if compatible with the utility's terminal.
103 Initialize the terminal (the
108 Reset the terminal (the
113 Print the descriptive name of the user's terminal type.
116 .Bl -tag -width ".Ev TERM"
118 The terminal name, if set and
126 .Bl -tag -width indent
130 is of type string or integer, its value was successfully written
134 is of type boolean, the terminal does have the
143 this terminal does not have the
151 No information is available about the specified terminal type.
169 utility cannot really distinguish between different types of attributes.
171 Some termcap entries depend upon having a
173 in them that is just a
176 Right now we just warn about them if they do not
177 have a valid type declaration.
178 These warnings are sent to