t
***************************************************************************
Copyright (c) 1998-2011,2012 Free Software Foundation, Inc. *
*
Permission is hereby granted, free of charge, to any person obtaining a *
copy of this software and associated documentation files (the *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: tput.1,v 1.32 2012/07/14 21:06:45 tom Exp $
@TPUT@, reset - initialize a terminal or query terminfo database @TPUT@ [-Ttype] capname [parms ... ]

@TPUT@ [-Ttype] init

@TPUT@ [-Ttype] reset

@TPUT@ [-Ttype] longname

@TPUT@ -S <<

@TPUT@ -V

The @TPUT@ utility uses the terminfo database to make the values of terminal-dependent capabilities and information available to the shell (see sh(1)), to initialize or reset the terminal, or return the long name of the requested terminal type. The result depends upon the capability's type:

Before using a value returned on the standard output, the application should test the exit code (e.g., $?, see sh(1)) to be sure it is 0. (See the EXIT CODES and DIAGNOSTICS sections.) For a complete list of capabilities and the capname associated with each, see terminfo(5).

-Ttype indicates the type of terminal. Normally this option is unnecessary, because the default is taken from the environment variable TERM. If -T is specified, then the shell variables LINES and COLUMNS will also be ignored.

capname indicates the capability from the terminfo database. When termcap support is compiled in, the termcap name for the capability is also accepted.

parms If the capability is a string that takes parameters, the arguments parms will be instantiated into the string.

Most parameters are numbers. Only a few terminfo capabilities require string parameters; @TPUT@ uses a table to decide which to pass as strings. Normally @TPUT@ uses tparm (3X) to perform the substitution. If no parameters are given for the capability, @TPUT@ writes the string without performing the substitution.

-S allows more than one capability per invocation of @TPUT@. The capabilities must be passed to @TPUT@ from the standard input instead of from the command line (see example). Only one capname is allowed per line. The -S option changes the meaning of the 0 and 1 boolean and string exit codes (see the EXIT CODES section).

Again, @TPUT@ uses a table and the presence of parameters in its input to decide whether to use tparm (3X), and how to interpret the parameters.

-V reports the version of ncurses which was used in this program, and exits.

init If the terminfo database is present and an entry for the user's terminal exists (see -Ttype, above), the following will occur:

If an entry does not contain the information needed for any of the four above activities, that activity will silently be skipped.

reset Instead of putting out initialization strings, the terminal's reset strings will be output if present (rs1, rs2, rs3, rf). If the reset strings are not present, but initialization strings are, the initialization strings will be output. Otherwise, reset acts identically to init.

longname If the terminfo database is present and an entry for the user's terminal exists (see -Ttype above), then the long name of the terminal will be put out. The long name is the last name in the first line of the terminal's description in the terminfo database [see term(5)].

If @TPUT@ is invoked by a link named reset, this has the same effect as @TPUT@ reset. See @TSET@ for comparison, which has similar behavior.

5 @TPUT@ init Initialize the terminal according to the type of terminal in the environmental variable TERM. This command should be included in everyone's .profile after the environmental variable TERM has been exported, as illustrated on the profile(5) manual page.

5 @TPUT@ -T5620 reset Reset an AT&T 5620 terminal, overriding the type of terminal in the environmental variable TERM.

5 @TPUT@ cup 0 0 Send the sequence to move the cursor to row 0, column 0 (the upper left corner of the screen, usually known as the "home" cursor position).

5 @TPUT@ clear Echo the clear-screen sequence for the current terminal.

5 @TPUT@ cols Print the number of columns for the current terminal.

5 @TPUT@ -T450 cols Print the number of columns for the 450 terminal.

5 bold=`@TPUT@ smso` offbold=`@TPUT@ rmso` Set the shell variables bold, to begin stand-out mode sequence, and offbold, to end standout mode sequence, for the current terminal. This might be followed by a prompt: echo "${bold}Please type in your name: ${offbold}\\c"

5 @TPUT@ hc Set exit code to indicate if the current terminal is a hard copy terminal.

5 @TPUT@ cup 23 4 Send the sequence to move the cursor to row 23, column 4.

5 @TPUT@ cup Send the terminfo string for cursor-movement, with no parameters substituted.

5 @TPUT@ longname Print the long name from the terminfo database for the type of terminal specified in the environmental variable TERM.

5 \& This example shows @TPUT@ processing several capabilities in one invocation. It clears the screen, moves the cursor to position 10, 10 and turns on bold (extra bright) mode. The list is terminated by an exclamation mark (!) on a line by itself.

\*d compiled terminal description database

@DATADIR@/tabset/* tab settings for some terminals, in a format appropriate to be output to the terminal (escape sequences that set margins and tabs); for more information, see the "Tabs and Initialization" section of terminfo(5)

If the -S option is used, @TPUT@ checks for errors from each line, and if any errors are found, will set the exit code to 4 plus the number of lines with errors. If no errors are found, the exit code is 0. No indication of which line failed can be given so exit code 1 will never appear. Exit codes 2, 3, and 4 retain their usual interpretation. If the -S option is not used, the exit code depends on the type of capname:

Any other exit code indicates an error; see the DIAGNOSTICS section.

@TPUT@ prints the following error messages and sets the corresponding exit codes.

exit code error message

0

(capname is a numeric variable that is not specified in the

terminfo(5) database for this terminal type, e.g.

@TPUT@ -T450 lines and @TPUT@ -T2621 xmc)

1 no error message is printed, see the EXIT CODES section.

2 usage error

3 unknown terminal type or no terminfo database

4 unknown terminfo capability capname

>4 error occurred in -S

The longname and -S options, and the parameter-substitution features used in the cup example, are not supported in BSD curses or in AT&T/USL curses before SVr4.

X/Open documents only the operands for clear, init and reset. In this implementation, clear is part of the capname support. Other implementations of @TPUT@ on SVr4-based systems such as Solaris, IRIX64 and HPUX as well as others such as AIX and Tru64 provide support for capname operands.

A few platforms such as FreeBSD and NetBSD recognize termcap names rather than terminfo capability names in their respective @TPUT@ commands.

Most implementations which provide support for capname operands use the tparm function to expand parameters in it. That function expects a mixture of numeric and string parameters, requiring @TPUT@ to know which type to use. This implementation uses a table to determine that for the standard capname operands, and an internal library function to analyze nonstandard capname operands. Other implementations may simply guess that an operand containing only digits is intended to be a number.

@CLEAR@(1), stty(1), tabs(\*n), terminfo(5), curs_termcap(3X).

This describes ncurses version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).