version 1.7, 1999/06/29 19:39:40 |
version 1.8, 1999/08/18 13:02:31 |
|
|
.Op Fl T Ar term |
.Op Fl T Ar term |
.Fl S |
.Fl S |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
.Nm tput |
The |
makes terminal-dependent information available to users or shell |
.Nm |
|
utility makes terminal-dependent information available to users or shell |
applications. |
applications. |
|
.Pp |
The options are as follows: |
The options are as follows: |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Fl T |
.It Fl T |
The terminal name as specified in the |
The terminal name as found in the |
.Xr terminfo |
.Xr terminfo |
database, for example, ``vt100'' or ``xterm''. |
database; for example, |
|
.Dq vt100 |
|
or |
|
.Dq xterm . |
If not specified, |
If not specified, |
.Nm tput |
.Nm |
retrieves the |
retrieves the |
.Dq Ev TERM |
.Ev TERM |
variable from the environment. |
variable from the environment. |
.It Fl S |
.It Fl S |
The |
The |
.Ar attributes |
.Ar attributes |
are read from stdin instead of from the command line. |
are read from stdin instead of the command line. |
.El |
.El |
.Pp |
.Pp |
.Nm tput |
.Nm |
outputs a string if the |
outputs a string if the |
.Ar attribute |
.Ar attribute |
is of type string; a number if it is of type integer. |
is of type string or a number if it is of type integer. |
If the |
If the |
.Ar attribute |
.Ar attribute |
is of type boolean, |
is of type boolean, |
.Nm tput |
.Nm |
exits 0 if the terminal has the capability and 1 if it |
exits 0 if the terminal has the capability or 1 if it |
does not. Each |
does not. Each |
.Ar attribute |
.Ar attribute |
should be a string defined in either |
should be a string defined in either |
|
|
.Pp |
.Pp |
If the |
If the |
.Ar attribute |
.Ar attribute |
is of type string, and takes arguments (e.g. cursor movement, |
is of type string and takes arguments (e.g., cursor movement, |
the |
the |
.Xr terminfo |
.Xr terminfo |
.Dq cup |
.Dq cup |
|
|
.It clear |
.It clear |
Clear the screen (the |
Clear the screen (the |
.Xr terminfo |
.Xr terminfo |
``clear'' sequence). |
.Dq clear |
|
sequence). |
.It init |
.It init |
Print the |
Print the |
.Xr terminfo |
.Xr terminfo |
|
|
reset sequences). |
reset sequences). |
.Sh DIAGNOSTICS |
.Sh DIAGNOSTICS |
The exit value of |
The exit value of |
.Nm tput |
.Nm |
is based on the last attribute specified. |
is based on the last attribute specified. |
If the attribute is of type string or of type integer the exit |
If the attribute is of type string or of type integer the exit |
value is as follows: |
value is as follows: |
|
.Pp |
.Bl -tag -offset indent -width Ds -compact |
.Bl -tag -offset indent -width Ds -compact |
.It 0 |
.It 0 |
The requested string was written successfully. |
The requested string was written successfully. |
|
|
.El |
.El |
.Pp |
.Pp |
If the attribute is of type boolean, |
If the attribute is of type boolean, |
.Nm tput |
.Nm |
exits with a value of 0 if the terminal has this attribute, and |
exits with a value of 0 if the terminal has this attribute or |
1 if it does not. |
1 if it does not. |
.Sh EXAMPLES |
.Sh EXAMPLES |
.Bl -tag -width "tput cup 6 11 dch 6" -compact |
.Bl -tag -width "tput cup 6 11 dch 6" -compact |
|
|
.Xr terminfo 3 , |
.Xr terminfo 3 , |
.Xr terminfo 5 |
.Xr terminfo 5 |
.Sh BUGS |
.Sh BUGS |
.Nm tput |
.Nm |
can't really distinguish between different types of attributes. |
can't really distinguish between different types of attributes. |
.Sh HISTORY |
.Sh HISTORY |
The |
The |
.Nm |
.Nm |
command appeared in |
utility appeared in |
.Bx 4.4 . |
.Bx 4.4 . |