X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Ftput.1.html;h=14d548c8f0958d8e8d0b9857176f4d7e9e6e47a9;hp=b00f3f707fe6a6eff999b42575b186eed64bbd7a;hb=f367fa254ce3fe29710c86971f04e03111c2bd2c;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8;ds=sidebyside
diff --git a/doc/html/man/tput.1.html b/doc/html/man/tput.1.html
index b00f3f70..14d548c8 100644
--- a/doc/html/man/tput.1.html
+++ b/doc/html/man/tput.1.html
@@ -2,7 +2,7 @@
@@ -89,7 +89,7 @@
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
@@ -132,33 +132,43 @@
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.
@@ -167,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
@@ -194,16 +204,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 +221,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 +231,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 +245,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,38 +254,38 @@
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
- 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.
@@ -287,8 +297,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
@@ -300,14 +310,37 @@
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
+ operands.
+
+ 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
+ operands 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 20120107).