mirror of
https://git.FreeBSD.org/src.git
synced 2024-12-24 11:29:10 +00:00
257 lines
10 KiB
Groff
257 lines
10 KiB
Groff
'\" 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 @TERMINFO@
|
|
.ds n 5
|
|
.SH NAME
|
|
\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
|
|
\fBtput\fR [\fB-T\fR\fItype\fR] \fBinit\fR
|
|
.br
|
|
\fBtput\fR [\fB-T\fR\fItype\fR] \fBreset\fR
|
|
.br
|
|
\fBtput\fR [\fB-T\fR\fItype\fR] \fBlongname\fR
|
|
.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
|
|
the shell (see \fBsh\fR(1)), to initialize or reset the terminal, or
|
|
return the long name of the requested terminal type. \fBtput\fR
|
|
outputs a string if the attribute (\fIcap\fRability \fIname\fR) is of
|
|
type string, or an integer if the attribute is of type integer. If
|
|
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
|
|
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
|
|
operating system will not be queried for the actual screen size.
|
|
.TP
|
|
\fIcapname\fR
|
|
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
|
|
\fIparms\fR will be instantiated into the string. An all numeric
|
|
argument will be passed to the attribute as a number.
|
|
.TP
|
|
\fB-S\fR
|
|
allows more than one capability per invocation of \fBtput\fR. The
|
|
capabilities must be passed to \fBtput\fR from the standard input
|
|
instead of from the command line (see example). Only one
|
|
\fIcapname\fR is allowed per line. The \fB-S\fR option changes the
|
|
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
|
|
occur: (1) if present, the terminal's initialization strings will be
|
|
output (\fBis1\fR, \fBis2\fR, \fBis3\fR, \fBif\fR, \fBiprog\fR), (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.
|
|
.TP
|
|
\fBreset\fR
|
|
Instead of putting out initialization strings, the terminal's
|
|
reset strings will be output if present (\fBrs1\fR, \fBrs2\fR, \fBrs3\fR, \fBrf\fR).
|
|
If the reset strings are not present, but initialization
|
|
strings are, the initialization strings will be output.
|
|
Otherwise, \fBreset\fR acts identically to \fBinit\fR.
|
|
.TP
|
|
\fBlongname\fR
|
|
If the \fBterminfo\fR database is present and an entry for the
|
|
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
|
|
Initialize the terminal according to the type of
|
|
terminal in the environmental variable \fBTERM\fR. This
|
|
command should be included in everyone's .profile after
|
|
the environmental variable \fBTERM\fR has been exported, as
|
|
illustrated on the \fBprofile\fR(4) manual page.
|
|
.TP 5
|
|
\fBtput -T5620 reset\fR
|
|
Reset an AT&T 5620 terminal, overriding the type of
|
|
terminal in the environmental variable \fBTERM\fR.
|
|
.TP 5
|
|
\fBtput cup 0 0\fR
|
|
Send the sequence to move the cursor to row \fB0\fR, column \fB0\fR
|
|
(the upper left corner of the screen, usually known as the "home"
|
|
cursor position).
|
|
.TP 5
|
|
\fBtput clear\fR
|
|
Echo the clear-screen sequence for the current terminal.
|
|
.TP 5
|
|
\fBtput cols\fR
|
|
Print the number of columns for the current terminal.
|
|
.TP 5
|
|
\fBtput -T450 cols\fR
|
|
Print the number of columns for the 450 terminal.
|
|
.TP 5
|
|
\fBbold=`tput smso` offbold=`tput rmso`\fR
|
|
Set the shell variables \fBbold\fR, to begin stand-out mode
|
|
sequence, and \fBoffbold\fR, to end standout mode sequence,
|
|
for the current terminal. This might be followed by a
|
|
prompt: \fBecho "${bold}Please type in your name: ${offbold}\\c"\fR
|
|
.TP 5
|
|
\fBtput hc\fR
|
|
Set exit code to indicate if the current terminal is a hard copy terminal.
|
|
.TP 5
|
|
\fBtput cup 23 4\fR
|
|
Send the sequence to move the cursor to row 23, column 4.
|
|
.TP 5
|
|
\fBtput longname\fR
|
|
Print the long name from the \fBterminfo\fR database for the
|
|
type of terminal specified in the environmental
|
|
variable \fBTERM\fR.
|
|
.PP
|
|
.RS 5
|
|
\fBtput -S <<!\fR
|
|
.br
|
|
\fB> clear\fR
|
|
.br
|
|
\fB> cup 10 10\fR
|
|
.br
|
|
\fB> bold\fR
|
|
.br
|
|
\fB> !\fR
|
|
.RE
|
|
.TP 5
|
|
\&
|
|
This example shows tput processing several capabilities in one
|
|
invocation. This example 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 (\fB!\fR) on a line by itself.
|
|
.SH FILES
|
|
.TP
|
|
\fB\*d\fR
|
|
compiled terminal description database
|
|
.TP
|
|
\fB/usr/include/curses.h\fR
|
|
\fBcurses\fR(3X) header file
|
|
.TP
|
|
\fB/usr/include/term.h\fR
|
|
\fBterminfo\fR header file
|
|
.TP
|
|
\fB@DATADIR@/tabset/*\fR
|
|
tab settings for some terminals, in a format
|
|
appropriate to be output to the terminal (escape
|
|
sequences that set margins and tabs); for more
|
|
information, see the "Tabs and Initialization"
|
|
section of \fBterminfo\fR(4)
|
|
.SH SEE ALSO
|
|
\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 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
|
|
features used in the \fBcup\fR example, are not supported in BSD curses or in
|
|
AT&T/USL curses before SVr4.
|
|
.\"#
|
|
.\"# The following sets edit modes for GNU EMACS
|
|
.\"# Local Variables:
|
|
.\"# mode:nroff
|
|
.\"# fill-column:79
|
|
.\"# End:
|