ncurses 6.4 - patch 20231021

[ncurses.git] / man / tput.1

diff --git a/man/tput.1 b/man/tput.1
index 2c57f13762b41441e3fc3ec1daadee41629807c5..03cdabda5637ec99742ae76da49f18012bd82c14 100644 (file)
--- a/man/tput.1
+++ b/man/tput.1
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
 '\" t
 .\"***************************************************************************

-.\" Copyright 2018-2020,2021 Thomas E. Dickey                                *
+.\" Copyright 2018-2022,2023 Thomas E. Dickey                                *

 .\" Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *


@@ -28,35 +28,43 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: tput.1,v 1.75 2021/12/25 21:31:59 tom Exp $
-.TH @TPUT@ 1 ""
-.ds d @TERMINFO@
-.ds n 1
-.ie \n(.g .ds `` \(lq
-.el       .ds `` ``
-.ie \n(.g .ds '' \(rq
-.el       .ds '' ''
+.\" $Id: tput.1,v 1.87 2023/10/14 19:29:06 tom Exp $
+.TH @TPUT@ 1 2023-10-14 "ncurses 6.4" "User commands"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el   .ds `` ""
+.ie t .ds '' ''
+.el   .ds '' ""
+.\}
+.

 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..

+.ds n 1
+.ds d @TERMINFO@

 .SH NAME
 .SH NAME

-\fB@TPUT@\fP, \fBreset\fP \- initialize a terminal or query terminfo database
+\fB\%@TPUT@\fP,
+\fB\%reset\fP \-
+initialize a terminal or query \fIterminfo\fR database

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB@TPUT@\fP [\fB\-T\fP\fItype\fP] \fIcapname\fP [\fIparameters\fP]
+\fB@TPUT@\fR [\fB\-T\fItype\fR] \fIcapname\fR [\fIparameters\fR]

 .br
 .br

-\fB@TPUT@\fP [\fB\-T\fP\fItype\fP] [\fB\-x\fP] \fBclear\fP
+\fB@TPUT@\fR [\fB\-T\fItype\fR] [\fB\-x\fR] \fBclear\fR

 .br
 .br

-\fB@TPUT@\fP [\fB\-T\fP\fItype\fP] \fBinit\fP
+\fB@TPUT@\fR [\fB\-T\fItype\fR] \fBinit\fR

 .br
 .br

-\fB@TPUT@\fP [\fB\-T\fP\fItype\fP] \fBreset\fP
+\fB@TPUT@\fR [\fB\-T\fItype\fR] \fBreset\fR

 .br
 .br

-\fB@TPUT@\fP [\fB\-T\fP\fItype\fP] \fBlongname\fP
+\fB@TPUT@\fR [\fB\-T\fItype\fR] \fBlongname\fR

 .br
 \fB@TPUT@ \-S\fP  \fB<<\fP
 .br
 \fB@TPUT@ \-V\fP
 .br
 \fB@TPUT@ \-S\fP  \fB<<\fP
 .br
 \fB@TPUT@ \-V\fP

-.br

 .SH DESCRIPTION
 The \fB@TPUT@\fP utility uses the \fBterminfo\fP database to make the
 values of terminal-dependent capabilities and information available to
 .SH DESCRIPTION
 The \fB@TPUT@\fP utility uses the \fBterminfo\fP database to make the
 values of terminal-dependent capabilities and information available to


@@ -103,7 +111,7 @@ Because some capabilities may use
 to decide whether to use \fBtparm\fP(3X),
 and how to interpret the parameters.
 .TP
 to decide whether to use \fBtparm\fP(3X),
 and how to interpret the parameters.
 .TP

-\fB\-T\fP\fItype\fP
+\fB\-T\fItype\fR

 indicates the \fItype\fP of terminal.
 Normally this option is
 unnecessary, because the default is taken from the environment
 indicates the \fItype\fP of terminal.
 Normally this option is
 unnecessary, because the default is taken from the environment


@@ -140,7 +148,7 @@ If no parameters are given for the capability,
 .TP
 \fBinit\fP
 If the terminal database is present and an entry for the user's
 .TP
 \fBinit\fP
 If the terminal database is present and an entry for the user's

-terminal exists (see \fB\-T\fP\fItype\fP, above), the following will
+terminal exists (see \fB\-T\fItype\fR, above), the following will

 occur:
 .RS
 .TP 5
 occur:
 .RS
 .TP 5


@@ -226,7 +234,7 @@ Otherwise, \fBreset\fP acts identically to \fBinit\fP.
 .TP
 \fBlongname\fP
 If the terminal database is present and an entry for the
 .TP
 \fBlongname\fP
 If the terminal database is present and an entry for the

-user's terminal exists (see \fB\-T\fP\fItype\fP above), then the long name
+user's terminal exists (see \fB\-T\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
 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


@@ -273,7 +281,6 @@ same effect as \fB@TPUT@ init\fP.
 Again, you are less likely to use that link because another program
 named \fBinit\fP has a more well-established use.
 .SS Terminal Size
 Again, you are less likely to use that link because another program
 named \fBinit\fP has a more well-established use.
 .SS Terminal Size

-.PP

 Besides the special commands (e.g., \fBclear\fP),
 @TPUT@ treats certain terminfo capabilities specially:
 \fBlines\fP and \fBcols\fP.
 Besides the special commands (e.g., \fBclear\fP),
 @TPUT@ treats certain terminfo capabilities specially:
 \fBlines\fP and \fBcols\fP.


@@ -320,12 +327,12 @@ Print the number of columns for the current terminal.
 \fB@TPUT@ \-T450 cols\fP
 Print the number of columns for the 450 terminal.
 .TP 5
 \fB@TPUT@ \-T450 cols\fP
 Print the number of columns for the 450 terminal.
 .TP 5

-\fBbold=`@TPUT@ smso` offbold=`@TPUT@ rmso`\fP
+\fBbold=\(ga@TPUT@ smso\(ga offbold=\(ga@TPUT@ rmso\(ga\fP

 Set the shell variables \fBbold\fP, to begin stand-out mode
 sequence, and \fBoffbold\fP, to end standout mode sequence,
 for the current terminal.
 This might be followed by a
 Set the shell variables \fBbold\fP, to begin stand-out mode
 sequence, and \fBoffbold\fP, 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"\fP
+prompt: \fBecho "${bold}Please type in your name: ${offbold}\ec"\fP

 .TP 5
 \fB@TPUT@ hc\fP
 Set exit code to indicate if the current terminal is a hard copy terminal.
 .TP 5
 \fB@TPUT@ hc\fP
 Set exit code to indicate if the current terminal is a hard copy terminal.


@@ -362,16 +369,11 @@ and turns on bold (extra bright) mode.
 The list is terminated by an exclamation mark (\fB!\fP) on a line by itself.
 .SH FILES
 .TP
 The list is terminated by an exclamation mark (\fB!\fP) on a line by itself.
 .SH FILES
 .TP

-\fB\*d\fP
-compiled terminal description database
+.I @DATADIR@/tabset
+tab stop initialization database

 .TP
 .TP

-\fB@DATADIR@/tabset/*\fP
-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
-.IR "Tabs and Initialization" ,
-section of \fBterminfo\fP(5)
+.I \*d
+compiled terminal description database

 .SH EXIT CODES
 If the \fB\-S\fP option is used,
 \fB@TPUT@\fP checks for errors from each line,
 .SH EXIT CODES
 If the \fB\-S\fP option is used,
 \fB@TPUT@\fP checks for errors from each line,


@@ -481,7 +483,6 @@ almost without change,
 Raymond made improvements to the way the command-line parameters
 were handled.
 .SH PORTABILITY
 Raymond made improvements to the way the command-line parameters
 were handled.
 .SH PORTABILITY

-.PP

 This implementation of \fBtput\fP differs from AT&T \fBtput\fP in
 two important areas:
 .bP
 This implementation of \fBtput\fP differs from AT&T \fBtput\fP in
 two important areas:
 .bP


@@ -609,12 +610,9 @@ as ncurses.
 NetBSD curses documents different exit codes which do not correspond
 to either ncurses or X/Open.
 .SH SEE ALSO
 NetBSD curses documents different exit codes which do not correspond
 to either ncurses or X/Open.
 .SH SEE ALSO

-\fB@CLEAR@\fP(\*n),
-\fBstty\fP(1),
-\fB@TABS@\fP(\*n),
-\fB@TSET@\fP(\*n),
-\fBcurs_termcap\fP(3X),
-\fBterminfo\fP(5).
-.PP
-This describes \fBncurses\fP
-version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).
+\fB\%@CLEAR@\fP(\*n),
+\fB\%stty\fP(1),
+\fB\%@TABS@\fP(\*n),
+\fB\%@TSET@\fP(\*n),
+\fB\%curs_termcap\fP(3X),
+\fB\%terminfo\fP(5)