ncurses 6.5 - patch 20240519

[ncurses.git] / man / tput.1

diff --git a/man/tput.1 b/man/tput.1
index b4ea459258413fa9df258d5cd2417687532d9e99..bd25b0b5b96487ce2f90b8fce014244a0425356a 100644 (file)
--- a/man/tput.1
+++ b/man/tput.1
@@ -28,8 +28,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: tput.1,v 1.105 2024/01/20 19:41:02 tom Exp $
-.TH @TPUT@ 1 2024-01-20 "ncurses 6.4" "User commands"
+.\" $Id: tput.1,v 1.114 2024/05/11 20:39:53 tom Exp $
+.TH @TPUT@ 1 2024-05-11 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands"
 .ie \n(.g \{\
 .ds `` \(lq
 .ds '' \(rq
@@ -45,7 +45,6 @@
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
-.ds d @TERMINFO@
 .SH NAME
 \fB\%@TPUT@\fP \-
 initialize a terminal, exercise its capabilities, or query \fI\%term\%info\fP database
@@ -79,7 +78,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.
@@ -88,7 +87,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.
@@ -114,7 +113,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:
@@ -129,8 +128,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;
@@ -319,7 +323,7 @@ Finally,
 it inspects the environment variables
 .I LINES
 and
-.I \%COLUMNS,
+.IR \%COLUMNS ,
 which may override the terminal size.
 .PP
 If the
@@ -357,7 +361,7 @@ and whether to use \fB\%tparm\fP(3X).
 .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
@@ -429,7 +433,7 @@ option overrides its value.
 .I @DATADIR@/tabset
 tab stop initialization database
 .TP
-.I \*d
+.I @TERMINFO@
 compiled terminal description database
 .SH PORTABILITY
 Over time
@@ -514,7 +518,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)
@@ -556,7 +560,7 @@ to
 but
 .B \%parm_delete_line
 to
-.I \%term\%info.
+.IR \%term\%info .
 .I termcap
 uses the code
 .B DL
@@ -564,7 +568,7 @@ for
 .BR \%parm_delete_line .
 .I \%term\%info
 uses the code
-.B dch1
+.B dl1
 for
 .BR \%delete_line .
 .bP
@@ -578,7 +582,7 @@ to
 but
 .B \%clr_eos
 to
-.I \%term\%info.
+.IR \%term\%info .
 .I termcap
 uses the code
 .B cd
@@ -623,7 +627,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
@@ -693,13 +697,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
@@ -729,7 +733,7 @@ The various System\ V implementations
 HP-UX,
 Solaris)
 use the same exit statuses as
-.I \%ncurses.
+.IR \%ncurses .
 .PP
 NetBSD
 .I curses