ncurses 5.2
[ncurses.git] / man / tput.1
index 3dcb46804db667ec80964a1b0596144b669280e4..898df1e606f50a5527d6d6a34c5694f2bc5e1385 100644 (file)
@@ -1,9 +1,38 @@
 '\" t
+.\"***************************************************************************
+.\" Copyright (c) 1998,2000 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.16 2000/09/09 20:43:33 tom Exp $
 .TH tput 1 ""
-.ds d @DATADIR@/terminfo
+.ds d @TERMINFO@
 .ds n 5
 .SH NAME
-\fBtput\fR - initialize a terminal or query terminfo database
+\fBtput\fR, \fBreset\fR - initialize a terminal or query terminfo database
 .SH SYNOPSIS
 \fBtput\fR [\fB-T\fR\fItype\fR] \fIcapname\fR [\fIparms\fR ... ]
 .br
@@ -15,6 +44,8 @@
 .br
 \fBtput -S\fR  \fB<<\fR
 .br
+\fBtput -V\fR
+.br
 .SH DESCRIPTION
 The \fBtput\fR utility uses the \fBterminfo\fR database to make the
 values of terminal-dependent capabilities and information available to
@@ -26,19 +57,22 @@ the attribute is of type boolean, \fBtput\fR simply sets the exit code
 (\fB0\fR for TRUE if the terminal has the capability, \fB1\fR 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
-[\fB$?\fR, see \fBsh\fR(1)] to be sure it is \fB0\fR.  (See the \fBEXIT
-CODES\fR and \fBDIAGNOSTICS\fR sections.)  For a complete list of capabilities
+[\fB$?\fR, see \fBsh\fR(1)] to be sure it is \fB0\fR.
+(See the \fBEXIT CODES\fR and \fBDIAGNOSTICS\fR sections.)
+For a complete list of capabilities
 and the \fIcapname\fR associated with each, see \fBterminfo\fR(\*n).
 .TP
 \fB-T\fR\fItype\fR
 indicates the \fItype\fR of terminal.  Normally this option is
 unnecessary, because the default is taken from the environment
 variable \fBTERM\fR.  If \fB-T\fR is specified, then the shell
-variables \fBLINES\fR and \fBCOLUMNS\fR will be ignored,and the 
+variables \fBLINES\fR and \fBCOLUMNS\fR will be ignored,and the
 operating system will not be queried for the actual screen size.
 .TP
 \fIcapname\fR
-indicates the attribute from the \fBterminfo\fR database.
+indicates the attribute from the \fBterminfo\fR database.  When
+\fBtermcap\fR support is compiled in, the \fBtermcap\fR name for
+the attribute is also accepted.
 .TP
 \fIparms\fR
 If the attribute is a string that takes parameters, the arguments
@@ -53,6 +87,9 @@ instead of from the command line (see example).  Only one
 meaning of the \fB0\fR and \fB1\fR boolean and string exit codes (see the
 EXIT CODES section).
 .TP
+\fB-V\fR
+reports the version of ncurses which was used in this program, and exits.
+.TP
 \fBinit\fR
 If the \fBterminfo\fR database is present and an entry for the user's
 terminal exists (see \fB-T\fR\fItype\fR, above), the following will
@@ -78,6 +115,10 @@ user's terminal exists (see \fB-T\fR\fItype\fR 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
 \fBterminfo\fR database [see \fBterm\fR(5)].
+.PP
+If \fBtput\fR is invoked by a link named \fBreset\fR, this has the
+same effect as \fBtput reset\fR.
+See \fBtset\fR for comparison, which has similar behavior.
 .SH EXAMPLES
 .TP 5
 \fBtput init\fR
@@ -121,7 +162,8 @@ Send the sequence to move the cursor to row 23, column 4.
 Print the long name from the \fBterminfo\fR database for the
 type of terminal specified in the environmental
 variable \fBTERM\fR.
-.TP 0
+.PP
+.RS 5
 \fBtput -S <<!\fR
 .br
 \fB> clear\fR
@@ -131,6 +173,7 @@ variable \fBTERM\fR.
 \fB> bold\fR
 .br
 \fB> !\fR
+.RE
 .TP 5
 \&
 This example shows tput processing several capabilities in one
@@ -155,47 +198,51 @@ sequences that set margins and tabs); for more
 information, see the "Tabs and Initialization"
 section of \fBterminfo\fR(4)
 .SH SEE ALSO
-\fBclear\fR(1), \fBstty\fR(1), \fBtabs\fR(\*n).  \fBprofile\fR(\*n),
+\fB@CLEAR@\fR(1), \fBstty\fR(1), \fBtabs\fR(\*n).  \fBprofile\fR(\*n),
 \fBterminfo\fR(4) in the \fISystem\fR \fIAdministrator\fR'\fIs\fR
 \fIReference\fR \fIManual\fR.  Chapter 10 of the
 \fIProgrammer\fR'\fIs\fR \fIGuide\fR.
 .SH EXIT CODES
 If \fIcapname\fR is of type boolean, a value of \fB0\fR is set for
 TRUE and \fB1\fR for FALSE unless the \fB-S\fR option is used.
-
+.PP
 If \fIcapname\fR is of type string, a value of \fB0\fR is set if the
 \fIcapname\fR is defined for this terminal \fItype\fR (the value of
 \fIcapname\fR is returned on standard output); a value of \fB1\fR is
 set if \fIcapname\fR is not defined for this terminal \fItype\fR (a
 null value is returned on standard output).
-
+.PP
 If \fIcapname\fR is of type boolean or string and the \fB-S\fR option
 is used, a value of \fB0\fR is returned to indicate that all lines
 were successful.  No indication of which line failed can be given so
 exit code \fB1\fR will never appear.  Exit codes \fB2\fR, \fB3\fR, and
 \fB4\fR retain their usual interpretation.
-
+.PP
 If \fIcapname\fR is of type integer, a value of \fB0\fR is always set,
 whether or not \fIcapname\fR is defined for this terminal \fItype\fR.
 To determine if \fIcapname\fR is defined for this terminal \fItype\fR,
 the user must test the value of standard output.  A value of \fB-1\fR
 means that \fIcapname\fR is not defined for this terminal \fItype\fR.
-
+.PP
 Any other exit code indicates an error; see the DIAGNOSTICS section.
 .SH DIAGNOSTICS
 \fBtput\fR prints the following error messages and sets the corresponding exit
 codes.
-
+.PP
 .TS
 l l.
 exit code      error message
-\fB0\fR        (\fIcapname\fR is a numeric variable that is not specified in the
-       \fBterminfo\fR(\*n) database for this terminal type, e.g.
-       \fBtput -T450 lines\fR and \fBtput -T2621 xmc\fR)
+=
+\fB0\fR        T{
+(\fIcapname\fR is a numeric variable that is not specified in the
+\fBterminfo\fR(\*n) database for this terminal type, e.g.
+\fBtput -T450 lines\fR and \fBtput -T2621 xmc\fR)
+T}
 \fB1\fR        no error message is printed, see the \fBEXIT CODES\fR section.
 \fB2\fR        usage error
 \fB3\fR        unknown terminal \fItype\fR or no \fBterminfo\fR database
 \fB4\fR        unknown \fBterminfo\fR capability \fIcapname\fR
+=
 .TE
 .SH PORTABILITY
 The \fBlongname\fR and \fB-S\fR options, and the parameter-substitution