.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: tput.1,v 1.25 2006/05/13 15:14:01 tom Exp $
-.TH tput 1 ""
+.\" $Id: tput.1,v 1.27 2006/12/24 18:11:31 tom Exp $
+.TH @TPUT@ 1 ""
.ds d @TERMINFO@
.ds n 1
.SH NAME
-\fBtput\fR, \fBreset\fR - initialize a terminal or query terminfo database
+\fB@TPUT@\fR, \fBreset\fR - initialize a terminal or query terminfo database
.SH SYNOPSIS
-\fBtput\fR [\fB-T\fR\fItype\fR] \fIcapname\fR [\fIparms\fR ... ]
+\fB@TPUT@\fR [\fB-T\fR\fItype\fR] \fIcapname\fR [\fIparms\fR ... ]
.br
-\fBtput\fR [\fB-T\fR\fItype\fR] \fBinit\fR
+\fB@TPUT@\fR [\fB-T\fR\fItype\fR] \fBinit\fR
.br
-\fBtput\fR [\fB-T\fR\fItype\fR] \fBreset\fR
+\fB@TPUT@\fR [\fB-T\fR\fItype\fR] \fBreset\fR
.br
-\fBtput\fR [\fB-T\fR\fItype\fR] \fBlongname\fR
+\fB@TPUT@\fR [\fB-T\fR\fItype\fR] \fBlongname\fR
.br
-\fBtput -S\fR \fB<<\fR
+\fB@TPUT@ -S\fR \fB<<\fR
.br
-\fBtput -V\fR
+\fB@TPUT@ -V\fR
.br
.SH DESCRIPTION
-The \fBtput\fR utility uses the \fBterminfo\fR database to make the
+The \fB@TPUT@\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.
.RS
.TP 5
string
-\fBtput\fR writes the string to the standard output.
+\fB@TPUT@\fR writes the string to the standard output.
No trailing newline is supplied.
.TP
integer
-\fBtput\fR writes the decimal value to the standard output,
+\fB@TPUT@\fR writes the decimal value to the standard output,
with a trailing newline.
.TP
boolean
-\fBtput\fR simply sets the exit code
+\fB@TPUT@\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 writes nothing to the standard output.
(e.g., \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).
+and the \fIcapname\fR associated with each, see \fBterminfo\fR(5).
.TP
\fB-T\fR\fItype\fR
indicates the \fItype\fR of terminal. Normally this option is
.IP
Most parameters are numbers.
Only a few terminfo capabilities require string parameters;
-\fBtput\fR uses a table to decide which to pass as strings.
-Normally \fBtput\fR uses \fBtparm\fR (3X) to perform the substitution.
+\fB@TPUT@\fR uses a table to decide which to pass as strings.
+Normally \fB@TPUT@\fR uses \fBtparm\fR (3X) to perform the substitution.
If no parameters are given for the capability,
-\fBtput\fR writes the string without performing the substitution.
+\fB@TPUT@\fR writes the string without performing the substitution.
.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
+allows more than one capability per invocation of \fB@TPUT@\fR. The
+capabilities must be passed to \fB@TPUT@\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).
.IP
-Again, \fBtput\fR uses a table and the presence of parameters in its input
+Again, \fB@TPUT@\fR uses a table and the presence of parameters in its input
to decide whether to use \fBtparm\fR (3X),
and how to interpret the parameters.
.TP
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.
+If \fB@TPUT@\fR is invoked by a link named \fBreset\fR, this has the
+same effect as \fB@TPUT@ reset\fR.
See \fBtset\fR for comparison, which has similar behavior.
.SH EXAMPLES
.TP 5
-\fBtput init\fR
+\fB@TPUT@ 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(5) manual page.
.TP 5
-\fBtput -T5620 reset\fR
+\fB@TPUT@ -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
+\fB@TPUT@ 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
+\fB@TPUT@ clear\fR
Echo the clear-screen sequence for the current terminal.
.TP 5
-\fBtput cols\fR
+\fB@TPUT@ cols\fR
Print the number of columns for the current terminal.
.TP 5
-\fBtput -T450 cols\fR
+\fB@TPUT@ -T450 cols\fR
Print the number of columns for the 450 terminal.
.TP 5
-\fBbold=`tput smso` offbold=`tput rmso`\fR
+\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
+\fB@TPUT@ hc\fR
Set exit code to indicate if the current terminal is a hard copy terminal.
.TP 5
-\fBtput cup 23 4\fR
+\fB@TPUT@ cup 23 4\fR
Send the sequence to move the cursor to row 23, column 4.
.TP 5
-\fBtput cup\fR
+\fB@TPUT@ cup\fR
Send the terminfo string for cursor-movement, with no parameters substituted.
.TP 5
-\fBtput longname\fR
+\fB@TPUT@ 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
+\fB@TPUT@ -S <<!\fR
.br
\fB> clear\fR
.br
.RE
.TP 5
\&
-This example shows \fBtput\fR processing several capabilities in one invocation.
+This example shows \fB@TPUT@\fR processing several capabilities in one invocation.
It clears the screen,
moves the cursor to position 10, 10
and turns on bold (extra bright) mode.
section of \fBterminfo\fR(5)
.SH EXIT CODES
If the \fB-S\fR option is used,
-\fBtput\fR checks for errors from each line,
+\fB@TPUT@\fR 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 \fB0\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)
+\fBterminfo\fR(5) database for this terminal type, e.g.
+\fB@TPUT@ -T450 lines\fR and \fB@TPUT@ -T2621 xmc\fR)
T}
\fB1\fR no error message is printed, see the \fBEXIT CODES\fR section.
\fB2\fR usage error
projects / ncurses.git / blobdiff