doc/html/man/tput.1.html

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright (c) 1998-2011,2012 Free Software Foundation, Inc.              *
   5   *                                                                          *
   6   * Permission is hereby granted, free of charge, to any person obtaining a  *
   7   * copy of this software and associated documentation files (the            *
   8   * "Software"), to deal in the Software without restriction, including      *
   9   * without limitation the rights to use, copy, modify, merge, publish,      *
  10   * distribute, distribute with modifications, sublicense, and/or sell       *
  11   * copies of the Software, and to permit persons to whom the Software is    *
  12   * furnished to do so, subject to the following conditions:                 *
  13   *                                                                          *
  14   * The above copyright notice and this permission notice shall be included  *
  15   * in all copies or substantial portions of the Software.                   *
  16   *                                                                          *
  17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24   *                                                                          *
  25   * Except as contained in this notice, the name(s) of the above copyright   *
  26   * holders shall not be used in advertising or otherwise to promote the     *
  27   * sale, use or other dealings in this Software without prior written       *
  28   * authorization.                                                           *
  29   ****************************************************************************
  30   * @Id: tput.1,v 1.32 2012/07/14 21:06:45 tom Exp @
  31 -->
  32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  33 <HTML>
  34 <HEAD>
  35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>tput 1</TITLE>
  38 <link rev=made href="mailto:bug-ncurses@gnu.org">
  39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">tput 1</H1>
  43 <PRE>
  44 <STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>                                                         <STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>tput</STRONG>,  <STRONG>reset</STRONG>  -  initialize  a  terminal or query terminfo
  51        database
  52
  53
  54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  55        <STRONG>tput</STRONG> [<STRONG>-T</STRONG><EM>type</EM>] <EM>capname</EM> [<EM>parms</EM> ... ]
  56        <STRONG>tput</STRONG> [<STRONG>-T</STRONG><EM>type</EM>] <STRONG>init</STRONG>
  57        <STRONG>tput</STRONG> [<STRONG>-T</STRONG><EM>type</EM>] <STRONG>reset</STRONG>
  58        <STRONG>tput</STRONG> [<STRONG>-T</STRONG><EM>type</EM>] <STRONG>longname</STRONG>
  59        <STRONG>tput</STRONG> <STRONG>-S</STRONG>  <STRONG>&lt;&lt;</STRONG>
  60        <STRONG>tput</STRONG> <STRONG>-V</STRONG>
  61
  62
  63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  64        The <STRONG>tput</STRONG> utility uses the <STRONG>terminfo</STRONG> database  to  make  the
  65        values  of terminal-dependent capabilities and information
  66        available to the shell (see <STRONG>sh(1)</STRONG>), to initialize or reset
  67        the  terminal,  or  return  the long name of the requested
  68        terminal type.  The result depends upon  the  capability's
  69        type:
  70
  71               string
  72                    <STRONG>tput</STRONG> writes the string to the standard output.
  73                    No trailing newline is supplied.
  74
  75               integer
  76                    <STRONG>tput</STRONG> writes the decimal value to the  standard
  77                    output, with a trailing newline.
  78
  79               boolean
  80                    <STRONG>tput</STRONG>  simply sets the exit code (<STRONG>0</STRONG> for TRUE if
  81                    the terminal has the capability, <STRONG>1</STRONG>  for  FALSE
  82                    if  it  does  not),  and writes nothing to the
  83                    standard output.
  84
  85        Before using a value returned on the standard output,  the
  86        application  should  test  the  exit  code  (e.g., <STRONG>$?</STRONG>, see
  87        <STRONG>sh(1)</STRONG>) to be sure it is <STRONG>0</STRONG>.  (See the <STRONG>EXIT</STRONG> <STRONG>CODES</STRONG> and  <STRONG>DIAG-</STRONG>
  88        <STRONG>NOSTICS</STRONG>  sections.)   For  a complete list of capabilities
  89        and the <EM>capname</EM> associated with each, see <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
  90
  91        <STRONG>-T</STRONG><EM>type</EM> indicates the  <EM>type</EM>  of  terminal.   Normally  this
  92               option is unnecessary, because the default is taken
  93               from the environment variable <STRONG>TERM</STRONG>.  If <STRONG>-T</STRONG> is spec-
  94               ified,  then  the shell variables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG>
  95               will also be ignored.
  96
  97        <EM>capname</EM>
  98               indicates the capability from  the  <STRONG>terminfo</STRONG>  data-
  99               base.   When  <STRONG>termcap</STRONG>  support  is compiled in, the
 100               <STRONG>termcap</STRONG> name for the capability is also accepted.
 101
 102        <EM>parms</EM>  If the capability is a string  that  takes  parame-
 103               ters, the arguments <EM>parms</EM> will be instantiated into
 104               the string.
 105
 106               Most parameters are numbers.  Only a  few  terminfo
 107               capabilities require string parameters; <STRONG>tput</STRONG> uses a
 108               table to decide which to pass as strings.  Normally
 109               <STRONG>tput</STRONG>  uses  <STRONG>tparm</STRONG> (3x) to perform the substitution.
 110               If no parameters are given for the capability, <STRONG>tput</STRONG>
 111               writes  the string without performing the substitu-
 112               tion.
 113
 114        <STRONG>-S</STRONG>     allows more than one capability per  invocation  of
 115               <STRONG>tput</STRONG>.  The capabilities must be passed to <STRONG>tput</STRONG> from
 116               the standard input instead of from the command line
 117               (see  example).   Only  one  <EM>capname</EM> is allowed per
 118               line.  The <STRONG>-S</STRONG> option changes the meaning of  the  <STRONG>0</STRONG>
 119               and  <STRONG>1</STRONG>  boolean and string exit codes (see the EXIT
 120               CODES section).
 121
 122               Again, <STRONG>tput</STRONG> uses a table and the presence of param-
 123               eters  in  its input to decide whether to use <STRONG>tparm</STRONG>
 124               (3x), and how to interpret the parameters.
 125
 126        <STRONG>-V</STRONG>     reports the version of ncurses which  was  used  in
 127               this program, and exits.
 128
 129        <STRONG>init</STRONG>   If  the  <STRONG>terminfo</STRONG>  database is present and an entry
 130               for the user's terminal exists (see <STRONG>-T</STRONG><EM>type</EM>, above),
 131               the following will occur:
 132
 133               (1)    if  present,  the  terminal's initialization
 134                      strings will be output as  detailed  in  the
 135                      <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>  section on <EM>Tabs</EM> <EM>and</EM> <EM>Initializa-</EM>
 136                      <EM>tion</EM>,
 137
 138               (2)    any delays (e.g., newline) specified in  the
 139                      entry will be set in the tty driver,
 140
 141               (3)    tabs  expansion  will  be  turned  on or off
 142                      according to the specification in the entry,
 143                      and
 144
 145               (4)    if tabs are not expanded, standard tabs will
 146                      be set (every 8 spaces).
 147
 148               If an entry does not contain the information needed
 149               for any of the four above activities, that activity
 150               will silently be skipped.
 151
 152        <STRONG>reset</STRONG>  Instead of putting out initialization strings,  the
 153               terminal's  reset strings will be output if present
 154               (<STRONG>rs1</STRONG>, <STRONG>rs2</STRONG>, <STRONG>rs3</STRONG>, <STRONG>rf</STRONG>).  If the reset strings are  not
 155               present,  but  initialization strings are, the ini-
 156               tialization strings  will  be  output.   Otherwise,
 157               <STRONG>reset</STRONG> acts identically to <STRONG>init</STRONG>.
 158
 159        <STRONG>longname</STRONG>
 160               If  the  <STRONG>terminfo</STRONG>  database is present and an entry
 161               for the user's terminal exists (see <STRONG>-T</STRONG><EM>type</EM>  above),
 162               then the long name of the terminal will be put out.
 163               The long name is the last name in the first line of
 164               the terminal's description in the <STRONG>terminfo</STRONG> database
 165               [see <STRONG><A HREF="term.5.html">term(5)</A></STRONG>].
 166
 167        If <STRONG>tput</STRONG> is invoked by a link named  <STRONG>reset</STRONG>,  this  has  the
 168        same effect as <STRONG>tput</STRONG> <STRONG>reset</STRONG>.  See <STRONG>tset</STRONG> for comparison, which
 169        has similar behavior.
 170
 171
 172 </PRE><H2><a name="h2-EXAMPLES">EXAMPLES</a></H2><PRE>
 173        <STRONG>tput</STRONG> <STRONG>init</STRONG>
 174             Initialize the terminal according to the type of ter-
 175             minal  in the environmental variable <STRONG>TERM</STRONG>.  This com-
 176             mand should be included in everyone's .profile  after
 177             the environmental variable <STRONG>TERM</STRONG> has been exported, as
 178             illustrated on the <STRONG>profile(5)</STRONG> manual page.
 179
 180        <STRONG>tput</STRONG> <STRONG>-T5620</STRONG> <STRONG>reset</STRONG>
 181             Reset an AT&amp;T 5620 terminal, overriding the  type  of
 182             terminal in the environmental variable <STRONG>TERM</STRONG>.
 183
 184        <STRONG>tput</STRONG> <STRONG>cup</STRONG> <STRONG>0</STRONG> <STRONG>0</STRONG>
 185             Send the sequence to move the cursor to row <STRONG>0</STRONG>, column
 186             <STRONG>0</STRONG> (the upper left corner of the screen, usually known
 187             as the "home" cursor position).
 188
 189        <STRONG>tput</STRONG> <STRONG>clear</STRONG>
 190             Echo the clear-screen sequence for the current termi-
 191             nal.
 192
 193        <STRONG>tput</STRONG> <STRONG>cols</STRONG>
 194             Print the number of columns for the current terminal.
 195
 196        <STRONG>tput</STRONG> <STRONG>-T450</STRONG> <STRONG>cols</STRONG>
 197             Print the number of columns for the 450 terminal.
 198
 199        <STRONG>bold=`tput</STRONG> <STRONG>smso`</STRONG> <STRONG>offbold=`tput</STRONG> <STRONG>rmso`</STRONG>
 200             Set the shell variables <STRONG>bold</STRONG>, to begin stand-out mode
 201             sequence, and <STRONG>offbold</STRONG>, to end standout mode sequence,
 202             for the current terminal.  This might be followed  by
 203             a  prompt:  <STRONG>echo</STRONG>  <STRONG>"${bold}Please</STRONG>  <STRONG>type</STRONG>  <STRONG>in</STRONG> <STRONG>your</STRONG> <STRONG>name:</STRONG>
 204             <STRONG>${offbold}\c"</STRONG>
 205
 206        <STRONG>tput</STRONG> <STRONG>hc</STRONG>
 207             Set exit code to indicate if the current terminal  is
 208             a hard copy terminal.
 209
 210        <STRONG>tput</STRONG> <STRONG>cup</STRONG> <STRONG>23</STRONG> <STRONG>4</STRONG>
 211             Send  the sequence to move the cursor to row 23, col-
 212             umn 4.
 213
 214        <STRONG>tput</STRONG> <STRONG>cup</STRONG>
 215             Send the terminfo string for cursor-movement, with no
 216             parameters substituted.
 217
 218        <STRONG>tput</STRONG> <STRONG>longname</STRONG>
 219             Print  the  long  name from the <STRONG>terminfo</STRONG> database for
 220             the type of terminal specified in  the  environmental
 221             variable <STRONG>TERM</STRONG>.
 222
 223             <STRONG>tput</STRONG> <STRONG>-S</STRONG> <STRONG>&lt;&lt;!</STRONG>
 224             <STRONG>&gt;</STRONG> <STRONG>clear</STRONG>
 225             <STRONG>&gt;</STRONG> <STRONG>cup</STRONG> <STRONG>10</STRONG> <STRONG>10</STRONG>
 226             <STRONG>&gt;</STRONG> <STRONG>bold</STRONG>
 227             <STRONG>&gt;</STRONG> <STRONG>!</STRONG>
 228
 229             This  example shows <STRONG>tput</STRONG> processing several capabili-
 230             ties in one invocation.  It clears the screen,  moves
 231             the  cursor  to  position  10,  10  and turns on bold
 232             (extra bright) mode.  The list is  terminated  by  an
 233             exclamation mark (<STRONG>!</STRONG>) on a line by itself.
 234
 235
 236 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
 237        <STRONG>/usr/share/terminfo</STRONG>
 238               compiled terminal description database
 239
 240        <STRONG>/usr/share/tabset/*</STRONG>
 241               tab settings for some terminals, in a format appro-
 242               priate  to  be  output  to  the  terminal   (escape
 243               sequences  that  set  margins  and  tabs); for more
 244               information, see the "Tabs and Initialization" sec-
 245               tion of <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
 246
 247
 248 </PRE><H2><a name="h2-EXIT-CODES">EXIT CODES</a></H2><PRE>
 249        If the <STRONG>-S</STRONG> option is used, <STRONG>tput</STRONG> checks for errors from each
 250        line, and if any errors are found, will set the exit  code
 251        to  4  plus the number of lines with errors.  If no errors
 252        are found, the exit code is <STRONG>0</STRONG>.   No  indication  of  which
 253        line failed can be given so exit code <STRONG>1</STRONG> will never appear.
 254        Exit codes <STRONG>2</STRONG>, <STRONG>3</STRONG>, and <STRONG>4</STRONG> retain their usual  interpretation.
 255        If the <STRONG>-S</STRONG> option is not used, the exit code depends on the
 256        type of <EM>capname</EM>:
 257
 258             <EM>boolean</EM>
 259                    a value of <STRONG>0</STRONG> is set for TRUE and <STRONG>1</STRONG> for FALSE.
 260
 261             <EM>string</EM> a value of <STRONG>0</STRONG> is set if the <EM>capname</EM> is  defined
 262                    for  this  terminal <EM>type</EM> (the value of <EM>capname</EM>
 263                    is returned on standard output); a value of  <STRONG>1</STRONG>
 264                    is set if <EM>capname</EM> is not defined for this ter-
 265                    minal <EM>type</EM> (nothing  is  written  to  standard
 266                    output).
 267
 268             <EM>integer</EM>
 269                    a  value  of  <STRONG>0</STRONG>  is always set, whether or not
 270                    <EM>capname</EM> is defined for this terminal <EM>type</EM>.  To
 271                    determine  if <EM>capname</EM> is defined for this ter-
 272                    minal <EM>type</EM>, the user must test the value writ-
 273                    ten  to  standard output.  A value of <STRONG>-1</STRONG> means
 274                    that <EM>capname</EM> is not defined for this  terminal
 275                    <EM>type</EM>.
 276
 277             <EM>other</EM>  <STRONG>reset</STRONG>  or  <STRONG>init</STRONG> may fail to find their respec-
 278                    tive files.  In that case, the  exit  code  is
 279                    set to 4 + <STRONG>errno</STRONG>.
 280
 281        Any  other  exit code indicates an error; see the DIAGNOS-
 282        TICS section.
 283
 284
 285 </PRE><H2><a name="h2-DIAGNOSTICS">DIAGNOSTICS</a></H2><PRE>
 286        <STRONG>tput</STRONG> prints the following error messages and sets the cor-
 287        responding exit codes.
 288
 289        exit code   error message
 290        ---------------------------------------------------------------------
 291        <STRONG>0</STRONG>           (<EM>capname</EM>  is a numeric variable that is not specified in
 292                    the <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> database for this  terminal  type,  e.g.
 293                    <STRONG>tput</STRONG> <STRONG>-T450</STRONG> <STRONG>lines</STRONG> and <STRONG>tput</STRONG> <STRONG>-T2621</STRONG> <STRONG>xmc</STRONG>)
 294        <STRONG>1</STRONG>           no error message is printed, see the <STRONG>EXIT</STRONG> <STRONG>CODES</STRONG> section.
 295        <STRONG>2</STRONG>           usage error
 296        <STRONG>3</STRONG>           unknown terminal <EM>type</EM> or no <STRONG>terminfo</STRONG> database
 297        <STRONG>4</STRONG>           unknown <STRONG>terminfo</STRONG> capability <EM>capname</EM>
 298        <STRONG>&gt;4</STRONG>          error occurred in -S
 299        ---------------------------------------------------------------------
 300
 301
 302 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 303        The  <STRONG>longname</STRONG>  and <STRONG>-S</STRONG> options, and the parameter-substitu-
 304        tion features used in the <STRONG>cup</STRONG> example, are  not  supported
 305        in BSD curses or in AT&amp;T/USL curses before SVr4.
 306
 307        X/Open  documents  only  the  operands for <STRONG>clear</STRONG>, <STRONG>init</STRONG> and
 308        <STRONG>reset</STRONG>.  In this implementation, <STRONG>clear</STRONG> is part of the  <EM>cap-</EM>
 309        <EM>name</EM> support.  Other implementations of <STRONG>tput</STRONG> on SVr4-based
 310        systems such as Solaris, IRIX64 and HPUX as well as others
 311        such  as  AIX  and Tru64 provide support for <EM>capname</EM> oper-
 312        ands.
 313
 314        A few platforms such as FreeBSD and NetBSD recognize term-
 315        cap  names  rather than terminfo capability names in their
 316        respective <STRONG>tput</STRONG> commands.
 317
 318        Most implementations which provide support for <EM>capname</EM> op-
 319        erands  use the <EM>tparm</EM> function to expand parameters in it.
 320        That function expects a  mixture  of  numeric  and  string
 321        parameters,  requiring  <STRONG>tput</STRONG>  to  know  which type to use.
 322        This implementation uses a table to determine that for the
 323        standard  <EM>capname</EM>  operands, and an internal library func-
 324        tion  to  analyze  nonstandard  <EM>capname</EM>  operands.   Other
 325        implementations  may simply guess that an operand contain-
 326        ing only digits is intended to be a number.
 327
 328
 329 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 330        <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="terminfo.5.html">terminfo(5)</A></STRONG>, <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>.
 331
 332        This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20160130).
 333
 334
 335
 336                                                                 <STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>
 337 </PRE>
 338 <div class="nav">
 339 <ul>
 340 <li><a href="#h2-NAME">NAME</a></li>
 341 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 342 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 343 <li><a href="#h2-EXAMPLES">EXAMPLES</a></li>
 344 <li><a href="#h2-FILES">FILES</a></li>
 345 <li><a href="#h2-EXIT-CODES">EXIT CODES</a></li>
 346 <li><a href="#h2-DIAGNOSTICS">DIAGNOSTICS</a></li>
 347 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 348 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 349 </ul>
 350 </div>
 351 </BODY>
 352 </HTML>