316 lines
9.5 KiB
HTML
316 lines
9.5 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta name="generator" content="HTML Tidy, see www.w3.org">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
|
|
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
|
|
<title>tput</title>
|
|
</head>
|
|
<body bgcolor="white">
|
|
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
|
|
</script>
|
|
|
|
<basefont size="3"> <a name="tput"></a> <a name="tag_04_144"></a><!-- tput -->
|
|
<!--header start-->
|
|
<center><font size="2">The Open Group Base Specifications Issue 6<br>
|
|
IEEE Std 1003.1-2001<br>
|
|
Copyright © 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
|
|
|
|
<!--header end-->
|
|
<hr size="2" noshade>
|
|
<h4><a name="tag_04_144_01"></a>NAME</h4>
|
|
|
|
<blockquote>tput - change terminal characteristics</blockquote>
|
|
|
|
<h4><a name="tag_04_144_02"></a>SYNOPSIS</h4>
|
|
|
|
<blockquote class="synopsis">
|
|
<div class="box"><code><tt><sup>[<a href="javascript:open_code('UP')">UP</a>]</sup> <img src="../images/opt-start.gif" alt=
|
|
"[Option Start]" border="0"> tput</tt> <b>[</b><tt>-T</tt> <i>type</i><b>]</b> <i>operand</i><tt>... <img src=
|
|
"../images/opt-end.gif" alt="[Option End]" border="0"></tt></code></div>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_144_03"></a>DESCRIPTION</h4>
|
|
|
|
<blockquote>
|
|
<p>The <i>tput</i> utility shall display terminal-dependent information. The manner in which this information is retrieved is
|
|
unspecified. The information displayed shall clear the terminal screen, initialize the user's terminal, or reset the user's
|
|
terminal, depending on the operand given. The exact consequences of displaying this information are unspecified.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_144_04"></a>OPTIONS</h4>
|
|
|
|
<blockquote>
|
|
<p>The <i>tput</i> utility shall conform to the Base Definitions volume of IEEE Std 1003.1-2001, <a href=
|
|
"../basedefs/xbd_chap12.html#tag_12_02">Section 12.2, Utility Syntax Guidelines</a>.</p>
|
|
|
|
<p>The following option shall be supported:</p>
|
|
|
|
<dl compact>
|
|
<dt><b>-T </b> <i>type</i></dt>
|
|
|
|
<dd>Indicate the type of terminal. If this option is not supplied and the <i>TERM</i> variable is unset or null, an unspecified
|
|
default terminal type shall be used. The setting of <i>type</i> shall take precedence over the value in <i>TERM .</i></dd>
|
|
</dl>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_144_05"></a>OPERANDS</h4>
|
|
|
|
<blockquote>
|
|
<p>The following strings shall be supported as operands by the implementation in the POSIX locale:</p>
|
|
|
|
<dl compact>
|
|
<dt><b>clear</b></dt>
|
|
|
|
<dd>Display the clear-screen sequence.</dd>
|
|
|
|
<dt><b>init</b></dt>
|
|
|
|
<dd>Display the sequence that initializes the user's terminal in an implementation-defined manner.</dd>
|
|
|
|
<dt><b>reset</b></dt>
|
|
|
|
<dd>Display the sequence that resets the user's terminal in an implementation-defined manner.</dd>
|
|
</dl>
|
|
|
|
<p>If a terminal does not support any of the operations described by these operands, this shall not be considered an error
|
|
condition.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_144_06"></a>STDIN</h4>
|
|
|
|
<blockquote>
|
|
<p>Not used.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_144_07"></a>INPUT FILES</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_144_08"></a>ENVIRONMENT VARIABLES</h4>
|
|
|
|
<blockquote>
|
|
<p>The following environment variables shall affect the execution of <i>tput</i>:</p>
|
|
|
|
<dl compact>
|
|
<dt><i>LANG</i></dt>
|
|
|
|
<dd>Provide a default value for the internationalization variables that are unset or null. (See the Base Definitions volume of
|
|
IEEE Std 1003.1-2001, <a href="../basedefs/xbd_chap08.html#tag_08_02">Section 8.2, Internationalization Variables</a> for
|
|
the precedence of internationalization variables used to determine the values of locale categories.)</dd>
|
|
|
|
<dt><i>LC_ALL</i></dt>
|
|
|
|
<dd>If set to a non-empty string value, override the values of all the other internationalization variables.</dd>
|
|
|
|
<dt><i>LC_CTYPE</i></dt>
|
|
|
|
<dd>Determine the locale for the interpretation of sequences of bytes of text data as characters (for example, single-byte as
|
|
opposed to multi-byte characters in arguments).</dd>
|
|
|
|
<dt><i>LC_MESSAGES</i></dt>
|
|
|
|
<dd>Determine the locale that should be used to affect the format and contents of diagnostic messages written to standard
|
|
error.</dd>
|
|
|
|
<dt><i>NLSPATH</i></dt>
|
|
|
|
<dd><sup>[<a href="javascript:open_code('XSI')">XSI</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
|
|
Determine the location of message catalogs for the processing of <i>LC_MESSAGES .</i> <img src="../images/opt-end.gif" alt=
|
|
"[Option End]" border="0"></dd>
|
|
|
|
<dt><i>TERM</i></dt>
|
|
|
|
<dd>Determine the terminal type. If this variable is unset or null, and if the <b>-T</b> option is not specified, an unspecified
|
|
default terminal type shall be used.</dd>
|
|
</dl>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_144_09"></a>ASYNCHRONOUS EVENTS</h4>
|
|
|
|
<blockquote>
|
|
<p>Default.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_144_10"></a>STDOUT</h4>
|
|
|
|
<blockquote>
|
|
<p>If standard output is a terminal device, it may be used for writing the appropriate sequence to clear the screen or reset or
|
|
initialize the terminal. If standard output is not a terminal device, undefined results occur.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_144_11"></a>STDERR</h4>
|
|
|
|
<blockquote>
|
|
<p>The standard error shall be used only for diagnostic messages.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_144_12"></a>OUTPUT FILES</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_144_13"></a>EXTENDED DESCRIPTION</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_144_14"></a>EXIT STATUS</h4>
|
|
|
|
<blockquote>
|
|
<p>The following exit values shall be returned:</p>
|
|
|
|
<dl compact>
|
|
<dt> 0</dt>
|
|
|
|
<dd>The requested string was written successfully.</dd>
|
|
|
|
<dt> 1</dt>
|
|
|
|
<dd>Unspecified.</dd>
|
|
|
|
<dt> 2</dt>
|
|
|
|
<dd>Usage error.</dd>
|
|
|
|
<dt> 3</dt>
|
|
|
|
<dd>No information is available about the specified terminal type.</dd>
|
|
|
|
<dt> 4</dt>
|
|
|
|
<dd>The specified operand is invalid.</dd>
|
|
|
|
<dt>>4</dt>
|
|
|
|
<dd>An error occurred.</dd>
|
|
</dl>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_144_15"></a>CONSEQUENCES OF ERRORS</h4>
|
|
|
|
<blockquote>
|
|
<p>If one of the operands is not available for the terminal, <i>tput</i> continues processing the remaining operands.</p>
|
|
</blockquote>
|
|
|
|
<hr>
|
|
<div class="box"><em>The following sections are informative.</em></div>
|
|
|
|
<h4><a name="tag_04_144_16"></a>APPLICATION USAGE</h4>
|
|
|
|
<blockquote>
|
|
<p>The difference between resetting and initializing a terminal is left unspecified, as they vary greatly based on hardware types.
|
|
In general, resetting is a more severe action.</p>
|
|
|
|
<p>Some terminals use control characters to perform the stated functions, and on such terminals it might make sense to use
|
|
<i>tput</i> to store the initialization strings in a file or environment variable for later use. However, because other terminals
|
|
might rely on system calls to do this work, the standard output cannot be used in a portable manner, such as the following
|
|
non-portable constructs:</p>
|
|
|
|
<pre>
|
|
<tt>ClearVar=`tput clear`
|
|
tput reset | mailx -s "Wake Up" ddg
|
|
</tt>
|
|
</pre>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_144_17"></a>EXAMPLES</h4>
|
|
|
|
<blockquote>
|
|
<ol>
|
|
<li>
|
|
<p>Initialize the terminal according to the type of terminal in the environmental variable <i>TERM .</i> This command can be
|
|
included in a <b>.profile</b> file.</p>
|
|
|
|
<pre>
|
|
<tt>tput init
|
|
</tt>
|
|
</pre>
|
|
</li>
|
|
|
|
<li>
|
|
<p>Reset a 450 terminal.</p>
|
|
|
|
<pre>
|
|
<tt>tput -T 450 reset
|
|
</tt>
|
|
</pre>
|
|
</li>
|
|
</ol>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_144_18"></a>RATIONALE</h4>
|
|
|
|
<blockquote>
|
|
<p>The list of operands was reduced to a minimum for the following reasons:</p>
|
|
|
|
<ul>
|
|
<li>
|
|
<p>The only features chosen were those that were likely to be used by human users interacting with a terminal.</p>
|
|
</li>
|
|
|
|
<li>
|
|
<p>Specifying the full <i>terminfo</i> set was not considered desirable, but the standard developers did not want to select among
|
|
operands.</p>
|
|
</li>
|
|
|
|
<li>
|
|
<p>This volume of IEEE Std 1003.1-2001 does not attempt to provide applications with sophisticated terminal handling
|
|
capabilities, as that falls outside of its assigned scope and intersects with the responsibilities of other standards bodies.</p>
|
|
</li>
|
|
</ul>
|
|
|
|
<p>The difference between resetting and initializing a terminal is left unspecified as this varies greatly based on hardware types.
|
|
In general, resetting is a more severe action.</p>
|
|
|
|
<p>The exit status of 1 is historically reserved for finding out if a Boolean operand is not set. Although the operands were
|
|
reduced to a minimum, the exit status of 1 should still be reserved for the Boolean operands, for those sites that wish to support
|
|
them.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_144_19"></a>FUTURE DIRECTIONS</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_144_20"></a>SEE ALSO</h4>
|
|
|
|
<blockquote>
|
|
<p><a href="stty.html"><i>stty</i></a> , <a href="tabs.html"><i>tabs</i></a></p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_144_21"></a>CHANGE HISTORY</h4>
|
|
|
|
<blockquote>
|
|
<p>First released in Issue 4.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_144_22"></a>Issue 6</h4>
|
|
|
|
<blockquote>
|
|
<p>This utility is marked as part of the User Portability Utilities option.</p>
|
|
</blockquote>
|
|
|
|
<div class="box"><em>End of informative text.</em></div>
|
|
|
|
<hr>
|
|
<hr size="2" noshade>
|
|
<center><font size="2"><!--footer start-->
|
|
UNIX ® is a registered Trademark of The Open Group.<br>
|
|
POSIX ® is a registered Trademark of The IEEE.<br>
|
|
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
|
|
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
|
|
]</font></center>
|
|
|
|
<!--footer end-->
|
|
<hr size="2" noshade>
|
|
</body>
|
|
</html>
|
|
|