Commit | Line | Data |
---|---|---|
1c07ceab WJ |
1 | .\" Copyright (c) 1989, 1990 The Regents of the University of California. |
2 | .\" 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 6.4 (Berkeley) 4/23/91 | |
33 | .\" | |
34 | .Dd April 23, 1991 | |
35 | .Dt TPUT 1 | |
36 | .Os | |
37 | .Sh NAME | |
38 | .Nm tput | |
39 | .Nd terminal capability interface | |
40 | .Sh SYNOPSIS | |
41 | .Nm tput | |
42 | .Op Fl T Ar term | |
43 | .Ar attribute | |
44 | .Sh DESCRIPTION | |
45 | .Nm Tput | |
46 | makes terminal-dependent information available to users or shell | |
47 | applications. | |
48 | The options are as follows: | |
49 | .Bl -tag -width Ds | |
50 | .It Fl T | |
51 | The terminal name as specified in the | |
52 | .Xr termcap | |
53 | database, for example, ``vt100'' or ``xterm''. | |
54 | If not specified, | |
55 | .Nm tput | |
56 | retrieves the | |
57 | .Dq Ev TERM | |
58 | variable from the environment. | |
59 | .El | |
60 | .Pp | |
61 | .Nm Tput | |
62 | outputs a string if the | |
63 | .Ar attribute | |
64 | is of type string; a number if it is of type integer. | |
65 | Otherwise, | |
66 | .Nm tput | |
67 | exits 0 if the terminal has the capability and 1 if it does not, | |
68 | without further action. | |
69 | .Pp | |
70 | The following special attributes are available: | |
71 | .Bl -tag -width Ar | |
72 | .It Ar clear | |
73 | Clear the screen (the | |
74 | .Xr termcap | |
75 | ``cl'' sequence). | |
76 | .It Ar init | |
77 | Initialize the terminal (the | |
78 | .Xr termcap | |
79 | ``is'' sequence). | |
80 | .It Ar longname | |
81 | Print the descriptive name of the user's terminal type. | |
82 | .It Ar reset | |
83 | Reset the terminal (the | |
84 | .Xr termcap | |
85 | ``rs'' sequence). | |
86 | .Sh DIAGNOSTICS | |
87 | The exit value of | |
88 | .Nm tput | |
89 | is based on the last attribute specified. | |
90 | If the attribute is of type string or of type integer, | |
91 | .Nm tput | |
92 | exits 0 if the attribute is defined for this terminal type and 1 | |
93 | if it is not. | |
94 | If the attribute is of type boolean, | |
95 | .Nm tput | |
96 | exits 0 if the terminal has this attribute, and 1 if it does not. | |
97 | .Nm Tput | |
98 | exits 2 if any error occurred. | |
99 | .Sh SEE ALSO | |
100 | .Xr termcap 3 , | |
101 | .Xr termcap 5 | |
102 | .Sh BUGS | |
103 | .Nm Tput | |
104 | can't really distinguish between different types of attributes. | |
105 | This is due to the limited interface in the current version of | |
106 | .Xr termcap 3 , | |
107 | and will be fixed in the near future. | |
108 | .Sh HISTORY | |
109 | The | |
110 | .Nm | |
111 | command is | |
112 | .Ud . |