GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
TPUT(1) FreeBSD General Commands Manual TPUT(1)

tput, clear
terminal capability interface

tput [-T term] [attribute ...]

clear

The tput utility makes terminal-dependent information available to users or shell applications.

The clear utility executes the

tput clear
command, ignoring any arguments.

The only option to tput is:

The terminal name as specified in the termcap(5) database, for example, “vt100” or “xterm”. If not specified, tput retrieves the “TERM” variable from the environment unless that too is not specified, in which case an error message will be sent to standard error and the error status will be 2.

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

If an attribute is of type string, and takes arguments (e.g. cursor movement, the termcap “cm” capability) the arguments are taken from the command line immediately following the attribute.

The following special attributes are available. The first three use the capabilities of the specified terminal, and only work if compatible with the utility's terminal.

Clear the screen (the termcap(5) “cl” capability).
Initialize the terminal (the termcap(5) “is” capability).
Reset the terminal (the termcap(5) “rs” capability).
Print the descriptive name of the user's terminal type.

The terminal name, if set and -T is not used.

The exit status of tput is as follows:
0
If the last attribute is of type string or integer, its value was successfully written to standard output. If the attribute is of type boolean, the terminal does have the attribute. Otherwise, no attribute was specified.
1
If the last attribute is of type boolean, this terminal does not have the attribute.
2
Usage error. For example, see -T description.
3
No information is available about the specified terminal type.

termcap(5), terminfo(5)

The tput utility conforms to IEEE Std 1003.1-2001 (“POSIX.1”).

The tput utility appeared in 4.4BSD.

The tput utility cannot really distinguish between different types of attributes.

Some termcap entries depend upon having a ‘%’ in them that is just a ‘%’ and nothing more. Right now we just warn about them if they do not have a valid type declaration. These warnings are sent to stderr.

June 15, 2002 FreeBSD 13.1-RELEASE

Search for    or go to Top of page |  Section 1 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.