TPUT

Section: User Commands (1)
Index Return to Main Contents

BSD mandoc

NAME

tput - terminal capability interface

SYNOPSIS

tput [-T term ] attribute

DESCRIPTION

Tput makes terminal-dependent information available to users or shell applications. The options are as follows:

-T: The terminal name as specified in the termcap database, for example, ``vt100'' or ``xterm''. If not specified, tput retrieves the ``TERM '' variable from the environment.

Tput outputs a string if the attribute is of type string; a number if it is of type integer. Otherwise, tput exits 0 if the terminal has the capability and 1 if it does not, without further action.

The following special attributes are available:

clear: Clear the screen (the termcap ``cl'' sequence).
init: Initialize the terminal (the termcap ``is'' sequence).
longname: Print the descriptive name of the user's terminal type.
reset: Reset the terminal (the termcap ``rs'' sequence).

DIAGNOSTICS

The exit value of tput is based on the last attribute specified. If the attribute is of type string or of type integer, 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, tput exits 0 if the terminal has this attribute, and 1 if it does not. Tput exits 2 if any error occurred.

BUGS

Tput can't really distinguish between different types of attributes. This is due to the limited interface in the current version of termcap(3), and will be fixed in the near future.

HISTORY

The tput command is Ud .

This document was created by man2html, using the manual pages.
Time: 06:26:36 GMT, May 19, 2025