2002-10-13 11:35:53 +08:00
|
|
|
<!--
|
|
|
|
|
* t
|
|
|
|
|
****************************************************************************
|
2013-03-10 08:35:23 +08:00
|
|
|
* Copyright (c) 1998-2011,2012 Free Software Foundation, Inc. *
|
2002-10-13 11:35:53 +08:00
|
|
|
* *
|
|
|
|
|
* 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. *
|
|
|
|
|
****************************************************************************
|
2013-03-10 08:35:23 +08:00
|
|
|
* @Id: tput.1,v 1.32 2012/07/14 21:06:45 tom Exp @
|
2002-10-13 11:35:53 +08:00
|
|
|
-->
|
2015-02-15 09:42:27 +08:00
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
|
2000-07-09 10:46:08 +08:00
|
|
|
<HTML>
|
2002-10-13 11:35:53 +08:00
|
|
|
<HEAD>
|
2015-02-15 09:42:27 +08:00
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
|
|
|
|
|
<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
|
2002-10-13 11:35:53 +08:00
|
|
|
<TITLE>tput 1</TITLE>
|
|
|
|
|
<link rev=made href="mailto:bug-ncurses@gnu.org">
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
|
|
|
</HEAD>
|
2000-07-09 10:46:08 +08:00
|
|
|
<BODY>
|
2015-05-17 05:01:22 +08:00
|
|
|
<H1 class="no-header">tput 1</H1>
|
2000-07-09 10:46:08 +08:00
|
|
|
<PRE>
|
2005-10-10 02:41:57 +08:00
|
|
|
<STRONG><A HREF="tput.1.html">tput(1)</A></STRONG> <STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>
|
2004-02-09 10:15:26 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>tput</STRONG>, <STRONG>reset</STRONG> - initialize a terminal or query terminfo
|
2000-10-21 12:42:11 +08:00
|
|
|
database
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>tput</STRONG> [<STRONG>-T</STRONG><EM>type</EM>] <EM>capname</EM> [<EM>parms</EM> ... ]
|
|
|
|
|
<STRONG>tput</STRONG> [<STRONG>-T</STRONG><EM>type</EM>] <STRONG>init</STRONG>
|
|
|
|
|
<STRONG>tput</STRONG> [<STRONG>-T</STRONG><EM>type</EM>] <STRONG>reset</STRONG>
|
|
|
|
|
<STRONG>tput</STRONG> [<STRONG>-T</STRONG><EM>type</EM>] <STRONG>longname</STRONG>
|
|
|
|
|
<STRONG>tput</STRONG> <STRONG>-S</STRONG> <STRONG><<</STRONG>
|
|
|
|
|
<STRONG>tput</STRONG> <STRONG>-V</STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
The <STRONG>tput</STRONG> utility uses the <STRONG>terminfo</STRONG> database to make the
|
2000-10-21 12:42:11 +08:00
|
|
|
values of terminal-dependent capabilities and information
|
2013-12-22 07:12:46 +08:00
|
|
|
available to the shell (see <STRONG>sh(1)</STRONG>), to initialize or reset
|
2000-10-21 12:42:11 +08:00
|
|
|
the terminal, or return the long name of the requested
|
2005-10-10 02:41:57 +08:00
|
|
|
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
|
2013-12-22 07:12:46 +08:00
|
|
|
<STRONG>sh(1)</STRONG>) to be sure it is <STRONG>0</STRONG>. (See the <STRONG>EXIT</STRONG> <STRONG>CODES</STRONG> and <STRONG>DIAG-</STRONG>
|
2005-10-10 02:41:57 +08:00
|
|
|
<STRONG>NOSTICS</STRONG> sections.) For a complete list of capabilities
|
2006-12-24 10:11:39 +08:00
|
|
|
and the <EM>capname</EM> associated with each, see <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>-T</STRONG><EM>type</EM> indicates the <EM>type</EM> of terminal. Normally this
|
2000-07-09 10:46:08 +08:00
|
|
|
option is unnecessary, because the default is taken
|
2002-10-13 11:35:53 +08:00
|
|
|
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>
|
2013-03-10 08:35:23 +08:00
|
|
|
will also be ignored.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
<EM>capname</EM>
|
2013-03-10 08:35:23 +08:00
|
|
|
indicates the capability from the <STRONG>terminfo</STRONG> data-
|
|
|
|
|
base. When <STRONG>termcap</STRONG> support is compiled in, the
|
2005-10-10 02:41:57 +08:00
|
|
|
<STRONG>termcap</STRONG> name for the capability is also accepted.
|
|
|
|
|
|
2013-03-10 08:35:23 +08:00
|
|
|
<EM>parms</EM> If the capability is a string that takes parame-
|
2005-10-10 02:41:57 +08:00
|
|
|
ters, the arguments <EM>parms</EM> will be instantiated into
|
|
|
|
|
the string.
|
|
|
|
|
|
2013-03-10 08:35:23 +08:00
|
|
|
Most parameters are numbers. Only a few terminfo
|
2005-10-10 02:41:57 +08:00
|
|
|
capabilities require string parameters; <STRONG>tput</STRONG> uses a
|
|
|
|
|
table to decide which to pass as strings. Normally
|
2013-03-10 08:35:23 +08:00
|
|
|
<STRONG>tput</STRONG> uses <STRONG>tparm</STRONG> (3x) to perform the substitution.
|
2005-10-10 02:41:57 +08:00
|
|
|
If no parameters are given for the capability, <STRONG>tput</STRONG>
|
2013-03-10 08:35:23 +08:00
|
|
|
writes the string without performing the substitu-
|
|
|
|
|
tion.
|
2002-10-13 11:35:53 +08:00
|
|
|
|
2013-03-10 08:35:23 +08:00
|
|
|
<STRONG>-S</STRONG> allows more than one capability per invocation of
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>tput</STRONG>. The capabilities must be passed to <STRONG>tput</STRONG> from
|
2000-07-09 10:46:08 +08:00
|
|
|
the standard input instead of from the command line
|
2013-03-10 08:35:23 +08:00
|
|
|
(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
|
2000-07-09 10:46:08 +08:00
|
|
|
CODES section).
|
|
|
|
|
|
2005-10-10 02:41:57 +08:00
|
|
|
Again, <STRONG>tput</STRONG> uses a table and the presence of param-
|
2013-03-10 08:35:23 +08:00
|
|
|
eters in its input to decide whether to use <STRONG>tparm</STRONG>
|
2005-10-10 02:41:57 +08:00
|
|
|
(3x), and how to interpret the parameters.
|
2002-10-13 11:35:53 +08:00
|
|
|
|
2013-03-10 08:35:23 +08:00
|
|
|
<STRONG>-V</STRONG> reports the version of ncurses which was used in
|
2000-10-21 12:42:11 +08:00
|
|
|
this program, and exits.
|
|
|
|
|
|
2013-03-10 08:35:23 +08:00
|
|
|
<STRONG>init</STRONG> If the <STRONG>terminfo</STRONG> database is present and an entry
|
2002-10-13 11:35:53 +08:00
|
|
|
for the user's terminal exists (see <STRONG>-T</STRONG><EM>type</EM>, above),
|
2006-12-18 12:32:42 +08:00
|
|
|
the following will occur:
|
|
|
|
|
|
2013-03-10 08:35:23 +08:00
|
|
|
(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>
|
2006-12-18 12:32:42 +08:00
|
|
|
<EM>tion</EM>,
|
|
|
|
|
|
2013-03-10 08:35:23 +08:00
|
|
|
(2) any delays (e.g., newline) specified in the
|
2006-12-18 12:32:42 +08:00
|
|
|
entry will be set in the tty driver,
|
|
|
|
|
|
2013-03-10 08:35:23 +08:00
|
|
|
(3) tabs expansion will be turned on or off
|
2006-12-18 12:32:42 +08:00
|
|
|
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.
|
|
|
|
|
|
2013-03-10 08:35:23 +08:00
|
|
|
<STRONG>reset</STRONG> Instead of putting out initialization strings, the
|
|
|
|
|
terminal's reset strings will be output if present
|
|
|
|
|
(<STRONG>rs1</STRONG>, <STRONG>rs2</STRONG>, <STRONG>rs3</STRONG>, <STRONG>rf</STRONG>). If the reset strings are not
|
|
|
|
|
present, but initialization strings are, the ini-
|
|
|
|
|
tialization strings will be output. Otherwise,
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>reset</STRONG> acts identically to <STRONG>init</STRONG>.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>longname</STRONG>
|
2013-03-10 08:35:23 +08:00
|
|
|
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),
|
2000-07-09 10:46:08 +08:00
|
|
|
then the long name of the terminal will be put out.
|
|
|
|
|
The long name is the last name in the first line of
|
2002-10-13 11:35:53 +08:00
|
|
|
the terminal's description in the <STRONG>terminfo</STRONG> database
|
|
|
|
|
[see <STRONG><A HREF="term.5.html">term(5)</A></STRONG>].
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2013-03-10 08:35:23 +08:00
|
|
|
If <STRONG>tput</STRONG> is invoked by a link named <STRONG>reset</STRONG>, this has the
|
2002-10-13 11:35:53 +08:00
|
|
|
same effect as <STRONG>tput</STRONG> <STRONG>reset</STRONG>. See <STRONG>tset</STRONG> for comparison, which
|
2000-10-21 12:42:11 +08:00
|
|
|
has similar behavior.
|
|
|
|
|
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H2><a name="h2-EXAMPLES">EXAMPLES</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>tput</STRONG> <STRONG>init</STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
Initialize the terminal according to the type of ter-
|
2013-03-10 08:35:23 +08:00
|
|
|
minal in the environmental variable <STRONG>TERM</STRONG>. This com-
|
|
|
|
|
mand should be included in everyone's .profile after
|
2002-10-13 11:35:53 +08:00
|
|
|
the environmental variable <STRONG>TERM</STRONG> has been exported, as
|
2013-12-22 07:12:46 +08:00
|
|
|
illustrated on the <STRONG>profile(5)</STRONG> manual page.
|
2002-10-13 11:35:53 +08:00
|
|
|
|
|
|
|
|
<STRONG>tput</STRONG> <STRONG>-T5620</STRONG> <STRONG>reset</STRONG>
|
2013-03-10 08:35:23 +08:00
|
|
|
Reset an AT&T 5620 terminal, overriding the type of
|
2002-10-13 11:35:53 +08:00
|
|
|
terminal in the environmental variable <STRONG>TERM</STRONG>.
|
|
|
|
|
|
|
|
|
|
<STRONG>tput</STRONG> <STRONG>cup</STRONG> <STRONG>0</STRONG> <STRONG>0</STRONG>
|
|
|
|
|
Send the sequence to move the cursor to row <STRONG>0</STRONG>, column
|
|
|
|
|
<STRONG>0</STRONG> (the upper left corner of the screen, usually known
|
2000-07-09 10:46:08 +08:00
|
|
|
as the "home" cursor position).
|
|
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>tput</STRONG> <STRONG>clear</STRONG>
|
|
|
|
|
Echo the clear-screen sequence for the current termi-
|
|
|
|
|
nal.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>tput</STRONG> <STRONG>cols</STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
Print the number of columns for the current terminal.
|
|
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>tput</STRONG> <STRONG>-T450</STRONG> <STRONG>cols</STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
Print the number of columns for the 450 terminal.
|
|
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
<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,
|
2011-02-27 04:51:01 +08:00
|
|
|
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>
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>${offbold}\c"</STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>tput</STRONG> <STRONG>hc</STRONG>
|
2011-02-27 04:51:01 +08:00
|
|
|
Set exit code to indicate if the current terminal is
|
2000-07-09 10:46:08 +08:00
|
|
|
a hard copy terminal.
|
|
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>tput</STRONG> <STRONG>cup</STRONG> <STRONG>23</STRONG> <STRONG>4</STRONG>
|
2011-02-27 04:51:01 +08:00
|
|
|
Send the sequence to move the cursor to row 23, col-
|
2000-07-09 10:46:08 +08:00
|
|
|
umn 4.
|
|
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>tput</STRONG> <STRONG>cup</STRONG>
|
|
|
|
|
Send the terminfo string for cursor-movement, with no
|
|
|
|
|
parameters substituted.
|
|
|
|
|
|
|
|
|
|
<STRONG>tput</STRONG> <STRONG>longname</STRONG>
|
2011-02-27 04:51:01 +08:00
|
|
|
Print the long name from the <STRONG>terminfo</STRONG> database for
|
|
|
|
|
the type of terminal specified in the environmental
|
2002-10-13 11:35:53 +08:00
|
|
|
variable <STRONG>TERM</STRONG>.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>tput</STRONG> <STRONG>-S</STRONG> <STRONG><<!</STRONG>
|
|
|
|
|
<STRONG>></STRONG> <STRONG>clear</STRONG>
|
|
|
|
|
<STRONG>></STRONG> <STRONG>cup</STRONG> <STRONG>10</STRONG> <STRONG>10</STRONG>
|
|
|
|
|
<STRONG>></STRONG> <STRONG>bold</STRONG>
|
|
|
|
|
<STRONG>></STRONG> <STRONG>!</STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2011-02-27 04:51:01 +08:00
|
|
|
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
|
2002-10-13 11:35:53 +08:00
|
|
|
exclamation mark (<STRONG>!</STRONG>) on a line by itself.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>/usr/share/terminfo</STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
compiled terminal description database
|
|
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>/usr/share/tabset/*</STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
tab settings for some terminals, in a format appro-
|
2011-02-27 04:51:01 +08:00
|
|
|
priate to be output to the terminal (escape
|
|
|
|
|
sequences that set margins and tabs); for more
|
2000-07-09 10:46:08 +08:00
|
|
|
information, see the "Tabs and Initialization" sec-
|
2002-10-13 11:35:53 +08:00
|
|
|
tion of <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H2><a name="h2-EXIT-CODES">EXIT CODES</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
If the <STRONG>-S</STRONG> option is used, <STRONG>tput</STRONG> checks for errors from each
|
2011-02-27 04:51:01 +08:00
|
|
|
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
|
2002-10-13 11:35:53 +08:00
|
|
|
line failed can be given so exit code <STRONG>1</STRONG> will never appear.
|
2011-02-27 04:51:01 +08:00
|
|
|
Exit codes <STRONG>2</STRONG>, <STRONG>3</STRONG>, and <STRONG>4</STRONG> retain their usual interpretation.
|
2002-10-13 11:35:53 +08:00
|
|
|
If the <STRONG>-S</STRONG> option is not used, the exit code depends on the
|
|
|
|
|
type of <EM>capname</EM>:
|
|
|
|
|
|
|
|
|
|
<EM>boolean</EM>
|
2013-03-10 08:35:23 +08:00
|
|
|
a value of <STRONG>0</STRONG> is set for TRUE and <STRONG>1</STRONG> for FALSE.
|
2002-10-13 11:35:53 +08:00
|
|
|
|
2013-03-10 08:35:23 +08:00
|
|
|
<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>
|
|
|
|
|
is returned on standard output); a value of <STRONG>1</STRONG>
|
2002-10-13 11:35:53 +08:00
|
|
|
is set if <EM>capname</EM> is not defined for this ter-
|
2013-03-10 08:35:23 +08:00
|
|
|
minal <EM>type</EM> (nothing is written to standard
|
2002-10-13 11:35:53 +08:00
|
|
|
output).
|
|
|
|
|
|
|
|
|
|
<EM>integer</EM>
|
2013-03-10 08:35:23 +08:00
|
|
|
a value of <STRONG>0</STRONG> is always set, whether or not
|
2002-10-13 11:35:53 +08:00
|
|
|
<EM>capname</EM> is defined for this terminal <EM>type</EM>. To
|
2013-03-10 08:35:23 +08:00
|
|
|
determine if <EM>capname</EM> is defined for this ter-
|
2002-10-13 11:35:53 +08:00
|
|
|
minal <EM>type</EM>, the user must test the value writ-
|
2013-03-10 08:35:23 +08:00
|
|
|
ten to standard output. A value of <STRONG>-1</STRONG> means
|
|
|
|
|
that <EM>capname</EM> is not defined for this terminal
|
2002-10-13 11:35:53 +08:00
|
|
|
<EM>type</EM>.
|
|
|
|
|
|
2013-03-10 08:35:23 +08:00
|
|
|
<EM>other</EM> <STRONG>reset</STRONG> or <STRONG>init</STRONG> may fail to find their respec-
|
|
|
|
|
tive files. In that case, the exit code is
|
2002-10-13 11:35:53 +08:00
|
|
|
set to 4 + <STRONG>errno</STRONG>.
|
|
|
|
|
|
2013-03-10 08:35:23 +08:00
|
|
|
Any other exit code indicates an error; see the DIAGNOS-
|
2000-07-09 10:46:08 +08:00
|
|
|
TICS section.
|
|
|
|
|
|
|
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H2><a name="h2-DIAGNOSTICS">DIAGNOSTICS</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>tput</STRONG> prints the following error messages and sets the cor-
|
2000-07-09 10:46:08 +08:00
|
|
|
responding exit codes.
|
|
|
|
|
|
|
|
|
|
exit code error message
|
2000-10-21 12:42:11 +08:00
|
|
|
---------------------------------------------------------------------
|
2013-03-10 08:35:23 +08:00
|
|
|
<STRONG>0</STRONG> (<EM>capname</EM> is a numeric variable that is not specified in
|
|
|
|
|
the <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> database for this terminal type, e.g.
|
2002-10-13 11:35:53 +08:00
|
|
|
<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
|
|
|
|
|
<STRONG>3</STRONG> unknown terminal <EM>type</EM> or no <STRONG>terminfo</STRONG> database
|
|
|
|
|
<STRONG>4</STRONG> unknown <STRONG>terminfo</STRONG> capability <EM>capname</EM>
|
|
|
|
|
<STRONG>>4</STRONG> error occurred in -S
|
2000-10-21 12:42:11 +08:00
|
|
|
---------------------------------------------------------------------
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
2013-03-10 08:35:23 +08:00
|
|
|
The <STRONG>longname</STRONG> and <STRONG>-S</STRONG> options, and the parameter-substitu-
|
|
|
|
|
tion features used in the <STRONG>cup</STRONG> example, are not supported
|
2000-07-09 10:46:08 +08:00
|
|
|
in BSD curses or in AT&T/USL curses before SVr4.
|
2002-10-13 11:35:53 +08:00
|
|
|
|
2013-03-10 08:35:23 +08:00
|
|
|
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>
|
2006-12-18 12:32:42 +08:00
|
|
|
<EM>name</EM> support. Other implementations of <STRONG>tput</STRONG> on SVr4-based
|
|
|
|
|
systems such as Solaris, IRIX64 and HPUX as well as others
|
2013-03-10 08:35:23 +08:00
|
|
|
such as AIX and Tru64 provide support for <EM>capname</EM> oper-
|
|
|
|
|
ands.
|
2012-01-15 08:46:23 +08:00
|
|
|
|
|
|
|
|
A few platforms such as FreeBSD and NetBSD recognize term-
|
2013-03-10 08:35:23 +08:00
|
|
|
cap names rather than terminfo capability names in their
|
2012-01-15 08:46:23 +08:00
|
|
|
respective <STRONG>tput</STRONG> commands.
|
|
|
|
|
|
2013-03-10 08:35:23 +08:00
|
|
|
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.
|
2012-01-15 08:46:23 +08:00
|
|
|
This implementation uses a table to determine that for the
|
2013-03-10 08:35:23 +08:00
|
|
|
standard <EM>capname</EM> operands, and an internal library func-
|
2012-01-15 08:46:23 +08:00
|
|
|
tion to analyze nonstandard <EM>capname</EM> operands. Other
|
2013-03-10 08:35:23 +08:00
|
|
|
implementations may simply guess that an operand contain-
|
2012-01-15 08:46:23 +08:00
|
|
|
ing only digits is intended to be a number.
|
2006-12-18 12:32:42 +08:00
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
2013-12-22 07:12:46 +08:00
|
|
|
<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>.
|
2002-10-13 11:35:53 +08:00
|
|
|
|
2016-03-27 09:05:59 +08:00
|
|
|
This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20160326).
|
2006-12-18 12:32:42 +08:00
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
|
|
|
|
|
|
2005-10-10 02:41:57 +08:00
|
|
|
<STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<div class="nav">
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="#h2-NAME">NAME</a></li>
|
|
|
|
|
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
|
|
|
|
|
<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
|
|
|
|
|
<li><a href="#h2-EXAMPLES">EXAMPLES</a></li>
|
|
|
|
|
<li><a href="#h2-FILES">FILES</a></li>
|
|
|
|
|
<li><a href="#h2-EXIT-CODES">EXIT CODES</a></li>
|
|
|
|
|
<li><a href="#h2-DIAGNOSTICS">DIAGNOSTICS</a></li>
|
|
|
|
|
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
|
|
|
|
|
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
2000-07-09 10:46:08 +08:00
|
|
|
</BODY>
|
|
|
|
|
</HTML>
|
