-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<!--
* t
****************************************************************************
- * Copyright (c) 1998-2002,2003 Free Software Foundation, Inc. *
+ * 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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: tput.1,v 1.20 2003/05/11 00:32:53 tom Exp @
+ * @Id: tput.1,v 1.32 2012/07/14 21:06:45 tom Exp @
-->
<HTML>
<HEAD>
<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
-<STRONG><A HREF="tput.1.html">tput(1)</A></STRONG> <STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>
+<STRONG><A HREF="tput.1.html">tput(1)</A></STRONG> <STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>
<H2>DESCRIPTION</H2><PRE>
The <STRONG>tput</STRONG> utility uses the <STRONG>terminfo</STRONG> database to make the
values of terminal-dependent capabilities and information
- available to the shell (see <STRONG><A HREF="sh.1.html">sh(1)</A></STRONG>), to initialize or reset
+ available to the shell (see <STRONG>sh(1)</STRONG>), to initialize or reset
the terminal, or return the long name of the requested
- terminal type. <STRONG>tput</STRONG> outputs a string if the attribute
- (<EM>cap</EM>ability <EM>name</EM>) is of type string, or an integer if the
- attribute is of type integer. If the attribute is of type
- boolean, <STRONG>tput</STRONG> simply sets the exit code (<STRONG>0</STRONG> for TRUE if the
- terminal has the capability, <STRONG>1</STRONG> for FALSE if it does not),
- and produces no output. Before using a value returned on
- standard output, the user should test the exit code [<STRONG>$?</STRONG>,
- see <STRONG><A HREF="sh.1.html">sh(1)</A></STRONG>] to be sure it is <STRONG>0</STRONG>. (See the <STRONG>EXIT</STRONG> <STRONG>CODES</STRONG> and
- <STRONG>DIAGNOSTICS</STRONG> sections.) For a complete list of capabili-
- ties and the <EM>capname</EM> associated with each, see <STRONG>ter-</STRONG>
- <STRONG><A HREF="terminfo.1.html">minfo(1)</A></STRONG>.
+ terminal type. The result depends upon the capability's
+ type:
+
+ string
+ <STRONG>tput</STRONG> writes the string to the standard output.
+ No trailing newline is supplied.
+
+ integer
+ <STRONG>tput</STRONG> writes the decimal value to the standard
+ output, with a trailing newline.
+
+ boolean
+ <STRONG>tput</STRONG> simply sets the exit code (<STRONG>0</STRONG> for TRUE if
+ the terminal has the capability, <STRONG>1</STRONG> for FALSE
+ if it does not), and writes nothing to the
+ standard output.
+
+ Before using a value returned on the standard output, the
+ application should test the exit code (e.g., <STRONG>$?</STRONG>, see
+ <STRONG>sh(1)</STRONG>) to be sure it is <STRONG>0</STRONG>. (See the <STRONG>EXIT</STRONG> <STRONG>CODES</STRONG> and <STRONG>DIAG-</STRONG>
+ <STRONG>NOSTICS</STRONG> sections.) For a complete list of capabilities
+ and the <EM>capname</EM> associated with each, see <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
<STRONG>-T</STRONG><EM>type</EM> indicates the <EM>type</EM> of terminal. Normally this
option is unnecessary, because the default is taken
from the environment variable <STRONG>TERM</STRONG>. If <STRONG>-T</STRONG> is spec-
ified, then the shell variables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG>
- will be ignored,and the operating system will not
- be queried for the actual screen size.
+ will also be ignored.
<EM>capname</EM>
- indicates the attribute from the <STRONG>terminfo</STRONG> database.
- When <STRONG>termcap</STRONG> support is compiled in, the <STRONG>termcap</STRONG>
- name for the attribute is also accepted.
-
- <EM>parms</EM> If the attribute is a string that takes parameters,
- the arguments <EM>parms</EM> will be instantiated into the
- string. An all-numeric argument will be passed to
- the attribute as a number.
-
- Only a few terminfo capabilities require string
- parameters; <STRONG>tput</STRONG> uses a table to decide which to
- pass as strings. Normally <STRONG>tput</STRONG> uses <STRONG>tparm</STRONG> (3x) to
- perform the substitution. If no parameters are
- given for the attribute, <STRONG>tput</STRONG> writes the string
- without performing the substitution.
-
- <STRONG>-S</STRONG> allows more than one capability per invocation of
+ indicates the capability from the <STRONG>terminfo</STRONG> data-
+ base. When <STRONG>termcap</STRONG> support is compiled in, the
+ <STRONG>termcap</STRONG> name for the capability is also accepted.
+
+ <EM>parms</EM> If the capability is a string that takes parame-
+ ters, the arguments <EM>parms</EM> will be instantiated into
+ the string.
+
+ Most parameters are numbers. Only a few terminfo
+ capabilities require string parameters; <STRONG>tput</STRONG> uses a
+ table to decide which to pass as strings. Normally
+ <STRONG>tput</STRONG> uses <STRONG>tparm</STRONG> (3x) to perform the substitution.
+ If no parameters are given for the capability, <STRONG>tput</STRONG>
+ writes the string without performing the substitu-
+ tion.
+
+ <STRONG>-S</STRONG> allows more than one capability per invocation of
<STRONG>tput</STRONG>. The capabilities must be passed to <STRONG>tput</STRONG> from
the standard input instead of from the command line
- (see example). Only one <EM>capname</EM> is allowed per
- line. The <STRONG>-S</STRONG> option changes the meaning of the <STRONG>0</STRONG>
- and <STRONG>1</STRONG> boolean and string exit codes (see the EXIT
+ (see example). Only one <EM>capname</EM> is allowed per
+ line. The <STRONG>-S</STRONG> option changes the meaning of the <STRONG>0</STRONG>
+ and <STRONG>1</STRONG> boolean and string exit codes (see the EXIT
CODES section).
- Again, <STRONG>tput</STRONG> uses a table and the presence of
- parameters in its input to decide whether to use
- <STRONG>tparm</STRONG> (3x), and how to interpret the parameters.
+ Again, <STRONG>tput</STRONG> uses a table and the presence of param-
+ eters in its input to decide whether to use <STRONG>tparm</STRONG>
+ (3x), and how to interpret the parameters.
- <STRONG>-V</STRONG> reports the version of ncurses which was used in
+ <STRONG>-V</STRONG> reports the version of ncurses which was used in
this program, and exits.
- <STRONG>init</STRONG> If the <STRONG>terminfo</STRONG> database is present and an entry
+ <STRONG>init</STRONG> If the <STRONG>terminfo</STRONG> database is present and an entry
for the user's terminal exists (see <STRONG>-T</STRONG><EM>type</EM>, above),
- the following will occur: (1) if present, the ter-
- minal's initialization strings will be output (<STRONG>is1</STRONG>,
- <STRONG>is2</STRONG>, <STRONG>is3</STRONG>, <STRONG>if</STRONG>, <STRONG>iprog</STRONG>), (2) any delays (e.g., new-
- line) specified in the entry will be set in the tty
- driver, (3) tabs expansion will be turned on or off
- according to the specification in the entry, and
- (4) if tabs are not expanded, standard tabs will be
- set (every 8 spaces). If an entry does not contain
- the information needed for any of the four above
- activities, that activity will silently be skipped.
+ the following will occur:
+
+ (1) if present, the terminal's initialization
+ strings will be output as detailed in the
+ <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> section on <EM>Tabs</EM> <EM>and</EM> <EM>Initializa-</EM>
+ <EM>tion</EM>,
+
+ (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
+ according to the specification in the entry,
+ and
+
+ (4) if tabs are not expanded, standard tabs will
+ be set (every 8 spaces).
+
+ If an entry does not contain the information needed
+ for any of the four above activities, that activity
+ will silently be skipped.
<STRONG>reset</STRONG> Instead of putting out initialization strings, the
terminal's reset strings will be output if present
minal in the environmental variable <STRONG>TERM</STRONG>. This com-
mand should be included in everyone's .profile after
the environmental variable <STRONG>TERM</STRONG> has been exported, as
- illustrated on the <STRONG><A HREF="profile.5.html">profile(5)</A></STRONG> manual page.
+ illustrated on the <STRONG>profile(5)</STRONG> manual page.
<STRONG>tput</STRONG> <STRONG>-T5620</STRONG> <STRONG>reset</STRONG>
Reset an AT&T 5620 terminal, overriding the type of
<STRONG>bold=`tput</STRONG> <STRONG>smso`</STRONG> <STRONG>offbold=`tput</STRONG> <STRONG>rmso`</STRONG>
Set the shell variables <STRONG>bold</STRONG>, to begin stand-out mode
sequence, and <STRONG>offbold</STRONG>, to end standout mode sequence,
- for the current terminal. This might be followed by
- a prompt: <STRONG>echo</STRONG> <STRONG>"${bold}Please</STRONG> <STRONG>type</STRONG> <STRONG>in</STRONG> <STRONG>your</STRONG> <STRONG>name:</STRONG>
+ for the current terminal. This might be followed by
+ a prompt: <STRONG>echo</STRONG> <STRONG>"${bold}Please</STRONG> <STRONG>type</STRONG> <STRONG>in</STRONG> <STRONG>your</STRONG> <STRONG>name:</STRONG>
<STRONG>${offbold}\c"</STRONG>
<STRONG>tput</STRONG> <STRONG>hc</STRONG>
- Set exit code to indicate if the current terminal is
+ Set exit code to indicate if the current terminal is
a hard copy terminal.
<STRONG>tput</STRONG> <STRONG>cup</STRONG> <STRONG>23</STRONG> <STRONG>4</STRONG>
- Send the sequence to move the cursor to row 23, col-
+ Send the sequence to move the cursor to row 23, col-
umn 4.
<STRONG>tput</STRONG> <STRONG>cup</STRONG>
parameters substituted.
<STRONG>tput</STRONG> <STRONG>longname</STRONG>
- Print the long name from the <STRONG>terminfo</STRONG> database for
- the type of terminal specified in the environmental
+ Print the long name from the <STRONG>terminfo</STRONG> database for
+ the type of terminal specified in the environmental
variable <STRONG>TERM</STRONG>.
<STRONG>tput</STRONG> <STRONG>-S</STRONG> <STRONG><<!</STRONG>
<STRONG>></STRONG> <STRONG>bold</STRONG>
<STRONG>></STRONG> <STRONG>!</STRONG>
- This example shows <STRONG>tput</STRONG> processing several capabili-
- ties 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
+ This example shows <STRONG>tput</STRONG> processing several capabili-
+ ties 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 (<STRONG>!</STRONG>) on a line by itself.
<STRONG>/usr/share/terminfo</STRONG>
compiled terminal description database
- <STRONG>/usr/include/curses.h</STRONG>
- <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> header file
-
- <STRONG>/usr/include/term.h</STRONG>
- <STRONG>terminfo</STRONG> header file
-
<STRONG>/usr/share/tabset/*</STRONG>
tab settings for some terminals, in a format appro-
- priate to be output to the terminal (escape
- sequences that set margins and tabs); for more
+ priate to be output to the terminal (escape
+ sequences that set margins and tabs); for more
information, see the "Tabs and Initialization" sec-
tion of <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
</PRE>
<H2>EXIT CODES</H2><PRE>
If the <STRONG>-S</STRONG> option is used, <STRONG>tput</STRONG> 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 <STRONG>0</STRONG>. No indication of which
+ 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 <STRONG>0</STRONG>. No indication of which
line failed can be given so exit code <STRONG>1</STRONG> will never appear.
- Exit codes <STRONG>2</STRONG>, <STRONG>3</STRONG>, and <STRONG>4</STRONG> retain their usual interpretation.
+ Exit codes <STRONG>2</STRONG>, <STRONG>3</STRONG>, and <STRONG>4</STRONG> retain their usual interpretation.
If the <STRONG>-S</STRONG> option is not used, the exit code depends on the
type of <EM>capname</EM>:
<EM>boolean</EM>
- a value of <STRONG>0</STRONG> is set for TRUE and <STRONG>1</STRONG> for FALSE.
+ a value of <STRONG>0</STRONG> is set for TRUE and <STRONG>1</STRONG> for FALSE.
<EM>string</EM> a value of <STRONG>0</STRONG> is set if the <EM>capname</EM> is defined
for this terminal <EM>type</EM> (the value of <EM>capname</EM>
exit code error message
---------------------------------------------------------------------
<STRONG>0</STRONG> (<EM>capname</EM> is a numeric variable that is not specified in
- the <STRONG><A HREF="terminfo.1.html">terminfo(1)</A></STRONG> database for this terminal type, e.g.
+ the <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> database for this terminal type, e.g.
<STRONG>tput</STRONG> <STRONG>-T450</STRONG> <STRONG>lines</STRONG> and <STRONG>tput</STRONG> <STRONG>-T2621</STRONG> <STRONG>xmc</STRONG>)
<STRONG>1</STRONG> no error message is printed, see the <STRONG>EXIT</STRONG> <STRONG>CODES</STRONG> section.
<STRONG>2</STRONG> usage error
tion features used in the <STRONG>cup</STRONG> example, are not supported
in BSD curses or in AT&T/USL curses before SVr4.
+ X/Open documents only the operands for <STRONG>clear</STRONG>, <STRONG>init</STRONG> and
+ <STRONG>reset</STRONG>. In this implementation, <STRONG>clear</STRONG> is part of the <EM>cap-</EM>
+ <EM>name</EM> support. Other implementations of <STRONG>tput</STRONG> on SVr4-based
+ systems such as Solaris, IRIX64 and HPUX as well as others
+ such as AIX and Tru64 provide support for <EM>capname</EM> oper-
+ ands.
+
+ A few platforms such as FreeBSD and NetBSD recognize term-
+ cap names rather than terminfo capability names in their
+ respective <STRONG>tput</STRONG> commands.
+
+ Most implementations which provide support for <EM>capname</EM> op-
+ erands use the <EM>tparm</EM> function to expand parameters in it.
+ That function expects a mixture of numeric and string
+ parameters, requiring <STRONG>tput</STRONG> to know which type to use.
+ This implementation uses a table to determine that for the
+ standard <EM>capname</EM> operands, and an internal library func-
+ tion to analyze nonstandard <EM>capname</EM> operands. Other
+ implementations may simply guess that an operand contain-
+ ing only digits is intended to be a number.
+
</PRE>
<H2>SEE ALSO</H2><PRE>
- <STRONG><A HREF="clear.1.html">clear(1)</A></STRONG>, <STRONG><A HREF="stty.1.html">stty(1)</A></STRONG>, <STRONG><A HREF="tabs.1.html">tabs(1)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
+ <STRONG><A HREF="clear.1.html">clear(1)</A></STRONG>, <STRONG>stty(1)</STRONG>, <STRONG><A HREF="tabs.1.html">tabs(1)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>, <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>.
+
+ This describes <STRONG>ncurses</STRONG> version 5.9 (patch 20141220).
- <STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>
+ <STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>
</PRE>
<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a>
</BODY>
</HTML>