1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
.\" $OpenBSD: tput.1,v 1.26 2022/12/22 19:53:24 kn Exp $
.\" $NetBSD: tput.1,v 1.4 1994/12/07 08:49:10 jtc Exp $
.\"
.\" Copyright (c) 1989, 1990, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" @(#)tput.1 8.2 (Berkeley) 3/19/94
.\"
.Dd $Mdocdate: December 22 2022 $
.Dt TPUT 1
.Os
.Sh NAME
.Nm tput ,
.Nm clear
.Nd terminal capability interface
.Sh SYNOPSIS
.Nm tput
.Op Fl T Ar term
.Ar attribute
.Op Ar attribute-arg ...
.Ar ...
.Nm tput
.Op Fl T Ar term
.Fl S
.Nm clear
.Op Fl T Ar term
.Sh DESCRIPTION
The
.Nm
utility makes terminal-dependent information available to users or shell
applications.
When invoked as
.Nm clear ,
it provides the same functionality as
.Nm tput Cm clear .
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl S
The attributes are read from stdin instead of the command line.
.It Fl T
The terminal name as found in the
.Xr terminfo 5
database; for example,
.Dq vt100
or
.Dq xterm .
If not specified,
.Nm
retrieves the
.Ev TERM
variable from the environment.
.El
.Pp
.Nm
outputs a string if the
.Ar attribute
is of type string or a number if it is of type integer.
If the
.Ar attribute
is of type boolean,
.Nm
exits 0 if the terminal has the capability or 1 if it
does not.
Each
.Ar attribute
should be a string defined in either
.Xr terminfo 5
or
.Xr termcap 5 .
.Pp
If the
.Ar attribute
is of type string and takes arguments (e.g., cursor movement,
the
.Xr terminfo 5
.Dq cup
sequence) the arguments are taken from the command line immediately
following the attribute.
.Pp
The following special attributes are available:
.Bl -tag -width Ar
.It clear
Clear the screen (the
.Xr terminfo 5
.Dq clear
sequence).
.It init
Print the
.Xr terminfo 5
initialization strings for the specified terminal.
.It longname
Print the descriptive name of the user's terminal type.
.It reset
Reset the terminal (using the
.Xr terminfo 5
reset sequences).
.El
.Sh ENVIRONMENT
.Bl -tag -width Ds
.It Ev TERM
Determine the terminal type.
.El
.Sh EXIT STATUS
The exit value of
.Nm
is based on the last attribute specified.
If the attribute is of type string or of type integer, the exit
value is as follows:
.Pp
.Bl -tag -offset indent -width Ds -compact
.It 0
The requested string was written successfully.
.It 2
Usage error.
.It 3
Unknown terminal type.
.It 4
Unknown attribute name.
.It >4
An error occurred.
.El
.Pp
If the attribute is of type boolean,
.Nm
exits with a value of 0 if the terminal has this attribute or
1 if it does not.
.Sh EXAMPLES
Clear the screen and go to line 5 column 10:
.Pp
.Dl $ tput clear cup 5 10
.Pp
Go to line 6 column 11 and delete 6 characters:
.Pp
.Dl $ tput cup 6 11 dch 6
.Sh SEE ALSO
.Xr terminfo 3 ,
.Xr terminfo 5
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2008
specification.
.Pp
The flag
.Op Fl S
and the attribute
.Cm longname
are extensions to that specification.
.Sh HISTORY
The
.Nm clear
utility first appeared in
.Bx 2 .
The
.Nm
utility first appeared in
.At V.2
and was reimplemented for
.Bx 4.3 Reno .
.Sh BUGS
.Nm
can't really distinguish between different types of attributes.
|
