*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->FreeBSD man pages -> clear (1)              
Title
Content
Arch
Section
 

TPUT(1)

Contents


NAME    [Toc]    [Back]

     tput, clear -- terminal capability interface

SYNOPSIS    [Toc]    [Back]

     tput [-T term] attribute ...
     clear

DESCRIPTION    [Toc]    [Back]

     The tput utility makes terminal-dependent information available to users
     or shell applications.  When invoked as the clear utility, the screen
     will be cleared as if
	   tput clear
     had been executed.  The options to tput are as follows:

     -T      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.

     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'' sequence) the arguments are taken from the command
 line immediately following the attribute.

     The following special attributes are available:

     clear	   Clear the screen (the termcap(5) ``cl'' sequence).

     init	   Initialize the terminal (the termcap(5) ``is'' sequence).

     longname	   Print the descriptive name of the user's terminal type.

     reset	   Reset the terminal (the termcap(5) ``rs'' sequence).

DIAGNOSTICS    [Toc]    [Back]

     The exit status of tput is as follows:

     0	     If the last attribute attribute argument is of type string or
	     integer, its value was successfully written to standard output.
	     If the argument is of type boolean, the terminal has this
	     attribute.

     1	     This terminal does not have the specified boolean attribute.

     2	     Usage error.

     3	     No information is available about the specified terminal type.

SEE ALSO    [Toc]    [Back]

      
      
     termcap(5), terminfo(5)

STANDARDS    [Toc]    [Back]

     The tput utility conforms to IEEE Std 1003.1-2001 (``POSIX.1'').

HISTORY    [Toc]    [Back]

     The tput utility appeared in 4.4BSD.

BUGS    [Toc]    [Back]

     The tput utility can't 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 don't have a
     valid type declaration.  These warnings are sent to stderr.


FreeBSD 5.2.1			 June 15, 2002			 FreeBSD 5.2.1
[ Back ]
 Similar pages
Name OS Title
termcap OpenBSD terminal capability database
termcap Tru64 Terminal capability database
termcap Linux terminal capability database
terminfo OpenBSD terminal capability data base
terminfo FreeBSD terminal capability data base
termcap FreeBSD terminal capability data base
terminfo IRIX terminal capability data base
terminfo Linux terminal capability data base
terminfo HP-UX printer, terminal, and modem capability database
tgetent OpenBSD direct curses interface to the terminfo capability database
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service