mirror of
https://git.FreeBSD.org/src.git
synced 2024-12-24 11:29:10 +00:00
118 lines
3.6 KiB
Groff
118 lines
3.6 KiB
Groff
.\" 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. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the University of
|
|
.\" California, Berkeley and its contributors.
|
|
.\" 4. 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 March 19, 1994
|
|
.Dt TPUT 1
|
|
.Os BSD 4.4
|
|
.Sh NAME
|
|
.Nm tput
|
|
.Nd terminal capability interface
|
|
.Sh SYNOPSIS
|
|
.Nm tput
|
|
.Op Fl T Ar term
|
|
.Ar attribute
|
|
.Sh DESCRIPTION
|
|
.Nm Tput
|
|
makes terminal-dependent information available to users or shell
|
|
applications.
|
|
The options are as follows:
|
|
.Bl -tag -width Ds
|
|
.It Fl T
|
|
The terminal name as specified in the
|
|
.Xr termcap
|
|
database, for example, ``vt100'' or ``xterm''.
|
|
If not specified,
|
|
.Nm tput
|
|
retrieves the
|
|
.Dq Ev TERM
|
|
variable from the environment.
|
|
.El
|
|
.Pp
|
|
.Nm Tput
|
|
outputs a string if the
|
|
.Ar attribute
|
|
is of type string; a number if it is of type integer.
|
|
Otherwise,
|
|
.Nm tput
|
|
exits 0 if the terminal has the capability and 1 if it does not,
|
|
without further action.
|
|
.Pp
|
|
If the
|
|
.Ar attribute
|
|
is of type string, and takes arguments (e.g. cursor movement,
|
|
the termcap
|
|
.Dq cm
|
|
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 termcap
|
|
``cl'' sequence).
|
|
.It init
|
|
Initialize the terminal (the
|
|
.Xr termcap
|
|
``is'' sequence).
|
|
.It longname
|
|
Print the descriptive name of the user's terminal type.
|
|
.It reset
|
|
Reset the terminal (the
|
|
.Xr termcap
|
|
``rs'' sequence).
|
|
.Sh DIAGNOSTICS
|
|
The exit value of
|
|
.Nm tput
|
|
is based on the last attribute specified.
|
|
If the attribute is of type string or of type integer,
|
|
.Nm tput
|
|
exits 0 if the attribute is defined for this terminal type and 1
|
|
if it is not.
|
|
If the attribute is of type boolean,
|
|
.Nm tput
|
|
exits 0 if the terminal has this attribute, and 1 if it does not.
|
|
.Nm Tput
|
|
exits 2 if any error occurred.
|
|
.Sh SEE ALSO
|
|
.Xr termcap 3 ,
|
|
.Xr termcap 5
|
|
.Sh BUGS
|
|
.Nm Tput
|
|
can't really distinguish between different types of attributes.
|
|
.Sh HISTORY
|
|
The
|
|
.Nm
|
|
command appears in
|
|
.Bx 4.4 .
|