X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Ftput.1.html;h=7712744b35365fccee759d8efd6c71c00fc78afd;hp=b00f3f707fe6a6eff999b42575b186eed64bbd7a;hb=e6f4ffe150c7d919792f29a70b4f031cfab5ef06;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8
diff --git a/doc/html/man/tput.1.html b/doc/html/man/tput.1.html
index b00f3f70..7712744b 100644
--- a/doc/html/man/tput.1.html
+++ b/doc/html/man/tput.1.html
@@ -1,8 +1,8 @@
-
+
@@ -89,59 +89,68 @@
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(1).
+ 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
from the environment variable TERM. If -T is spec-
ified, then the shell variables LINES and COLUMNS
- will be ignored,and the operating system will not
- be queried for the actual screen size.
+ will also be ignored.
capname
- indicates the capability from the terminfo
- database. When termcap support is compiled in, the
+ 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-
+ 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
+ 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.
+ tput uses tparm (3x) to perform the substitution.
If no parameters are given for the capability, tput
- writes the string without performing the
- substitution.
+ writes the string without performing the substitu-
+ tion.
- -S allows more than one capability per invocation of
+ -S allows more than one capability per invocation of
tput. The capabilities must be passed to tput from
the standard input instead of from the command line
- (see example). Only one capname is allowed per
- line. The -S option changes the meaning of the 0
- and 1 boolean and string exit codes (see the EXIT
+ (see example). Only one capname is allowed per
+ line. The -S option changes the meaning of the 0
+ and 1 boolean and string exit codes (see the EXIT
CODES section).
Again, tput uses a table and the presence of param-
- eters in its input to decide whether to use tparm
+ 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
+ -V reports the version of ncurses which was used in
this program, and exits.
- init If the terminfo database is present and an entry
+ 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.
+ 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
@@ -194,16 +203,16 @@
bold=`tput smso` offbold=`tput rmso`
Set the shell variables bold, to begin stand-out mode
sequence, and offbold, to end standout mode sequence,
- for the current terminal. This might be followed by
- a prompt: echo "${bold}Please type in your name:
+ for the current terminal. This might be followed by
+ a prompt: echo "${bold}Please type in your name:
${offbold}\c"
tput hc
- Set exit code to indicate if the current terminal is
+ Set exit code to indicate if the current terminal is
a hard copy terminal.
tput cup 23 4
- Send the sequence to move the cursor to row 23, col-
+ Send the sequence to move the cursor to row 23, col-
umn 4.
tput cup
@@ -211,8 +220,8 @@
parameters substituted.
tput longname
- Print the long name from the terminfo database for
- the type of terminal specified in the environmental
+ Print the long name from the terminfo database for
+ the type of terminal specified in the environmental
variable TERM.
tput -S <<!
@@ -221,10 +230,10 @@
> bold
> !
- This example shows tput processing several capabili-
- ties 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
+ This example shows tput processing several capabili-
+ ties 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 (!) on a line by itself.
@@ -235,8 +244,8 @@
/usr/share/tabset/*
tab settings for some terminals, in a format appro-
- priate to be output to the terminal (escape
- sequences that set margins and tabs); for more
+ priate to be output to the terminal (escape
+ sequences that set margins and tabs); for more
information, see the "Tabs and Initialization" sec-
tion of terminfo(5)
@@ -244,16 +253,16 @@
EXIT CODES
If the -S option is used, tput 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 0. No indication of which
+ 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 0. No indication of which
line failed can be given so exit code 1 will never appear.
- Exit codes 2, 3, and 4 retain their usual interpretation.
+ Exit codes 2, 3, and 4 retain their usual interpretation.
If the -S option is not used, the exit code depends on the
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
@@ -284,11 +293,10 @@
tput prints the following error messages and sets the cor-
responding exit codes.
-
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.
+ 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
@@ -304,10 +312,33 @@
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 recognize term-
+ cap names rather than terminfo capability names in their
+ respective tput commands.
+
+ Most implementations which provide support for capname op-
+ erands use the tparm function to expand parameters in it.
+ That function expects a mixture of numeric and string
+ parameters, requiring tput to know which type to use.
+ This implementation uses a table to determine that for the
+ standard capname operands, and an internal library func-
+ tion to analyze nonstandard capname operands. Other
+ implementations may simply guess that an operand contain-
+ ing only digits is intended to be a number.
+
SEE ALSO
- clear(1), stty(1), tabs(1), terminfo(5).
+ clear(1), stty(1), tabs(1), terminfo(5), curs_termcap(3x).
+
+ This describes ncurses version 5.9 (patch 20130518).