clear(1) [freebsd man page]

TPUT(1) 						    BSD General Commands Manual 						   TPUT(1)

NAME

     tput, clear -- terminal capability interface

SYNOPSIS

     tput [-T term] attribute ...
     clear

DESCRIPTION

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

EXIT STATUS

     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

     termcap(5), terminfo(5)

STANDARDS

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

HISTORY

     The tput utility appeared in 4.4BSD.

BUGS

     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.

BSD
								   June 15, 2002							       BSD

tput(1) 						      General Commands Manual							   tput(1)

NAME

       tput - query terminfo database

SYNOPSIS

       type] capname...

       type] capname [parms...]

DESCRIPTION

       The  command  uses the database to make terminal-dependent capabilities and information available to the shell (see terminfo(4)).  The com-
       mand outputs a string if the attribute (capname) is of type string, or an integer if the attribute is of type integer.  If the attribute is
       of type boolean, simply sets the exit code for TRUE, for FALSE), and produces no output.

   Command-line Arguments
       The command recognizes the following command-line arguments:

	      Indicates the type of terminal.
			     Normally this flag is unnecessary because the default is taken from the environment variable

	      capname	     Indicates the attribute from the database.  See terminfo(4).  In addition, the following capnames are supported:

				  Echo the clear-screen sequence for the current terminal.

				  Echo the initialize sequence for the current terminal.

				  Echo the sequence that will reset the current terminal.

	      parms	     If the capname takes optional numeric parameters, the parms will be placed in the string output by

	      The	     capnames  are  read  from stdin and multiple capnames are allowed.  Only one capname is allowed per line when reading
			     from stdin.

EXTERNAL INFLUENCES

   Environment Variables
       determines the locale to use.  This overrides settings of other environment variables.

       determines the language to use for messages.

       determines the terminal type if the option is not specified.

EXAMPLES

       Echo clear-screen sequence for the current terminal.

       Print the number of columns for the current terminal.

       Print the number of columns for the 70092 terminal.

       Set shell variable to stand-out-mode sequence for current terminal.

       This might be followed by a prompt:

       Set exit code to indicate if current terminal is a hard copy terminal.

       Clear the screen, move the cursor to line 10, column 20 and turn on bold.

RETURN VALUE

       If capname is of type boolean, then the exit code is set to for true and for false.

       If capname is not of type boolean and fails, an error message is printed, and exit code is set to one of the  following	depending  on  the
       failure:

	      The capability name is of type integer and does not exist.
	      Usage error.
	      Unknown terminal type.
	      Unknown capability name.
	      An error occurred.

       If  the	exit  code  is a is printed if a capability name of type integer is requested for a terminal that has no entry for that capability
       name in the database (such as

FILES

       Terminfo data base
       Definition files

       SEE ALSO
	      stty(1), untic(1M), terminfo(4).

STANDARDS CONFORMANCE

																	   tput(1)