X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Ftput.1.html;h=d380a282b953cd7574196ffe5d992a1a77dcad94;hp=ec8281ab03def906f50f6799d4d2a6f144273ff3;hb=77afe78361875f531dc2bf8d73f2e781c8e76176;hpb=a8987e73ec254703634802b4f7ee30d3a485524d
diff --git a/doc/html/man/tput.1.html b/doc/html/man/tput.1.html
index ec8281ab..d380a282 100644
--- a/doc/html/man/tput.1.html
+++ b/doc/html/man/tput.1.html
@@ -2,7 +2,7 @@
@@ -41,7 +41,7 @@
-tput(1) tput(1)
+tput(1) tput(1)
@@ -68,17 +68,28 @@
values of terminal-dependent capabilities and information
available to the shell (see sh(1)), to initialize or reset
the terminal, or return the long name of the requested
- terminal type. tput outputs a string if the attribute
- (capability name) is of type string, or an integer if the
- attribute is of type integer. If the attribute is of type
- boolean, tput simply sets the exit code (0 for TRUE if the
- terminal has the capability, 1 for FALSE if it does not),
- and produces no output. Before using a value returned on
- standard output, the user should test the exit code [$?,
- see sh(1)] to be sure it is 0. (See the EXIT CODES and
- DIAGNOSTICS sections.) For a complete list of capabili-
- ties and the capname associated with each, see ter-
- minfo(1).
+ terminal type. The result depends upon the capability's
+ type:
+
+ string
+ tput writes the string to the standard output.
+ No trailing newline is supplied.
+
+ integer
+ tput writes the decimal value to the standard
+ output, with a trailing newline.
+
+ boolean
+ tput simply sets the exit code (0 for TRUE if
+ the terminal has the capability, 1 for FALSE
+ if it does not), and writes nothing to the
+ standard output.
+
+ Before using a value returned on the standard output, the
+ application should test the exit code (e.g., $?, see
+ sh(1)) to be sure it is 0. (See the EXIT CODES and DIAG-
+ NOSTICS sections.) For a complete list of capabilities
+ and the capname associated with each, see terminfo(5).
-Ttype indicates the type of terminal. Normally this
option is unnecessary, because the default is taken
@@ -88,21 +99,21 @@
be queried for the actual screen size.
capname
- indicates the attribute from the terminfo database.
- When termcap support is compiled in, the termcap
- name for the attribute is also accepted.
-
- parms If the attribute is a string that takes parameters,
- the arguments parms will be instantiated into the
- string. An all-numeric argument will be passed to
- the attribute as a number.
-
- Only a few terminfo capabilities require string
- parameters; tput uses a table to decide which to
- pass as strings. Normally tput uses tparm (3x) to
- perform the substitution. If no parameters are
- given for the attribute, tput writes the string
- without performing the substitution.
+ indicates the capability from the terminfo data-
+ base. When termcap support is compiled in, the
+ termcap name for the capability is also accepted.
+
+ parms If the capability is a string that takes parame-
+ ters, the arguments parms will be instantiated into
+ the string.
+
+ Most parameters are numbers. Only a few terminfo
+ capabilities require string parameters; tput uses a
+ table to decide which to pass as strings. Normally
+ tput uses tparm (3x) to perform the substitution.
+ If no parameters are given for the capability, tput
+ writes the string without performing the substitu-
+ tion.
-S allows more than one capability per invocation of
tput. The capabilities must be passed to tput from
@@ -112,42 +123,52 @@
and 1 boolean and string exit codes (see the EXIT
CODES section).
- Again, tput uses a table and the presence of
- parameters in its input to decide whether to use
- tparm (3x), and how to interpret the parameters.
+ Again, tput uses a table and the presence of param-
+ eters in its input to decide whether to use tparm
+ (3x), and how to interpret the parameters.
-V reports the version of ncurses which was used in
this program, and exits.
init If the terminfo database is present and an entry
for the user's terminal exists (see -Ttype, above),
- the following will occur: (1) if present, the ter-
- minal's initialization strings will be output (is1,
- is2, is3, if, iprog), (2) any delays (e.g., new-
- line) specified in the entry will be set in the tty
- driver, (3) tabs expansion will be turned on or off
- according to the specification in the entry, and
- (4) if tabs are not expanded, standard tabs will be
- set (every 8 spaces). If an entry does not contain
- the information needed for any of the four above
- activities, that activity will silently be skipped.
-
- reset Instead of putting out initialization strings, the
- terminal's reset strings will be output if present
- (rs1, rs2, rs3, rf). If the reset strings are not
- present, but initialization strings are, the ini-
- tialization strings will be output. Otherwise,
+ the following will occur:
+
+ (1) if present, the terminal's initialization
+ strings will be output as detailed in the
+ terminfo(5) section on Tabs and Initializa-
+ tion,
+
+ (2) any delays (e.g., newline) specified in the
+ entry will be set in the tty driver,
+
+ (3) tabs expansion will be turned on or off
+ according to the specification in the entry,
+ and
+
+ (4) if tabs are not expanded, standard tabs will
+ be set (every 8 spaces).
+
+ If an entry does not contain the information needed
+ for any of the four above activities, that activity
+ will silently be skipped.
+
+ reset Instead of putting out initialization strings, the
+ terminal's reset strings will be output if present
+ (rs1, rs2, rs3, rf). If the reset strings are not
+ present, but initialization strings are, the ini-
+ tialization strings will be output. Otherwise,
reset acts identically to init.
longname
- If the terminfo database is present and an entry
- for the user's terminal exists (see -Ttype above),
+ If the terminfo database is present and an entry
+ for the user's terminal exists (see -Ttype 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 terminfo database
[see term(5)].
- If tput is invoked by a link named reset, this has the
+ If tput is invoked by a link named reset, this has the
same effect as tput reset. See tset for comparison, which
has similar behavior.
@@ -156,13 +177,13 @@
EXAMPLES
tput init
Initialize the terminal according to the type of ter-
- minal in the environmental variable TERM. This com-
- mand should be included in everyone's .profile after
+ minal in the environmental variable TERM. This com-
+ mand should be included in everyone's .profile after
the environmental variable TERM has been exported, as
illustrated on the profile(5) manual page.
tput -T5620 reset
- Reset an AT&T 5620 terminal, overriding the type of
+ Reset an AT&T 5620 terminal, overriding the type of
terminal in the environmental variable TERM.
tput cup 0 0
@@ -222,12 +243,6 @@
/usr/share/terminfo
compiled terminal description database
- /usr/include/curses.h
- curses(3x) header file
-
- /usr/include/term.h
- terminfo header file
-
/usr/share/tabset/*
tab settings for some terminals, in a format appro-
priate to be output to the terminal (escape
@@ -248,29 +263,29 @@
type of capname:
boolean
- a value of 0 is set for TRUE and 1 for FALSE.
+ a value of 0 is set for TRUE and 1 for FALSE.
- string a value of 0 is set if the capname is defined
- for this terminal type (the value of capname
- is returned on standard output); a value of 1
+ string a value of 0 is set if the capname is defined
+ for this terminal type (the value of capname
+ is returned on standard output); a value of 1
is set if capname is not defined for this ter-
- minal type (nothing is written to standard
+ minal type (nothing is written to standard
output).
integer
- a value of 0 is always set, whether or not
+ a value of 0 is always set, whether or not
capname is defined for this terminal type. To
- determine if capname is defined for this ter-
+ determine if capname is defined for this ter-
minal type, the user must test the value writ-
- ten to standard output. A value of -1 means
- that capname is not defined for this terminal
+ ten to standard output. A value of -1 means
+ that capname is not defined for this terminal
type.
- other reset or init may fail to find their respec-
- tive files. In that case, the exit code is
+ other reset or init may fail to find their respec-
+ tive files. In that case, the exit code is
set to 4 + errno.
- Any other exit code indicates an error; see the DIAGNOS-
+ Any other exit code indicates an error; see the DIAGNOS-
TICS section.
@@ -281,8 +296,8 @@
exit code error message
---------------------------------------------------------------------
- 0 (capname is a numeric variable that is not specified in
- the terminfo(1) database for this terminal type, e.g.
+ 0 (capname is a numeric variable that is not specified in
+ the terminfo(5) database for this terminal type, e.g.
tput -T450 lines and tput -T2621 xmc)
1 no error message is printed, see the EXIT CODES section.
2 usage error
@@ -294,18 +309,29 @@
PORTABILITY
- The longname and -S options, and the parameter-substitu-
- tion features used in the cup example, are not supported
+ The longname and -S options, and the parameter-substitu-
+ tion features used in the cup example, are not supported
in BSD curses or in AT&T/USL curses before SVr4.
+ X/Open documents only the operands for clear, init and
+ reset. In this implementation, clear is part of the cap-
+ name support. Other implementations of tput on SVr4-based
+ systems such as Solaris, IRIX64 and HPUX as well as others
+ such as AIX and Tru64 provide support for capname oper-
+ ands. A few platforms such as FreeBSD and NetBSD recog-
+ nize termcap names rather than terminfo capability names
+ in their respective tput commands.
+
SEE ALSO
clear(1), stty(1), tabs(1), terminfo(5).
+ This describes ncurses version 5.7 (patch 20100109).
+
- tput(1)
+ tput(1)