<!--
* t
****************************************************************************
- * Copyright 2018-2021,2022 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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: tput.1,v 1.76 2022/02/12 20:02:20 tom Exp @
+ * @Id: tput.1,v 1.89 2023/11/25 14:32:36 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>tput 1</TITLE>
+<TITLE>tput 1 2023-11-25 ncurses 6.4 User commands</TITLE>
<link rel="author" href="mailto:bug-ncurses@gnu.org">
</HEAD>
<BODY>
-<H1 class="no-header">tput 1</H1>
+<H1 class="no-header">tput 1 2023-11-25 ncurses 6.4 User commands</H1>
<PRE>
-<STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>
General Commands Manual <STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>
+<STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>
User commands <STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
- <STRONG>tput</STRONG>, <STRONG>reset</STRONG> - initialize a terminal or query terminfo database
+ <STRONG>tput</STRONG>, <STRONG>reset</STRONG> - initialize a terminal or query <EM>terminfo</EM> database
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
- <STRONG>tput</STRONG> [<STRONG>-T</STRONG><EM>type</EM>] <EM>capname</EM> [<EM>parameters</EM>]
- <STRONG>tput</STRONG> [<STRONG>-T</STRONG><EM>type</EM>] [<STRONG>-x</STRONG>] <STRONG>clear</STRONG>
- <STRONG>tput</STRONG> [<STRONG>-T</STRONG><EM>type</EM>] <STRONG>init</STRONG>
- <STRONG>tput</STRONG> [<STRONG>-T</STRONG><EM>type</EM>] <STRONG>reset</STRONG>
- <STRONG>tput</STRONG> [<STRONG>-T</STRONG><EM>type</EM>] <STRONG>longname</STRONG>
+ <STRONG>tput</STRONG> [<STRONG>-T</STRONG> <EM>terminal-type</EM>] <EM>capname</EM> [<EM>parameters</EM>]
+ <STRONG>tput</STRONG> [<STRONG>-T</STRONG> <EM>terminal-type</EM>] [<STRONG>-x</STRONG>] <STRONG>clear</STRONG>
+ <STRONG>tput</STRONG> [<STRONG>-T</STRONG> <EM>terminal-type</EM>] <STRONG>init</STRONG>
+ <STRONG>tput</STRONG> [<STRONG>-T</STRONG> <EM>terminal-type</EM>] <STRONG>reset</STRONG>
+ <STRONG>tput</STRONG> [<STRONG>-T</STRONG> <EM>terminal-type</EM>] <STRONG>longname</STRONG>
<STRONG>tput</STRONG> <STRONG>-S</STRONG> <STRONG><<</STRONG>
<STRONG>tput</STRONG> <STRONG>-V</STRONG>
Before using a value returned on the standard output, the application
should test the exit code (e.g., <STRONG>$?</STRONG>, see <STRONG>sh(1)</STRONG>) to be sure it is <STRONG>0</STRONG>.
- (See the <STRONG>EXIT</STRONG> <STRONG>CODES</STRONG> and <STRONG>DIAGNOSTICS</STRONG> sections.) For a complete list of
+ (See the <STRONG>EXIT</STRONG> <STRONG>STATUS</STRONG> and <STRONG>DIAGNOSTICS</STRONG> sections.) For a complete list of
capabilities and the <EM>capname</EM> associated with each, see <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
capabilities must be passed to <STRONG>tput</STRONG> from the standard input
instead of from the command line (see example). Only one
<EM>capname</EM> is allowed per line. The <STRONG>-S</STRONG> option changes the meaning
- of the <STRONG>0</STRONG> and <STRONG>1</STRONG> boolean and string exit codes (see the EXIT CODES
- section).
+ of the <STRONG>0</STRONG> and <STRONG>1</STRONG> boolean and string exit codes (see the EXIT
+ STATUS section).
Because some capabilities may use <EM>string</EM> parameters rather than
<EM>numbers</EM>, <STRONG>tput</STRONG> uses a table and the presence of parameters in its
<STRONG>-V</STRONG> reports the version of ncurses which was used in this program,
and exits.
- <STRONG>-x</STRONG> do not attempt to clear the terminal's scrollback buffer using
- the extended "E3" capability.
+ <STRONG>-x</STRONG> prevents <STRONG>tput</STRONG> from attempting to clear the scrollback buffer.
</PRE><H3><a name="h3-Commands">Commands</a></H3><PRE>
A few commands (<STRONG>init</STRONG>, <STRONG>reset</STRONG> and <STRONG>longname</STRONG>) are special; they are defined
by the <STRONG>tput</STRONG> program. The others are the names of <EM>capabilities</EM> from the
- terminal database (see <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> for a list). Although <STRONG>init</STRONG> and
- <STRONG>reset</STRONG> resemble capability names, <STRONG>tput</STRONG> uses several capabilities to
+ terminal database (see <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> for a list). Although <STRONG>init</STRONG> and
+ <STRONG>reset</STRONG> resemble capability names, <STRONG>tput</STRONG> uses several capabilities to
perform these special functions.
<EM>capname</EM>
indicates the capability from the terminal database.
- If the capability is a string that takes parameters, the
- arguments following the capability will be used as parameters
+ If the capability is a string that takes parameters, the
+ arguments following the capability will be used as parameters
for the string.
- Most parameters are numbers. Only a few terminal capabilities
- require string parameters; <STRONG>tput</STRONG> uses a table to decide which to
- pass as strings. Normally <STRONG>tput</STRONG> uses <STRONG><A HREF="curs_terminfo.3x.html">tparm(3x)</A></STRONG> to perform the
- substitution. If no parameters are given for the capability,
+ Most parameters are numbers. Only a few terminal capabilities
+ require string parameters; <STRONG>tput</STRONG> uses a table to decide which to
+ pass as strings. Normally <STRONG>tput</STRONG> uses <STRONG><A HREF="curs_terminfo.3x.html">tparm(3x)</A></STRONG> to perform the
+ substitution. If no parameters are given for the capability,
<STRONG>tput</STRONG> writes the string without performing the substitution.
- <STRONG>init</STRONG> If the terminal database is present and an entry for the user's
+ <STRONG>init</STRONG> If the terminal database is present and an entry for the user's
terminal exists (see <STRONG>-T</STRONG><EM>type</EM>, above), the following will occur:
- (1) first, <STRONG>tput</STRONG> retrieves the current terminal mode settings
+ (1) first, <STRONG>tput</STRONG> retrieves the current terminal mode settings
for your terminal. It does this by successively testing
<STRONG>o</STRONG> the standard error,
<STRONG>o</STRONG> ultimately "/dev/tty"
- to obtain terminal settings. Having retrieved these
- settings, <STRONG>tput</STRONG> remembers which file descriptor to use when
+ to obtain terminal settings. Having retrieved these
+ settings, <STRONG>tput</STRONG> remembers which file descriptor to use when
updating settings.
- (2) if the window size cannot be obtained from the operating
+ (2) if the window size cannot be obtained from the operating
system, but the terminal description (or environment, e.g.,
- <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> variables specify this), update the
+ <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> variables specify this), update the
operating system's notion of the window size.
(3) the terminal modes will be updated:
- <STRONG>o</STRONG> any delays (e.g., newline) specified in the entry will
+ <STRONG>o</STRONG> any delays (e.g., newline) specified in the entry will
be set in the tty driver,
- <STRONG>o</STRONG> tabs expansion will be turned on or off according to
+ <STRONG>o</STRONG> tabs expansion will be turned on or off according to
the specification in the entry, and
- <STRONG>o</STRONG> if tabs are not expanded, standard tabs will be set
+ <STRONG>o</STRONG> if tabs are not expanded, standard tabs will be set
(every 8 spaces).
- (4) if present, the terminal's initialization strings will be
- output as detailed in the <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> section on <EM>Tabs</EM> <EM>and</EM>
+ (4) if present, the terminal's initialization strings will be
+ output as detailed in the <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> section on <EM>Tabs</EM> <EM>and</EM>
<EM>Initialization</EM>,
(5) output is flushed.
- If an entry does not contain the information needed for any of
+ If an entry does not contain the information needed for any of
these activities, that activity will silently be skipped.
<STRONG>reset</STRONG> This is similar to <STRONG>init</STRONG>, with two differences:
<STRONG>o</STRONG> turn on newline translation and
- <STRONG>o</STRONG> reset any unset special characters to their default
+ <STRONG>o</STRONG> reset any unset special characters to their default
values
- (2) Instead of putting out <EM>initialization</EM> strings, the
- terminal's <EM>reset</EM> strings will be output if present (<STRONG>rs1</STRONG>,
- <STRONG>rs2</STRONG>, <STRONG>rs3</STRONG>, <STRONG>rf</STRONG>). If the <EM>reset</EM> strings are not present, but
+ (2) Instead of putting out <EM>initialization</EM> strings, the
+ terminal's <EM>reset</EM> strings will be output if present (<STRONG>rs1</STRONG>,
+ <STRONG>rs2</STRONG>, <STRONG>rs3</STRONG>, <STRONG>rf</STRONG>). If the <EM>reset</EM> strings are not present, but
<EM>initialization</EM> strings are, the <EM>initialization</EM> strings will
be output.
Otherwise, <STRONG>reset</STRONG> acts identically to <STRONG>init</STRONG>.
<STRONG>longname</STRONG>
- If the terminal database is present and an entry for the user's
- terminal exists (see <STRONG>-T</STRONG><EM>type</EM> above), then the long name of the
+ If the terminal database is present and an entry for the user's
+ terminal exists (see <STRONG>-T</STRONG><EM>type</EM> 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 <STRONG>terminfo</STRONG>
database [see <STRONG><A HREF="term.5.html">term(5)</A></STRONG>].
</PRE><H3><a name="h3-Aliases">Aliases</a></H3><PRE>
- <STRONG>tput</STRONG> handles the <STRONG>clear</STRONG>, <STRONG>init</STRONG> and <STRONG>reset</STRONG> commands specially: it allows
+ <STRONG>tput</STRONG> handles the <STRONG>clear</STRONG>, <STRONG>init</STRONG> and <STRONG>reset</STRONG> commands specially: it allows
for the possibility that it is invoked by a link with those names.
- If <STRONG>tput</STRONG> is invoked by a link named <STRONG>reset</STRONG>, this has the same effect as
- <STRONG>tput</STRONG> <STRONG>reset</STRONG>. The <STRONG><A HREF="tset.1.html">tset(1)</A></STRONG> utility also treats a link named <STRONG>reset</STRONG>
+ If <STRONG>tput</STRONG> is invoked by a link named <STRONG>reset</STRONG>, this has the same effect as
+ <STRONG>tput</STRONG> <STRONG>reset</STRONG>. The <STRONG><A HREF="tset.1.html">tset(1)</A></STRONG> utility also treats a link named <STRONG>reset</STRONG>
specially.
Before ncurses 6.1, the two utilities were different from each other:
- <STRONG>o</STRONG> <STRONG>tset</STRONG> utility reset the terminal modes and special characters (not
+ <STRONG>o</STRONG> <STRONG>tset</STRONG> utility reset the terminal modes and special characters (not
done with <STRONG>tput</STRONG>).
- <STRONG>o</STRONG> On the other hand, <STRONG>tset</STRONG>'s repertoire of terminal capabilities for
- resetting the terminal was more limited, i.e., only <STRONG>reset_1string</STRONG>,
- <STRONG>reset_2string</STRONG> and <STRONG>reset_file</STRONG> in contrast to the tab-stops and
+ <STRONG>o</STRONG> On the other hand, <STRONG>tset</STRONG>'s repertoire of terminal capabilities for
+ resetting the terminal was more limited, i.e., only <STRONG>reset_1string</STRONG>,
+ <STRONG>reset_2string</STRONG> and <STRONG>reset_file</STRONG> in contrast to the tab-stops and
margins which are set by this utility.
- <STRONG>o</STRONG> The <STRONG>reset</STRONG> program is usually an alias for <STRONG>tset</STRONG>, because of this
+ <STRONG>o</STRONG> The <STRONG>reset</STRONG> program is usually an alias for <STRONG>tset</STRONG>, because of this
difference with resetting terminal modes and special characters.
- With the changes made for ncurses 6.1, the <EM>reset</EM> feature of the two
+ With the changes made for ncurses 6.1, the <EM>reset</EM> feature of the two
programs is (mostly) the same. A few differences remain:
- <STRONG>o</STRONG> The <STRONG>tset</STRONG> program waits one second when resetting, in case it
+ <STRONG>o</STRONG> The <STRONG>tset</STRONG> program waits one second when resetting, in case it
happens to be a hardware terminal.
- <STRONG>o</STRONG> The two programs write the terminal initialization strings to
- different streams (i.e., the standard error for <STRONG>tset</STRONG> and the
+ <STRONG>o</STRONG> The two programs write the terminal initialization strings to
+ different streams (i.e., the standard error for <STRONG>tset</STRONG> and the
standard output for <STRONG>tput</STRONG>).
- <STRONG>Note:</STRONG> although these programs write to different streams,
- redirecting their output to a file will capture only part of their
- actions. The changes to the terminal modes are not affected by
+ <STRONG>Note:</STRONG> although these programs write to different streams,
+ redirecting their output to a file will capture only part of their
+ actions. The changes to the terminal modes are not affected by
redirecting the output.
- If <STRONG>tput</STRONG> is invoked by a link named <STRONG>init</STRONG>, this has the same effect as
+ If <STRONG>tput</STRONG> is invoked by a link named <STRONG>init</STRONG>, this has the same effect as
<STRONG>tput</STRONG> <STRONG>init</STRONG>. Again, you are less likely to use that link because another
program named <STRONG>init</STRONG> has a more well-established use.
</PRE><H3><a name="h3-Terminal-Size">Terminal Size</a></H3><PRE>
Besides the special commands (e.g., <STRONG>clear</STRONG>), tput treats certain
- terminfo capabilities specially: <STRONG>lines</STRONG> and <STRONG>cols</STRONG>. tput calls
+ terminfo capabilities specially: <STRONG>lines</STRONG> and <STRONG>cols</STRONG>. tput calls
<STRONG><A HREF="curs_terminfo.3x.html">setupterm(3x)</A></STRONG> to obtain the terminal size:
<STRONG>o</STRONG> first, it gets the size from the terminal database (which generally
- is not provided for terminal emulators which do not have a fixed
+ is not provided for terminal emulators which do not have a fixed
window size)
- <STRONG>o</STRONG> then it asks the operating system for the terminal's size (which
+ <STRONG>o</STRONG> then it asks the operating system for the terminal's size (which
generally works, unless connecting via a serial line which does not
support <EM>NAWS</EM>: negotiations about window size).
- <STRONG>o</STRONG> finally, it inspects the environment variables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG>
+ <STRONG>o</STRONG> finally, it inspects the environment variables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG>
which may override the terminal size.
- If the <STRONG>-T</STRONG> option is given tput ignores the environment variables by
- calling <STRONG>use_tioctl(TRUE)</STRONG>, relying upon the operating system (or
+ If the <STRONG>-T</STRONG> option is given tput ignores the environment variables by
+ calling <STRONG>use_tioctl(TRUE)</STRONG>, relying upon the operating system (or
finally, the terminal database).
-</PRE><H2><a name="h2-EXAMPLES">EXAMPLES</a></H2><PRE>
- <STRONG>tput</STRONG> <STRONG>init</STRONG>
- Initialize the terminal according to the type of terminal in the
- environmental variable <STRONG>TERM</STRONG>. This command should be included in
- everyone's .profile after the environmental variable <STRONG>TERM</STRONG> has been
- exported, as illustrated on the <STRONG>profile(5)</STRONG> manual page.
-
- <STRONG>tput</STRONG> <STRONG>-T5620</STRONG> <STRONG>reset</STRONG>
- Reset an AT&T 5620 terminal, overriding the type of terminal in
- the environmental variable <STRONG>TERM</STRONG>.
-
- <STRONG>tput</STRONG> <STRONG>cup</STRONG> <STRONG>0</STRONG> <STRONG>0</STRONG>
- Send the sequence to move the cursor to row <STRONG>0</STRONG>, column <STRONG>0</STRONG> (the upper
- left corner of the screen, usually known as the "home" cursor
- position).
-
- <STRONG>tput</STRONG> <STRONG>clear</STRONG>
- Echo the clear-screen sequence for the current terminal.
-
- <STRONG>tput</STRONG> <STRONG>cols</STRONG>
- Print the number of columns for the current terminal.
-
- <STRONG>tput</STRONG> <STRONG>-T450</STRONG> <STRONG>cols</STRONG>
- Print the number of columns for the 450 terminal.
-
- <STRONG>bold=`tput</STRONG> <STRONG>smso`</STRONG> <STRONG>offbold=`tput</STRONG> <STRONG>rmso`</STRONG>
- Set the shell variables <STRONG>bold</STRONG>, to begin stand-out mode sequence,
- and <STRONG>offbold</STRONG>, to end standout mode sequence, for the current
- terminal. This might be followed by a prompt: <STRONG>echo</STRONG> <STRONG>"${bold}Please</STRONG>
- <STRONG>type</STRONG> <STRONG>in</STRONG> <STRONG>your</STRONG> <STRONG>name:</STRONG> <STRONG>${offbold}\c"</STRONG>
-
- <STRONG>tput</STRONG> <STRONG>hc</STRONG>
- Set exit code to indicate if the current terminal is a hard copy
- terminal.
-
- <STRONG>tput</STRONG> <STRONG>cup</STRONG> <STRONG>23</STRONG> <STRONG>4</STRONG>
- Send the sequence to move the cursor to row 23, column 4.
-
- <STRONG>tput</STRONG> <STRONG>cup</STRONG>
- Send the terminfo string for cursor-movement, with no parameters
- substituted.
-
- <STRONG>tput</STRONG> <STRONG>longname</STRONG>
- Print the long name from the <STRONG>terminfo</STRONG> database for the type of
- terminal specified in the environmental variable <STRONG>TERM</STRONG>.
-
- <STRONG>tput</STRONG> <STRONG>-S</STRONG> <STRONG><<!</STRONG>
- <STRONG>></STRONG> <STRONG>clear</STRONG>
- <STRONG>></STRONG> <STRONG>cup</STRONG> <STRONG>10</STRONG> <STRONG>10</STRONG>
- <STRONG>></STRONG> <STRONG>bold</STRONG>
- <STRONG>></STRONG> <STRONG>!</STRONG>
-
- This example shows <STRONG>tput</STRONG> processing several capabilities in one
- invocation. It 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 (<STRONG>!</STRONG>) on a line by itself.
-
-
-</PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
- <STRONG>/usr/share/terminfo</STRONG>
- compiled terminal description database
-
- <STRONG>/usr/share/tabset/*</STRONG>
- 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 <EM>Tabs</EM> <EM>and</EM> <EM>Initialization</EM>,
- section of <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
-
-
-</PRE><H2><a name="h2-EXIT-CODES">EXIT CODES</a></H2><PRE>
+</PRE><H2><a name="h2-EXIT-STATUS">EXIT STATUS</a></H2><PRE>
If the <STRONG>-S</STRONG> option is used, <STRONG>tput</STRONG> 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 <STRONG>0</STRONG>. No
- indication of which line failed can be given so exit code <STRONG>1</STRONG> will never
- appear. Exit codes <STRONG>2</STRONG>, <STRONG>3</STRONG>, and <STRONG>4</STRONG> retain their usual interpretation. If
- the <STRONG>-S</STRONG> option is not used, the exit code depends on the type of
+ 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 <STRONG>0</STRONG>. No
+ indication of which line failed can be given so exit code <STRONG>1</STRONG> will never
+ appear. Exit codes <STRONG>2</STRONG>, <STRONG>3</STRONG>, and <STRONG>4</STRONG> retain their usual interpretation. If
+ the <STRONG>-S</STRONG> option is not used, the exit code depends on the type of
<EM>capname</EM>:
<EM>boolean</EM>
a value of <STRONG>0</STRONG> is set for TRUE and <STRONG>1</STRONG> for FALSE.
- <EM>string</EM> a value of <STRONG>0</STRONG> is set if the <EM>capname</EM> is defined for this
- terminal <EM>type</EM> (the value of <EM>capname</EM> is returned on standard
- output); a value of <STRONG>1</STRONG> is set if <EM>capname</EM> is not defined for
+ <EM>string</EM> a value of <STRONG>0</STRONG> is set if the <EM>capname</EM> is defined for this
+ terminal <EM>type</EM> (the value of <EM>capname</EM> is returned on standard
+ output); a value of <STRONG>1</STRONG> is set if <EM>capname</EM> is not defined for
this terminal <EM>type</EM> (nothing is written to standard output).
<EM>integer</EM>
a value of <STRONG>0</STRONG> is always set, whether or not <EM>capname</EM> is defined
- for this terminal <EM>type</EM>. To determine if <EM>capname</EM> is defined
- for this terminal <EM>type</EM>, the user must test the value written
- to standard output. A value of <STRONG>-1</STRONG> means that <EM>capname</EM> is not
+ for this terminal <EM>type</EM>. To determine if <EM>capname</EM> is defined
+ for this terminal <EM>type</EM>, the user must test the value written
+ to standard output. A value of <STRONG>-1</STRONG> means that <EM>capname</EM> is not
defined for this terminal <EM>type</EM>.
- <EM>other</EM> <STRONG>reset</STRONG> or <STRONG>init</STRONG> may fail to find their respective files. In
+ <EM>other</EM> <STRONG>reset</STRONG> or <STRONG>init</STRONG> may fail to find their respective files. In
that case, the exit code is set to 4 + <STRONG>errno</STRONG>.
Any other exit code indicates an error; see the DIAGNOSTICS section.
</PRE><H2><a name="h2-DIAGNOSTICS">DIAGNOSTICS</a></H2><PRE>
- <STRONG>tput</STRONG> prints the following error messages and sets the corresponding
+ <STRONG>tput</STRONG> prints the following error messages and sets the corresponding
exit codes.
exit code error message
- ---------------------------------------------------------------------
- <STRONG>0</STRONG> (<EM>capname</EM> is a numeric variable that is not specified in
- the <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> database for this terminal type, e.g.
+ ----------------------------------------------------------------------
+ <STRONG>0</STRONG> (<EM>capname</EM> is a numeric variable that is not specified in
+ the <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> database for this terminal type, e.g.
<STRONG>tput</STRONG> <STRONG>-T450</STRONG> <STRONG>lines</STRONG> and <STRONG>tput</STRONG> <STRONG>-Thp2621</STRONG> <STRONG>xmc</STRONG>)
- <STRONG>1</STRONG> no error message is printed, see the <STRONG>EXIT</STRONG> <STRONG>CODES</STRONG> section.
+ <STRONG>1</STRONG> no error message is printed, see the <STRONG>EXIT</STRONG> <STRONG>STATUS</STRONG> section.
<STRONG>2</STRONG> usage error
<STRONG>3</STRONG> unknown terminal <EM>type</EM> or no <STRONG>terminfo</STRONG> database
<STRONG>4</STRONG> unknown <STRONG>terminfo</STRONG> capability <EM>capname</EM>
<STRONG>>4</STRONG> error occurred in -S
- ---------------------------------------------------------------------
+ ----------------------------------------------------------------------
-</PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
- The <STRONG>tput</STRONG> command was begun by Bill Joy in 1980. The initial version
- only cleared the screen.
-
- AT&T System V provided a different <STRONG>tput</STRONG> command:
-
- <STRONG>o</STRONG> SVr2 provided a rudimentary <STRONG>tput</STRONG> which checked the parameter
- against each predefined capability and returned the corresponding
- value. This version of <STRONG>tput</STRONG> did not use <STRONG><A HREF="curs_terminfo.3x.html">tparm(3x)</A></STRONG> for the
- capabilities which are parameterized.
-
- <STRONG>o</STRONG> SVr3 replaced that, a year later, by a more extensive program whose
- <STRONG>init</STRONG> and <STRONG>reset</STRONG> subcommands (more than half the program) were
- incorporated from the <STRONG>reset</STRONG> feature of BSD <STRONG>tset</STRONG> written by Eric
- Allman.
-
- <STRONG>o</STRONG> SVr4 added color initialization using the <STRONG>orig_colors</STRONG> and <STRONG>orig_pair</STRONG>
- capabilities in the <STRONG>init</STRONG> subcommand.
-
- Keith Bostic replaced the BSD <STRONG>tput</STRONG> command in 1989 with a new
- implementation based on the AT&T System V program <STRONG>tput</STRONG>. Like the AT&T
- program, Bostic's version accepted some parameters named for <EM>terminfo</EM>
- capabilities (<STRONG>clear</STRONG>, <STRONG>init</STRONG>, <STRONG>longname</STRONG> and <STRONG>reset</STRONG>). However (because he
- had only <EM>termcap</EM> available), it accepted <EM>termcap</EM> names for other
- capabilities. Also, Bostic's BSD <STRONG>tput</STRONG> did not modify the terminal I/O
- modes as the earlier BSD <STRONG>tset</STRONG> had done.
-
- At the same time, Bostic added a shell script named "clear", which used
- <STRONG>tput</STRONG> to clear the screen.
-
- Both of these appeared in 4.4BSD, becoming the "modern" BSD
- implementation of <STRONG>tput</STRONG>.
+</PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
+ <EM>/usr/share/tabset</EM>
+ tab stop initialization database
- This implementation of <STRONG>tput</STRONG> began from a different source than AT&T or
- BSD: Ross Ridge's <EM>mytinfo</EM> package, published on <EM>comp.sources.unix</EM> in
- December 1992. Ridge's program made more sophisticated use of the
- terminal capabilities than the BSD program. Eric Raymond used that
- <STRONG>tput</STRONG> program (and other parts of <EM>mytinfo</EM>) in ncurses in June 1995.
- Using the portions dealing with terminal capabilities almost without
- change, Raymond made improvements to the way the command-line
- parameters were handled.
+ <EM>/usr/share/terminfo</EM>
+ compiled terminal description database
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
capabilities.
<STRONG>o</STRONG> Other implementations of <STRONG>tput</STRONG> on SVr4-based systems such as
- Solaris, IRIX64 and HPUX as well as others such as AIX and Tru64
+ Solaris, IRIX64 and HP-UX as well as others such as AIX and Tru64
provide support for <EM>capname</EM> operands.
<STRONG>o</STRONG> A few platforms such as FreeBSD recognize termcap names rather than
error, confusing the <STRONG>-1</STRONG> written to the standard output for an
absent or cancelled numeric value versus an (unsigned) exit code.
- The various Unix systems (AIX, HPUX, Solaris) use the same exit-codes
+ The various Unix systems (AIX, HP-UX, Solaris) use the same exit-codes
as ncurses.
NetBSD curses documents different exit codes which do not correspond to
either ncurses or X/Open.
-</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <STRONG><A HREF="clear.1.html">clear(1)</A></STRONG>, <STRONG>stty(1)</STRONG>, <STRONG><A HREF="tabs.1.html">tabs(1)</A></STRONG>, <STRONG><A HREF="tset.1.html">tset(1)</A></STRONG>, <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
+</PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
+ The <STRONG>tput</STRONG> command was begun by Bill Joy in 1980. The initial version
+ only cleared the screen.
+
+ AT&T System V provided a different <STRONG>tput</STRONG> command:
+
+ <STRONG>o</STRONG> SVr2 provided a rudimentary <STRONG>tput</STRONG> which checked the parameter
+ against each predefined capability and returned the corresponding
+ value. This version of <STRONG>tput</STRONG> did not use <STRONG><A HREF="curs_terminfo.3x.html">tparm(3x)</A></STRONG> for the
+ capabilities which are parameterized.
+
+ <STRONG>o</STRONG> SVr3 replaced that, a year later, by a more extensive program whose
+ <STRONG>init</STRONG> and <STRONG>reset</STRONG> subcommands (more than half the program) were
+ incorporated from the <STRONG>reset</STRONG> feature of BSD <STRONG>tset</STRONG> written by Eric
+ Allman.
+
+ <STRONG>o</STRONG> SVr4 added color initialization using the <STRONG>orig_colors</STRONG> and <STRONG>orig_pair</STRONG>
+ capabilities in the <STRONG>init</STRONG> subcommand.
+
+ Keith Bostic replaced the BSD <STRONG>tput</STRONG> command in 1989 with a new
+ implementation based on the AT&T System V program <STRONG>tput</STRONG>. Like the AT&T
+ program, Bostic's version accepted some parameters named for <EM>terminfo</EM>
+ capabilities (<STRONG>clear</STRONG>, <STRONG>init</STRONG>, <STRONG>longname</STRONG> and <STRONG>reset</STRONG>). However (because he
+ had only <EM>termcap</EM> available), it accepted <EM>termcap</EM> names for other
+ capabilities. Also, Bostic's BSD <STRONG>tput</STRONG> did not modify the terminal I/O
+ modes as the earlier BSD <STRONG>tset</STRONG> had done.
+
+ At the same time, Bostic added a shell script named "clear", which used
+ <STRONG>tput</STRONG> to clear the screen.
+
+ Both of these appeared in 4.4BSD, becoming the "modern" BSD
+ implementation of <STRONG>tput</STRONG>.
+
+ This implementation of <STRONG>tput</STRONG> began from a different source than AT&T or
+ BSD: Ross Ridge's <EM>mytinfo</EM> package, published on <EM>comp.sources.unix</EM> in
+ December 1992. Ridge's program made more sophisticated use of the
+ terminal capabilities than the BSD program. Eric Raymond used that
+ <STRONG>tput</STRONG> program (and other parts of <EM>mytinfo</EM>) in ncurses in June 1995.
+ Using the portions dealing with terminal capabilities almost without
+ change, Raymond made improvements to the way the command-line
+ parameters were handled.
+
+
+</PRE><H2><a name="h2-EXAMPLES">EXAMPLES</a></H2><PRE>
+ <STRONG>tput</STRONG> <STRONG>init</STRONG>
+ Initialize the terminal according to the type of terminal in the
+ environmental variable <STRONG>TERM</STRONG>. This command should be included in
+ everyone's .profile after the environmental variable <STRONG>TERM</STRONG> has been
+ exported, as illustrated on the <STRONG>profile(5)</STRONG> manual page.
+
+ <STRONG>tput</STRONG> <STRONG>-T5620</STRONG> <STRONG>reset</STRONG>
+ Reset an AT&T 5620 terminal, overriding the type of terminal in
+ the environmental variable <STRONG>TERM</STRONG>.
+
+ <STRONG>tput</STRONG> <STRONG>cup</STRONG> <STRONG>0</STRONG> <STRONG>0</STRONG>
+ Send the sequence to move the cursor to row <STRONG>0</STRONG>, column <STRONG>0</STRONG> (the upper
+ left corner of the screen, usually known as the "home" cursor
+ position).
+
+ <STRONG>tput</STRONG> <STRONG>clear</STRONG>
+ Echo the clear-screen sequence for the current terminal.
+
+ <STRONG>tput</STRONG> <STRONG>cols</STRONG>
+ Print the number of columns for the current terminal.
- This describes <STRONG>ncurses</STRONG> version 6.3 (patch 20220625).
+ <STRONG>tput</STRONG> <STRONG>-T450</STRONG> <STRONG>cols</STRONG>
+ Print the number of columns for the 450 terminal.
+ <STRONG>bold=`tput</STRONG> <STRONG>smso`</STRONG> <STRONG>offbold=`tput</STRONG> <STRONG>rmso`</STRONG>
+ Set the shell variables <STRONG>bold</STRONG>, to begin stand-out mode sequence,
+ and <STRONG>offbold</STRONG>, to end standout mode sequence, for the current
+ terminal. This might be followed by a prompt: <STRONG>echo</STRONG> <STRONG>"${bold}Please</STRONG>
+ <STRONG>type</STRONG> <STRONG>in</STRONG> <STRONG>your</STRONG> <STRONG>name:</STRONG> <STRONG>${offbold}\c"</STRONG>
+ <STRONG>tput</STRONG> <STRONG>hc</STRONG>
+ Set exit code to indicate if the current terminal is a hard copy
+ terminal.
- <STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>
+ <STRONG>tput</STRONG> <STRONG>cup</STRONG> <STRONG>23</STRONG> <STRONG>4</STRONG>
+ Send the sequence to move the cursor to row 23, column 4.
+
+ <STRONG>tput</STRONG> <STRONG>cup</STRONG>
+ Send the terminfo string for cursor-movement, with no parameters
+ substituted.
+
+ <STRONG>tput</STRONG> <STRONG>longname</STRONG>
+ Print the long name from the <STRONG>terminfo</STRONG> database for the type of
+ terminal specified in the environmental variable <STRONG>TERM</STRONG>.
+
+ <STRONG>tput</STRONG> <STRONG>-S</STRONG> <STRONG><<!</STRONG>
+ <STRONG>></STRONG> <STRONG>clear</STRONG>
+ <STRONG>></STRONG> <STRONG>cup</STRONG> <STRONG>10</STRONG> <STRONG>10</STRONG>
+ <STRONG>></STRONG> <STRONG>bold</STRONG>
+ <STRONG>></STRONG> <STRONG>!</STRONG>
+
+ This example shows <STRONG>tput</STRONG> processing several capabilities in one
+ invocation. It 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 (<STRONG>!</STRONG>) on a line by itself.
+
+
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+ <STRONG><A HREF="clear.1.html">clear(1)</A></STRONG>, <STRONG>stty(1)</STRONG>, <STRONG><A HREF="tabs.1.html">tabs(1)</A></STRONG>, <STRONG><A HREF="tset.1.html">tset(1)</A></STRONG>, <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
+
+
+
+ncurses 6.4 2023-11-25 <STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>
</PRE>
<div class="nav">
<ul>
<li><a href="#h3-Terminal-Size">Terminal Size</a></li>
</ul>
</li>
-<li><a href="#h2-EXAMPLES">EXAMPLES</a></li>
-<li><a href="#h2-FILES">FILES</a></li>
-<li><a href="#h2-EXIT-CODES">EXIT CODES</a></li>
+<li><a href="#h2-EXIT-STATUS">EXIT STATUS</a></li>
<li><a href="#h2-DIAGNOSTICS">DIAGNOSTICS</a></li>
-<li><a href="#h2-HISTORY">HISTORY</a></li>
+<li><a href="#h2-FILES">FILES</a></li>
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-HISTORY">HISTORY</a></li>
+<li><a href="#h2-EXAMPLES">EXAMPLES</a></li>
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
</ul>
</div>
projects / ncurses.git / blobdiff