<!--
* t
****************************************************************************
- * Copyright (c) 1998-2012,2016 Free Software Foundation, Inc. *
+ * Copyright (c) 1998-2016,2017 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: tput.1,v 1.46 2016/10/22 19:57:25 tom Exp @
+ * @Id: tput.1,v 1.52 2017/01/21 17:38:30 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
Again, <STRONG>tput</STRONG> uses a table and the presence of param-
eters in its input to decide whether to use
- <STRONG><A HREF="tparm.3x.html">tparm(3x)</A></STRONG>, and how to interpret the parameters.
+ <STRONG><A HREF="curs_terminfo.3x.html">tparm(3x)</A></STRONG>, and how to interpret the parameters.
<STRONG>-V</STRONG> reports the version of ncurses which was used in
this program, and exits.
</PRE><H3><a name="h3-Commands">Commands</a></H3><PRE>
<EM>capname</EM>
- indicates the capability from the <STRONG>terminfo</STRONG> data-
- base. When <STRONG>termcap</STRONG> support is compiled in, the
- <STRONG>termcap</STRONG> name for the capability is also accepted.
+ indicates the capability from the terminal data-
+ base.
- If the capability is a string that takes parame-
- ters, the arguments following the capability will
+ If the capability is a string that takes parame-
+ ters, the arguments following the capability will
be used as parameters for the string.
- Most parameters are numbers. Only a few terminfo
+ 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="tparm.3x.html">tparm(3x)</A></STRONG> to perform the substitution.
+ <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 substitu-
+ writes the string without performing the substitu-
tion.
- <STRONG>init</STRONG> If the <STRONG>terminfo</STRONG> database is present and an entry
+ <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) if present, the terminal's initialization
- strings will be output as detailed in the <STRONG>ter-</STRONG>
- <STRONG><A HREF="terminfo.5.html">minfo(5)</A></STRONG> section on <EM>Tabs</EM> <EM>and</EM> <EM>Initialization</EM>,
+ (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> standard output,
+
+ <STRONG>o</STRONG> standard input and
+
+ <STRONG>o</STRONG> ultimately "/dev/tty"
+
+ to obtain terminal settings. Having retrieved
+ these settings, <STRONG>tput</STRONG> remembers which file
+ descriptor to use when updating settings.
- (2) any delays (e.g., newline) specified in the
- entry will be set in the tty driver,
+ (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> vari-
+ ables specify this), update the operating sys-
+ tem's notion of the window size.
- (3) tabs expansion will be turned on or off
- according to the specification in the entry,
- and
+ (3) the terminal modes will be updated:
- (4) if tabs are not expanded, standard tabs will
- be set (every 8 spaces).
+ <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 the specification in the
+ entry, and
+
+ <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>ter-</STRONG>
+ <STRONG><A HREF="terminfo.5.html">minfo(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 these activities, that activity will
+ for any of these activities, that activity will
silently be skipped.
- <STRONG>reset</STRONG> Instead of putting out initialization strings, the
- terminal's reset strings will be output if present
- (<STRONG>rs1</STRONG>, <STRONG>rs2</STRONG>, <STRONG>rs3</STRONG>, <STRONG>rf</STRONG>). If the reset strings are not
- present, but initialization strings are, the ini-
- tialization strings will be output. Otherwise,
- <STRONG>reset</STRONG> acts identically to <STRONG>init</STRONG>.
+ <STRONG>reset</STRONG> This is similar to <STRONG>init</STRONG>, with two differences:
+
+ (1) before any other initialization, the terminal
+ modes will be reset to a "sane" state:
+
+ <STRONG>o</STRONG> set cooked and echo modes,
+
+ <STRONG>o</STRONG> turn off cbreak and raw modes,
+
+ <STRONG>o</STRONG> turn on newline translation and
+
+ <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 <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 <STRONG>terminfo</STRONG> database is present and an entry
- for the user's terminal exists (see <STRONG>-T</STRONG><EM>type</EM> above),
+ 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
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
+ 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
+ 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
+ <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 capa-
- bilities for resetting the terminal was more limited,
+ bilities 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 difference with resetting terminal
+ <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 programs is (mostly) the same. A few differ-
+ ences remain:
+
+ <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 standard output for <STRONG>tput</STRONG>).
+
+ <STRONG>Note:</STRONG> although these programs write to different
+ streams, redirecting their output to a file will cap-
+ ture 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 <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
AT&T System V provided a different <STRONG>tput</STRONG> command, 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> writ-
- ten by Eric Allman. Later the corresponding source code
- for <EM>reset</EM> was removed from the BSD <STRONG>tset</STRONG> (in June 1993,
- released in 4.4BSD-Lite a year later).
+ ten by Eric Allman.
Keith Bostic replaced the BSD <STRONG>tput</STRONG> command in 1989 with a
new implementation based on the AT&T System V program
an internal library function to analyze nonstandard
<EM>capname</EM> operands.
+ This implementation (unlike others) can accept both <EM>term-</EM>
+ <EM>cap</EM> and <EM>terminfo</EM> names for the <EM>capname</EM> feature, if <EM>termcap</EM>
+ support is compiled in. However, the predefined <EM>termcap</EM>
+ and <EM>terminfo</EM> names have two ambiguities in this case (and
+ the <EM>terminfo</EM> name is assumed):
+
+ <STRONG>o</STRONG> The <EM>termcap</EM> name <STRONG>dl</STRONG> corresponds to the <EM>terminfo</EM> name
+ <STRONG>dl1</STRONG> (delete one line).
+ The <EM>terminfo</EM> name <STRONG>dl</STRONG> corresponds to the <EM>termcap</EM> name
+ <STRONG>DL</STRONG> (delete a given number of lines).
+
+ <STRONG>o</STRONG> The <EM>termcap</EM> name <STRONG>ed</STRONG> corresponds to the <EM>terminfo</EM> name
+ <STRONG>rmdc</STRONG> (end delete mode).
+ The <EM>terminfo</EM> name <STRONG>ed</STRONG> corresponds to the <EM>termcap</EM> name
+ <STRONG>cd</STRONG> (clear to end of screen).
+
The <STRONG>longname</STRONG> and <STRONG>-S</STRONG> options, and the parameter-substitu-
tion features used in the <STRONG>cup</STRONG> example, were not supported
in BSD curses before 4.3reno (1989) or in AT&T/USL curses
<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="terminfo.5.html">terminfo(5)</A></STRONG>,
<STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>.
- This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20161224).
+ This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20170121).
projects / ncurses.git / blobdiff