ncurses 5.9 - patch 20110604

[ncurses.git] / man / tput.1

diff --git a/man/tput.1 b/man/tput.1
index b12385e18f5bb28e454a177373b160a94ce6f8d4..665c71199d281cdc79973c308f5806365f41941f 100644 (file)
--- a/man/tput.1
+++ b/man/tput.1
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
 '\" t
 .\"***************************************************************************

-.\" Copyright (c) 1998-2004,2005 Free Software Foundation, Inc.              *
+.\" Copyright (c) 1998-2006,2010 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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -27,27 +27,27 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: tput.1,v 1.22 2005/01/08 17:44:26 tom Exp $
-.TH tput 1 ""
+.\" $Id: tput.1,v 1.29 2010/12/04 18:41:07 tom Exp $
+.TH @TPUT@ 1 ""

 .ds d @TERMINFO@
 .ds n 1
 .SH NAME
 .ds d @TERMINFO@
 .ds n 1
 .SH NAME

-\fBtput\fR, \fBreset\fR - initialize a terminal or query terminfo database
+\fB@TPUT@\fR, \fBreset\fR \- initialize a terminal or query terminfo database

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fBtput\fR [\fB-T\fR\fItype\fR] \fIcapname\fR [\fIparms\fR ... ]
+\fB@TPUT@\fR [\fB\-T\fR\fItype\fR] \fIcapname\fR [\fIparms\fR ... ]

 .br
 .br

-\fBtput\fR [\fB-T\fR\fItype\fR] \fBinit\fR
+\fB@TPUT@\fR [\fB\-T\fR\fItype\fR] \fBinit\fR

 .br
 .br

-\fBtput\fR [\fB-T\fR\fItype\fR] \fBreset\fR
+\fB@TPUT@\fR [\fB\-T\fR\fItype\fR] \fBreset\fR

 .br
 .br

-\fBtput\fR [\fB-T\fR\fItype\fR] \fBlongname\fR
+\fB@TPUT@\fR [\fB\-T\fR\fItype\fR] \fBlongname\fR

 .br
 .br

-\fBtput -S\fR  \fB<<\fR
+\fB@TPUT@ \-S\fR  \fB<<\fR

 .br
 .br

-\fBtput -V\fR
+\fB@TPUT@ \-V\fR

 .br
 .SH DESCRIPTION
 .br
 .SH DESCRIPTION

-The \fBtput\fR utility uses the \fBterminfo\fR database to make the
+The \fB@TPUT@\fR utility uses the \fBterminfo\fR database to make the

 values of terminal-dependent capabilities and information available to
 the shell (see \fBsh\fR(1)), to initialize or reset the terminal, or
 return the long name of the requested terminal type.
 values of terminal-dependent capabilities and information available to
 the shell (see \fBsh\fR(1)), to initialize or reset the terminal, or
 return the long name of the requested terminal type.


@@ -55,15 +55,15 @@ The result depends upon the capability's type:
 .RS
 .TP 5
 string
 .RS
 .TP 5
 string

-\fBtput\fR writes the string to the standard output.
+\fB@TPUT@\fR writes the string to the standard output.

 No trailing newline is supplied.
 .TP
 integer
 No trailing newline is supplied.
 .TP
 integer

-\fBtput\fR writes the decimal value to the standard output,
+\fB@TPUT@\fR writes the decimal value to the standard output,

 with a trailing newline.
 .TP
 boolean
 with a trailing newline.
 .TP
 boolean

-\fBtput\fR simply sets the exit code
+\fB@TPUT@\fR simply sets the exit code

 (\fB0\fR for TRUE if the terminal has the capability,
 \fB1\fR for FALSE if it does not),
 and writes nothing to the standard output.
 (\fB0\fR for TRUE if the terminal has the capability,
 \fB1\fR for FALSE if it does not),
 and writes nothing to the standard output.


@@ -74,12 +74,12 @@ the application should test the exit code
 (e.g., \fB$?\fR, see \fBsh\fR(1)) to be sure it is \fB0\fR.
 (See the \fBEXIT CODES\fR and \fBDIAGNOSTICS\fR sections.)
 For a complete list of capabilities
 (e.g., \fB$?\fR, see \fBsh\fR(1)) to be sure it is \fB0\fR.
 (See the \fBEXIT CODES\fR and \fBDIAGNOSTICS\fR sections.)
 For a complete list of capabilities

-and the \fIcapname\fR associated with each, see \fBterminfo\fR(\*n).
+and the \fIcapname\fR associated with each, see \fBterminfo\fR(5).

 .TP
 .TP

-\fB-T\fR\fItype\fR
+\fB\-T\fR\fItype\fR

 indicates the \fItype\fR of terminal.  Normally this option is
 unnecessary, because the default is taken from the environment
 indicates the \fItype\fR of terminal.  Normally this option is
 unnecessary, because the default is taken from the environment

-variable \fBTERM\fR.  If \fB-T\fR is specified, then the shell
+variable \fBTERM\fR.  If \fB\-T\fR is specified, then the shell

 variables \fBLINES\fR and \fBCOLUMNS\fR will be ignored,and the
 operating system will not be queried for the actual screen size.
 .TP
 variables \fBLINES\fR and \fBCOLUMNS\fR will be ignored,and the
 operating system will not be queried for the actual screen size.
 .TP


@@ -94,36 +94,52 @@ If the capability is a string that takes parameters, the arguments
 .IP
 Most parameters are numbers.
 Only a few terminfo capabilities require string parameters;
 .IP
 Most parameters are numbers.
 Only a few terminfo capabilities require string parameters;

-\fBtput\fR uses a table to decide which to pass as strings.
-Normally \fBtput\fR uses \fBtparm\fR (3X) to perform the substitution.
+\fB@TPUT@\fR uses a table to decide which to pass as strings.
+Normally \fB@TPUT@\fR uses \fBtparm\fR (3X) to perform the substitution.

 If no parameters are given for the capability,
 If no parameters are given for the capability,

-\fBtput\fR writes the string without performing the substitution.
+\fB@TPUT@\fR writes the string without performing the substitution.

 .TP
 .TP

-\fB-S\fR
-allows more than one capability per invocation of \fBtput\fR.  The
-capabilities must be passed to \fBtput\fR from the standard input
+\fB\-S\fR
+allows more than one capability per invocation of \fB@TPUT@\fR.  The
+capabilities must be passed to \fB@TPUT@\fR from the standard input

 instead of from the command line (see example).
 Only one \fIcapname\fR is allowed per line.
 instead of from the command line (see example).
 Only one \fIcapname\fR is allowed per line.

-The \fB-S\fR option changes the
+The \fB\-S\fR option changes the

 meaning of the \fB0\fR and \fB1\fR boolean and string exit codes (see the
 EXIT CODES section).
 .IP
 meaning of the \fB0\fR and \fB1\fR boolean and string exit codes (see the
 EXIT CODES section).
 .IP

-Again, \fBtput\fR uses a table and the presence of parameters in its input
+Again, \fB@TPUT@\fR uses a table and the presence of parameters in its input

 to decide whether to use \fBtparm\fR (3X),
 and how to interpret the parameters.
 .TP
 to decide whether to use \fBtparm\fR (3X),
 and how to interpret the parameters.
 .TP

-\fB-V\fR
+\fB\-V\fR

 reports the version of ncurses which was used in this program, and exits.
 .TP
 \fBinit\fR
 If the \fBterminfo\fR database is present and an entry for the user's
 reports the version of ncurses which was used in this program, and exits.
 .TP
 \fBinit\fR
 If the \fBterminfo\fR database is present and an entry for the user's

-terminal exists (see \fB-T\fR\fItype\fR, above), the following will
-occur: (1) if present, the terminal's initialization strings will be
-output (\fBis1\fR, \fBis2\fR, \fBis3\fR, \fBif\fR, \fBiprog\fR), (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
+terminal exists (see \fB\-T\fR\fItype\fR, above), the following will
+occur:
+.RS
+.TP
+(1)
+if present, the terminal's initialization strings will be
+output as detailed in the \fBterminfo\fR(5) section on
+.IR "Tabs and Initialization" ,
+.TP
+(2)
+any delays (e.g., newline) specified in the entry will
+be set in the tty driver,
+.TP
+(3)
+tabs expansion will be turned on or off according to
+the specification in the entry, and
+.TP
+(4)
+if tabs are not expanded,
+standard tabs will be set (every 8 spaces).
+.RE
+.IP
+If an entry does not

 contain the information needed for any of the four above activities,
 that activity will silently be skipped.
 .TP
 contain the information needed for any of the four above activities,
 that activity will silently be skipped.
 .TP


@@ -136,63 +152,63 @@ Otherwise, \fBreset\fR acts identically to \fBinit\fR.
 .TP
 \fBlongname\fR
 If the \fBterminfo\fR database is present and an entry for the
 .TP
 \fBlongname\fR
 If the \fBterminfo\fR database is present and an entry for the

-user's terminal exists (see \fB-T\fR\fItype\fR above), then the long name
+user's terminal exists (see \fB\-T\fR\fItype\fR 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
 \fBterminfo\fR database [see \fBterm\fR(5)].
 .PP
 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
 \fBterminfo\fR database [see \fBterm\fR(5)].
 .PP

-If \fBtput\fR is invoked by a link named \fBreset\fR, this has the
-same effect as \fBtput reset\fR.
+If \fB@TPUT@\fR is invoked by a link named \fBreset\fR, this has the
+same effect as \fB@TPUT@ reset\fR.

 See \fBtset\fR for comparison, which has similar behavior.
 .SH EXAMPLES
 .TP 5
 See \fBtset\fR for comparison, which has similar behavior.
 .SH EXAMPLES
 .TP 5

-\fBtput init\fR
+\fB@TPUT@ init\fR

 Initialize the terminal according to the type of
 terminal in the environmental variable \fBTERM\fR.  This
 command should be included in everyone's .profile after
 the environmental variable \fBTERM\fR has been exported, as
 illustrated on the \fBprofile\fR(5) manual page.
 .TP 5
 Initialize the terminal according to the type of
 terminal in the environmental variable \fBTERM\fR.  This
 command should be included in everyone's .profile after
 the environmental variable \fBTERM\fR has been exported, as
 illustrated on the \fBprofile\fR(5) manual page.
 .TP 5

-\fBtput -T5620 reset\fR
+\fB@TPUT@ \-T5620 reset\fR

 Reset an AT&T 5620 terminal, overriding the type of
 terminal in the environmental variable \fBTERM\fR.
 .TP 5
 Reset an AT&T 5620 terminal, overriding the type of
 terminal in the environmental variable \fBTERM\fR.
 .TP 5

-\fBtput cup 0 0\fR
+\fB@TPUT@ cup 0 0\fR

 Send the sequence to move the cursor to row \fB0\fR, column \fB0\fR
 (the upper left corner of the screen, usually known as the "home"
 cursor position).
 .TP 5
 Send the sequence to move the cursor to row \fB0\fR, column \fB0\fR
 (the upper left corner of the screen, usually known as the "home"
 cursor position).
 .TP 5

-\fBtput clear\fR
+\fB@TPUT@ clear\fR

 Echo the clear-screen sequence for the current terminal.
 .TP 5
 Echo the clear-screen sequence for the current terminal.
 .TP 5

-\fBtput cols\fR
+\fB@TPUT@ cols\fR

 Print the number of columns for the current terminal.
 .TP 5
 Print the number of columns for the current terminal.
 .TP 5

-\fBtput -T450 cols\fR
+\fB@TPUT@ \-T450 cols\fR

 Print the number of columns for the 450 terminal.
 .TP 5
 Print the number of columns for the 450 terminal.
 .TP 5

-\fBbold=`tput smso` offbold=`tput rmso`\fR
+\fBbold=`@TPUT@ smso` offbold=`@TPUT@ rmso`\fR

 Set the shell variables \fBbold\fR, to begin stand-out mode
 sequence, and \fBoffbold\fR, to end standout mode sequence,
 for the current terminal.  This might be followed by a
 prompt: \fBecho "${bold}Please type in your name: ${offbold}\\c"\fR
 .TP 5
 Set the shell variables \fBbold\fR, to begin stand-out mode
 sequence, and \fBoffbold\fR, to end standout mode sequence,
 for the current terminal.  This might be followed by a
 prompt: \fBecho "${bold}Please type in your name: ${offbold}\\c"\fR
 .TP 5

-\fBtput hc\fR
+\fB@TPUT@ hc\fR

 Set exit code to indicate if the current terminal is a hard copy terminal.
 .TP 5
 Set exit code to indicate if the current terminal is a hard copy terminal.
 .TP 5

-\fBtput cup 23 4\fR
+\fB@TPUT@ cup 23 4\fR

 Send the sequence to move the cursor to row 23, column 4.
 .TP 5
 Send the sequence to move the cursor to row 23, column 4.
 .TP 5

-\fBtput cup\fR
+\fB@TPUT@ cup\fR

 Send the terminfo string for cursor-movement, with no parameters substituted.
 .TP 5
 Send the terminfo string for cursor-movement, with no parameters substituted.
 .TP 5

-\fBtput longname\fR
+\fB@TPUT@ longname\fR

 Print the long name from the \fBterminfo\fR database for the
 type of terminal specified in the environmental
 variable \fBTERM\fR.
 .PP
 .RS 5
 Print the long name from the \fBterminfo\fR database for the
 type of terminal specified in the environmental
 variable \fBTERM\fR.
 .PP
 .RS 5

-\fBtput -S <<!\fR
+\fB@TPUT@ \-S <<!\fR

 .br
 \fB> clear\fR
 .br
 .br
 \fB> clear\fR
 .br


@@ -204,7 +220,7 @@ variable \fBTERM\fR.
 .RE
 .TP 5
 \&
 .RE
 .TP 5
 \&

-This example shows \fBtput\fR processing several capabilities in one invocation.
+This example shows \fB@TPUT@\fR processing several capabilities in one invocation.

 It clears the screen,
 moves the cursor to position 10, 10
 and turns on bold (extra bright) mode.
 It clears the screen,
 moves the cursor to position 10, 10
 and turns on bold (extra bright) mode.


@@ -221,15 +237,15 @@ sequences that set margins and tabs); for more
 information, see the "Tabs and Initialization"
 section of \fBterminfo\fR(5)
 .SH EXIT CODES
 information, see the "Tabs and Initialization"
 section of \fBterminfo\fR(5)
 .SH EXIT CODES

-If the \fB-S\fR option is used,
-\fBtput\fR checks for errors from each line,
+If the \fB\-S\fR option is used,
+\fB@TPUT@\fR 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 \fB0\fR.
 No indication of which line failed can be given so
 exit code \fB1\fR will never appear.  Exit codes \fB2\fR, \fB3\fR, and
 \fB4\fR retain their usual interpretation.
 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 \fB0\fR.
 No indication of which line failed can be given so
 exit code \fB1\fR will never appear.  Exit codes \fB2\fR, \fB3\fR, and
 \fB4\fR retain their usual interpretation.

-If the \fB-S\fR option is not used,
+If the \fB\-S\fR option is not used,

 the exit code depends on the type of \fIcapname\fR:
 .RS 5
 .TP
 the exit code depends on the type of \fIcapname\fR:
 .RS 5
 .TP


@@ -249,7 +265,7 @@ a value of \fB0\fR is always set,
 whether or not \fIcapname\fR is defined for this terminal \fItype\fR.
 To determine if \fIcapname\fR is defined for this terminal \fItype\fR,
 the user must test the value written to standard output.
 whether or not \fIcapname\fR is defined for this terminal \fItype\fR.
 To determine if \fIcapname\fR is defined for this terminal \fItype\fR,
 the user must test the value written to standard output.

-A value of \fB-1\fR
+A value of \fB\-1\fR

 means that \fIcapname\fR is not defined for this terminal \fItype\fR.
 .TP
 .I other
 means that \fIcapname\fR is not defined for this terminal \fItype\fR.
 .TP
 .I other


@@ -269,28 +285,35 @@ exit code error message
 =
 \fB0\fR        T{
 (\fIcapname\fR is a numeric variable that is not specified in the
 =
 \fB0\fR        T{
 (\fIcapname\fR is a numeric variable that is not specified in the

-\fBterminfo\fR(\*n) database for this terminal type, e.g.
-\fBtput -T450 lines\fR and \fBtput -T2621 xmc\fR)
+\fBterminfo\fR(5) database for this terminal type, e.g.
+\fB@TPUT@ \-T450 lines\fR and \fB@TPUT@ \-T2621 xmc\fR)

 T}
 \fB1\fR        no error message is printed, see the \fBEXIT CODES\fR section.
 \fB2\fR        usage error
 \fB3\fR        unknown terminal \fItype\fR or no \fBterminfo\fR database
 \fB4\fR        unknown \fBterminfo\fR capability \fIcapname\fR
 T}
 \fB1\fR        no error message is printed, see the \fBEXIT CODES\fR section.
 \fB2\fR        usage error
 \fB3\fR        unknown terminal \fItype\fR or no \fBterminfo\fR database
 \fB4\fR        unknown \fBterminfo\fR capability \fIcapname\fR

-\fB>4\fR       error occurred in -S
+\fB>4\fR       error occurred in \-S

 =
 .TE
 .SH PORTABILITY
 =
 .TE
 .SH PORTABILITY

-The \fBlongname\fR and \fB-S\fR options, and the parameter-substitution
+.PP
+The \fBlongname\fR and \fB\-S\fR options, and the parameter-substitution

 features used in the \fBcup\fR example, are not supported in BSD curses or in
 AT&T/USL curses before SVr4.
 features used in the \fBcup\fR example, are not supported in BSD curses or in
 AT&T/USL curses before SVr4.

+.PP
+X/Open documents only the operands for \fBclear\fP, \fBinit\fP and \fBreset\fP.
+In this implementation, \fBclear\fP is part of the \fIcapname\fR support.
+Other implementations of \fBtput\fP on
+SVr4-based systems such as Solaris, IRIX64 and HPUX
+as well as others such as AIX and Tru64
+provide support for \fIcapname\fR operands.
+A few platforms such as FreeBSD and NetBSD recognize termcap names rather
+than terminfo capability names in their respective \fBtput\fP commands.

 .SH SEE ALSO
 \fB@CLEAR@\fR(1),
 \fBstty\fR(1),
 \fBtabs\fR(\*n),
 \fBterminfo\fR(5).
 .SH SEE ALSO
 \fB@CLEAR@\fR(1),
 \fBstty\fR(1),
 \fBtabs\fR(\*n),
 \fBterminfo\fR(5).

-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End:
+.PP
+This describes \fBncurses\fR
+version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).