summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man1/tput.1
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/debian-unstable/man1/tput.1')
-rw-r--r--upstream/debian-unstable/man1/tput.180
1 files changed, 45 insertions, 35 deletions
diff --git a/upstream/debian-unstable/man1/tput.1 b/upstream/debian-unstable/man1/tput.1
index c7c02767..295c8afc 100644
--- a/upstream/debian-unstable/man1/tput.1
+++ b/upstream/debian-unstable/man1/tput.1
@@ -28,8 +28,8 @@
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: tput.1,v 1.102 2024/01/13 22:47:16 tom Exp $
-.TH tput 1 2024-01-13 "ncurses 6.4" "User commands"
+.\" $Id: tput.1,v 1.113 2024/04/20 19:58:50 tom Exp $
+.TH tput 1 2024-04-20 "ncurses 6.5" "User commands"
.ie \n(.g \{\
.ds `` \(lq
.ds '' \(rq
@@ -47,9 +47,7 @@
..
.ds d /etc/terminfo
.SH NAME
-\fB\%tput\fP,
-\fB\%init\fP,
-\fB\%reset\fP \-
+\fB\%tput\fP \-
initialize a terminal, exercise its capabilities, or query \fI\%term\%info\fP database
.SH SYNOPSIS
\fBtput\fP [\fB\-T\fP \fIterminal-type\fP]
@@ -81,7 +79,7 @@ Terminal capabilities are accessed by
.PP
\fB\%terminfo\fP(5) discusses terminal capabilities at length
and presents a complete list of
-.I cap-codes.
+.IR cap-codes .
.PP
When retrieving capability values,
the result depends upon the capability's type.
@@ -90,7 +88,7 @@ Boolean
\fB\%tput\fP sets its exit status to
.B 0
if the terminal possesses
-.I cap-code,
+.IR cap-code ,
and
.B 1
if it does not.
@@ -116,7 +114,7 @@ see section \*(``EXIT STATUS\*('' below.
.SS Operands
Generally,
an operand is a
-.I cap-code,
+.IR cap-code ,
a capability code from the terminal database,
or a parameter thereto.
Three others are specially recognized by \fB\%tput\fP:
@@ -131,8 +129,13 @@ we term them \*(``pseudo-capabilities\*(''.
.I cap-code
indicates a capability from the terminal database.
.IP
-If the capability is of string type and takes parameters,
-the arguments following the capability will be used as its parameters.
+If
+.I cap-code
+is of string type and takes parameters,
+\fB\%tput\fP interprets arguments following
+.I cap-code
+as the parameters,
+up to the (fixed) quantity the capability requires.
.IP
Most parameters are numeric.
Only a few terminal capabilities require string parameters;
@@ -277,16 +280,23 @@ executing a link named
.B \%reset
that points to \fB\%tput\fP has the same effect as
.RB \%\*(`` "tput \%reset" \*(''.
-(The \fB\%tset\fP(1) utility also treats a link named
-.B \%reset
-specially.)
.PP
-If \fB\%tput\fP is invoked by a link named
-.BR \%init ,
-this has the same effect as
-.RB \%\*(`` "tput init" \*(''.
-Such a link is seldom employed because another program of that name
-is in widespread use.
+This feature was introduced by
+.I \%ncurses
+5.2 in 2000.
+It is rarely used:
+.TP
+.B \%clear
+is a separate program,
+which is both smaller and more frequently executed.
+.TP
+.B init
+has the same name as another program in widespread use.
+.TP
+.B \%reset
+is provided
+by the \fB\%tset\fP(1) utility (also via a link named
+.BR \%reset ")."
.SS "Terminal Size"
Besides the pseudo-capabilities
(such as
@@ -314,7 +324,7 @@ Finally,
it inspects the environment variables
.I LINES
and
-.I \%COLUMNS,
+.IR \%COLUMNS ,
which may override the terminal size.
.PP
If the
@@ -352,7 +362,7 @@ and whether to use \fB\%tparm\fP(3NCURSES).
.TP
.BI \-T\ type
indicates the terminal's
-.I type.
+.IR type .
Normally this option is unnecessary,
because a default is taken from the
.I TERM
@@ -410,7 +420,7 @@ _
4 some operands not interpreted
.TE
.SH ENVIRONMENT
-\fBtput\fP command reads one environment variable.
+\fBtput\fP reads one environment variable.
.TP 8n \" "TERM" + 2n + adjustment for PDF
.I TERM
denotes the terminal type.
@@ -509,7 +519,7 @@ to port NetBSD's
.IR termcap -based
.B tput
to
-.I \%term\%info,
+.IR \%term\%info ,
and modified it to interpret multiple
.I cap-codes
(and parameters)
@@ -551,7 +561,7 @@ to
but
.B \%parm_delete_line
to
-.I \%term\%info.
+.IR \%term\%info .
.I termcap
uses the code
.B DL
@@ -559,7 +569,7 @@ for
.BR \%parm_delete_line .
.I \%term\%info
uses the code
-.B dch1
+.B dl1
for
.BR \%delete_line .
.bP
@@ -573,7 +583,7 @@ to
but
.B \%clr_eos
to
-.I \%term\%info.
+.IR \%term\%info .
.I termcap
uses the code
.B cd
@@ -618,7 +628,7 @@ A few observations of interest arise from that selection.
supports
.B clear
as it does any other standard
-.I cap-code.
+.IR cap-code .
The others
.RB ( init
and
@@ -637,9 +647,9 @@ operands.
.bP
A few platforms such as FreeBSD recognize
.I termcap
-names rather than
+codes rather than
.I \%term\%info
-capability names in their respective
+capability codes in their respective
.B tput
commands.
Since 2010,
@@ -647,13 +657,13 @@ NetBSD's
.B tput
uses
.I \%term\%info
-names.
+codes.
Before that,
it
(like FreeBSD)
recognized
.I termcap
-names.
+codes.
.IP
Beginning in 2021,
FreeBSD uses
@@ -688,13 +698,13 @@ X/Open Curses and the terminal capability database.
While it is certainly possible to write a
.B tput
program without using
-.I curses,
+.IR curses ,
no system with a
.I curses
implementation provides a
.B tput
utility that does not also support standard
-.I cap-codes.
+.IR cap-codes .
.PP
X/Open Curses Issue 7 (2009) is the first version to document utilities.
However that part of X/Open Curses does not follow existing practice
@@ -724,7 +734,7 @@ The various System\ V implementations
HP-UX,
Solaris)
use the same exit statuses as
-.I \%ncurses.
+.IR \%ncurses .
.PP
NetBSD
.I curses
@@ -800,7 +810,7 @@ because he had only
available,
it accepted
.I termcap
-names for other capabilities.
+codes for other capabilities.
Also,
Bostic's BSD
.B tput