+
tput, reset - initialize a terminal or query terminfo
database
-SYNOPSIS
+
tput [-Ttype] capname [parms ... ]
tput [-Ttype] init
tput [-Ttype] reset
@@ -63,10 +64,10 @@
-DESCRIPTION
+
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
+ 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:
@@ -87,7 +88,7 @@
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 DIAG-
+ sh(1)) to be sure it is 0. (See the EXIT CODES and DIAG-
NOSTICS sections.) For a complete list of capabilities
and the capname associated with each, see terminfo(5).
@@ -95,54 +96,53 @@
option is unnecessary, because the default is taken
from the environment variable TERM. If -T is spec-
ified, then the shell variables LINES and COLUMNS
- will be ignored,and the operating system will not
- be queried for the actual screen size.
+ will also be ignored.
capname
- indicates the capability from the terminfo
- database. When termcap support is compiled in, the
+ indicates the capability from the terminfo data-
+ base. When termcap support is compiled in, the
termcap name for the capability is also accepted.
- parms If the capability is a string that takes parame-
+ parms If the capability is a string that takes parame-
ters, the arguments parms will be instantiated into
the string.
- Most parameters are numbers. Only a few terminfo
+ 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.
+ tput uses tparm (3x) to perform the substitution.
If no parameters are given for the capability, tput
- writes the string without performing the
- substitution.
+ writes the string without performing the substitu-
+ tion.
- -S allows more than one capability per invocation of
+ -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
+ (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 param-
- eters in its input to decide whether to use tparm
+ eters 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
+ -V reports the version of ncurses which was used in
this program, and exits.
- init If the terminfo database is present and an entry
+ init If the terminfo database is present and an entry
for the user's terminal exists (see -Ttype, above),
the following will occur:
- (1) if present, the terminal's initialization
- strings will be output as detailed in the
- terminfo(5) section on Tabs and Initializa-
+ (1) if present, the terminal's initialization
+ strings will be output as detailed in the
+ terminfo(5) section on Tabs and Initializa-
tion,
- (2) any delays (e.g., newline) specified in the
+ (2) any delays (e.g., newline) specified in the
entry will be set in the tty driver,
- (3) tabs expansion will be turned on or off
+ (3) tabs expansion will be turned on or off
according to the specification in the entry,
and
@@ -153,37 +153,37 @@
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 ini-
- tialization strings will be output. Otherwise,
+ 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 ini-
+ tialization 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),
+ 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
+ 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.
-EXAMPLES
+
tput init
Initialize the terminal according to the type of ter-
- minal in the environmental variable TERM. This com-
- mand should be included in everyone's .profile after
+ minal in the environmental variable TERM. This com-
+ mand should be included in everyone's .profile after
the environmental variable TERM has been exported, as
- illustrated on the profile(5) manual page.
+ illustrated on the profile(5) manual page.
tput -T5620 reset
- Reset an AT&T 5620 terminal, overriding the type of
+ Reset an AT&T 5620 terminal, overriding the type of
terminal in the environmental variable TERM.
tput cup 0 0
@@ -239,7 +239,7 @@
-FILES
+
/usr/share/terminfo
compiled terminal description database
@@ -252,7 +252,7 @@
-EXIT CODES
+
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
@@ -263,42 +263,41 @@
type of capname:
boolean
- a value of 0 is set for TRUE and 1 for FALSE.
+ a value of 0 is set for TRUE and 1 for FALSE.
- string a value of 0 is set if the capname is defined
- for this terminal type (the value of capname
- is returned on standard output); a value of 1
+ string a value of 0 is set if the capname is defined
+ for this terminal type (the value of capname
+ is returned on standard output); a value of 1
is set if capname is not defined for this ter-
- minal type (nothing is written to standard
+ minal type (nothing is written to standard
output).
integer
- a value of 0 is always set, whether or not
+ a value of 0 is always set, whether or not
capname is defined for this terminal type. To
- determine if capname is defined for this ter-
+ determine if capname is defined for this ter-
minal type, the user must test the value writ-
- ten to standard output. A value of -1 means
- that capname is not defined for this terminal
+ ten to standard output. A value of -1 means
+ that capname is not defined for this terminal
type.
- other reset or init may fail to find their respec-
- tive files. In that case, the exit code is
+ other reset or init may fail to find their respec-
+ tive files. In that case, the exit code is
set to 4 + errno.
- Any other exit code indicates an error; see the DIAGNOS-
+ Any other exit code indicates an error; see the DIAGNOS-
TICS section.
-DIAGNOSTICS
+
tput prints the following error messages and sets the cor-
responding 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.
+ 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
@@ -309,35 +308,55 @@
-PORTABILITY
- The longname and -S options, and the parameter-substitu-
- tion features used in the cup example, are not supported
+
+ The longname and -S options, and the parameter-substitu-
+ tion 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 cap-
+ X/Open documents only the operands for clear, init and
+ reset. In this implementation, clear is part of the cap-
name 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 rec-
- ognize termcap names rather than terminfo capability names
- in their respective tput commands.
+ such as AIX and Tru64 provide support for capname oper-
+ ands.
+
+ A few platforms such as FreeBSD and NetBSD recognize term-
+ cap names rather than terminfo capability names in their
+ respective tput commands.
+
+ Most implementations which provide support for capname op-
+ erands 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 func-
+ tion to analyze nonstandard capname operands. Other
+ implementations may simply guess that an operand contain-
+ ing only digits is intended to be a number.
-SEE ALSO
- clear(1), stty(1), tabs(1), terminfo(5).
+
+ clear(1), stty(1), tabs(1), terminfo(5), curs_termcap(3x).
- This describes ncurses version 5.9 (patch 20110404).
+ This describes ncurses version 5.9 (patch 20150215).
tput(1)
-
-
-Man(1) output converted with
-man2html
-
+