ncurses 6.0 - patch 20160723
[ncurses.git] / doc / html / man / tput.1.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2012,2016 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.36 2016/04/02 23:41:08 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>parameters</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.  No
73                trailing newline is supplied.
74
75           integer
76                <STRONG>tput</STRONG> writes the decimal value to the standard out-
77                put, with a trailing newline.
78
79           boolean
80                <STRONG>tput</STRONG>  simply sets the exit code (<STRONG>0</STRONG> for TRUE if the
81                terminal has the capability, <STRONG>1</STRONG>  for  FALSE  if  it
82                does not), and writes nothing to the standard out-
83                put.
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
92 </PRE><H3><a name="h3-Options">Options</a></H3><PRE>
93        <STRONG>-T</STRONG><EM>type</EM> indicates the  <EM>type</EM>  of  terminal.   Normally  this
94               option is unnecessary, because the default is taken
95               from the environment variable <STRONG>TERM</STRONG>.  If <STRONG>-T</STRONG> is spec-
96               ified,  then  the shell variables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG>
97               will also be ignored.
98
99        <STRONG>-S</STRONG>     allows more than one capability per  invocation  of
100               <STRONG>tput</STRONG>.  The capabilities must be passed to <STRONG>tput</STRONG> from
101               the standard input instead of from the command line
102               (see  example).   Only  one  <EM>capname</EM> is allowed per
103               line.  The <STRONG>-S</STRONG> option changes the meaning of  the  <STRONG>0</STRONG>
104               and  <STRONG>1</STRONG>  boolean and string exit codes (see the EXIT
105               CODES section).
106
107               Again, <STRONG>tput</STRONG> uses a table and the presence of param-
108               eters  in  its  input  to  decide  whether  to  use
109               <STRONG><A HREF="tparm.3x.html">tparm(3x)</A></STRONG>, and how to interpret the parameters.
110
111        <STRONG>-V</STRONG>     reports the version of ncurses which  was  used  in
112               this program, and exits.
113
114
115 </PRE><H3><a name="h3-Commands">Commands</a></H3><PRE>
116        <EM>capname</EM>
117               indicates  the  capability  from the <STRONG>terminfo</STRONG> data-
118               base.  When <STRONG>termcap</STRONG> support  is  compiled  in,  the
119               <STRONG>termcap</STRONG> name for the capability is also accepted.
120
121               If  the  capability  is a string that takes parame-
122               ters, the arguments following the  capability  will
123               be used as parameters for the string.
124
125               Most  parameters  are numbers.  Only a few terminfo
126               capabilities require string parameters; <STRONG>tput</STRONG> uses a
127               table to decide which to pass as strings.  Normally
128               <STRONG>tput</STRONG> uses <STRONG><A HREF="tparm.3x.html">tparm(3x)</A></STRONG> to  perform  the  substitution.
129               If no parameters are given for the capability, <STRONG>tput</STRONG>
130               writes the string without performing the  substitu-
131               tion.
132
133        <STRONG>init</STRONG>   If  the  <STRONG>terminfo</STRONG>  database is present and an entry
134               for the user's terminal exists (see <STRONG>-T</STRONG><EM>type</EM>, above),
135               the following will occur:
136
137               (1)  if   present,  the  terminal's  initialization
138                    strings will be output as detailed in the <STRONG>ter-</STRONG>
139                    <STRONG><A HREF="terminfo.5.html">minfo(5)</A></STRONG> section on <EM>Tabs</EM> <EM>and</EM> <EM>Initialization</EM>,
140
141               (2)  any  delays  (e.g.,  newline) specified in the
142                    entry will be set in the tty driver,
143
144               (3)  tabs  expansion  will  be  turned  on  or  off
145                    according  to  the specification in the entry,
146                    and
147
148               (4)  if tabs are not expanded, standard  tabs  will
149                    be set (every 8 spaces).
150
151               If an entry does not contain the information needed
152               for any of these  activities,  that  activity  will
153               silently be skipped.
154
155        <STRONG>reset</STRONG>  Instead  of putting out initialization strings, the
156               terminal's reset strings will be output if  present
157               (<STRONG>rs1</STRONG>,  <STRONG>rs2</STRONG>, <STRONG>rs3</STRONG>, <STRONG>rf</STRONG>).  If the reset strings are not
158               present, but initialization strings are,  the  ini-
159               tialization  strings  will  be  output.  Otherwise,
160               <STRONG>reset</STRONG> acts identically to <STRONG>init</STRONG>.
161
162        <STRONG>longname</STRONG>
163               If the <STRONG>terminfo</STRONG> database is present  and  an  entry
164               for  the user's terminal exists (see <STRONG>-T</STRONG><EM>type</EM> above),
165               then the long name of the terminal will be put out.
166               The long name is the last name in the first line of
167               the terminal's description in the <STRONG>terminfo</STRONG> database
168               [see <STRONG><A HREF="term.5.html">term(5)</A></STRONG>].
169
170
171 </PRE><H3><a name="h3-Aliases">Aliases</a></H3><PRE>
172        <STRONG>tput</STRONG>  handles  the  <STRONG>init</STRONG>  and <STRONG>reset</STRONG> commands specially: it
173        allows for the possibility that it is invoked  by  a  link
174        with those names.
175
176        If  <STRONG>tput</STRONG>  is  invoked  by a link named <STRONG>reset</STRONG>, this has the
177        same effect as  <STRONG>tput</STRONG>  <STRONG>reset</STRONG>.   The  <STRONG><A HREF="tset.1.html">tset(1)</A></STRONG>  utility  also
178        treats a link named <STRONG>reset</STRONG> specially:
179
180        <STRONG>o</STRONG>   That  utility  resets  the  terminal modes and special
181            characters (not done here).
182
183        <STRONG>o</STRONG>   On the other hand, tset's repertoire of terminal capa-
184            bilities  for  resetting the terminal is more limited,
185            i.e., only <STRONG>reset_1string</STRONG>, <STRONG>reset_2string</STRONG> and <STRONG>reset_file</STRONG>
186            in contrast to the tab-stops and margins which are set
187            by this utility.
188
189        <STRONG>o</STRONG>   The <STRONG>reset</STRONG> program is usually an alias for tset, due to
190            the  resetting  of  terminal modes and special charac-
191            ters.
192
193        If <STRONG>tput</STRONG> is invoked by a link named <STRONG>init</STRONG>, this has the same
194        effect  as  <STRONG>tput</STRONG>  <STRONG>init</STRONG>.  Again, you are less likely to use
195        that link because another program named <STRONG>init</STRONG>  has  a  more
196        well-established use.
197
198
199 </PRE><H2><a name="h2-EXAMPLES">EXAMPLES</a></H2><PRE>
200        <STRONG>tput</STRONG> <STRONG>init</STRONG>
201             Initialize the terminal according to the type of ter-
202             minal in the environmental variable <STRONG>TERM</STRONG>.  This  com-
203             mand  should be included in everyone's .profile after
204             the environmental variable <STRONG>TERM</STRONG> has been exported, as
205             illustrated on the <STRONG>profile(5)</STRONG> manual page.
206
207        <STRONG>tput</STRONG> <STRONG>-T5620</STRONG> <STRONG>reset</STRONG>
208             Reset  an  AT&amp;T 5620 terminal, overriding the type of
209             terminal in the environmental variable <STRONG>TERM</STRONG>.
210
211        <STRONG>tput</STRONG> <STRONG>cup</STRONG> <STRONG>0</STRONG> <STRONG>0</STRONG>
212             Send the sequence to move the cursor to row <STRONG>0</STRONG>, column
213             <STRONG>0</STRONG> (the upper left corner of the screen, usually known
214             as the "home" cursor position).
215
216        <STRONG>tput</STRONG> <STRONG>clear</STRONG>
217             Echo the clear-screen sequence for the current termi-
218             nal.
219
220        <STRONG>tput</STRONG> <STRONG>cols</STRONG>
221             Print the number of columns for the current terminal.
222
223        <STRONG>tput</STRONG> <STRONG>-T450</STRONG> <STRONG>cols</STRONG>
224             Print the number of columns for the 450 terminal.
225
226        <STRONG>bold=`tput</STRONG> <STRONG>smso`</STRONG> <STRONG>offbold=`tput</STRONG> <STRONG>rmso`</STRONG>
227             Set the shell variables <STRONG>bold</STRONG>, to begin stand-out mode
228             sequence, and <STRONG>offbold</STRONG>, to end standout mode sequence,
229             for  the current terminal.  This might be followed by
230             a prompt: <STRONG>echo</STRONG>  <STRONG>"${bold}Please</STRONG>  <STRONG>type</STRONG>  <STRONG>in</STRONG>  <STRONG>your</STRONG>  <STRONG>name:</STRONG>
231             <STRONG>${offbold}\c"</STRONG>
232
233        <STRONG>tput</STRONG> <STRONG>hc</STRONG>
234             Set  exit code to indicate if the current terminal is
235             a hard copy terminal.
236
237        <STRONG>tput</STRONG> <STRONG>cup</STRONG> <STRONG>23</STRONG> <STRONG>4</STRONG>
238             Send the sequence to move the cursor to row 23,  col-
239             umn 4.
240
241        <STRONG>tput</STRONG> <STRONG>cup</STRONG>
242             Send the terminfo string for cursor-movement, with no
243             parameters substituted.
244
245        <STRONG>tput</STRONG> <STRONG>longname</STRONG>
246             Print the long name from the  <STRONG>terminfo</STRONG>  database  for
247             the  type  of terminal specified in the environmental
248             variable <STRONG>TERM</STRONG>.
249
250             <STRONG>tput</STRONG> <STRONG>-S</STRONG> <STRONG>&lt;&lt;!</STRONG>
251             <STRONG>&gt;</STRONG> <STRONG>clear</STRONG>
252             <STRONG>&gt;</STRONG> <STRONG>cup</STRONG> <STRONG>10</STRONG> <STRONG>10</STRONG>
253             <STRONG>&gt;</STRONG> <STRONG>bold</STRONG>
254             <STRONG>&gt;</STRONG> <STRONG>!</STRONG>
255
256             This example shows <STRONG>tput</STRONG> processing several  capabili-
257             ties  in one invocation.  It clears the screen, moves
258             the cursor to position  10,  10  and  turns  on  bold
259             (extra  bright)  mode.   The list is terminated by an
260             exclamation mark (<STRONG>!</STRONG>) on a line by itself.
261
262
263 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
264        <STRONG>/usr/share/terminfo</STRONG>
265               compiled terminal description database
266
267        <STRONG>/usr/share/tabset/*</STRONG>
268               tab settings for some terminals, in a format appro-
269               priate   to  be  output  to  the  terminal  (escape
270               sequences that set  margins  and  tabs);  for  more
271               information, see the "Tabs and Initialization" sec-
272               tion of <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
273
274
275 </PRE><H2><a name="h2-EXIT-CODES">EXIT CODES</a></H2><PRE>
276        If the <STRONG>-S</STRONG> option is used, <STRONG>tput</STRONG> checks for errors from each
277        line,  and if any errors are found, will set the exit code
278        to 4 plus the number of lines with errors.  If  no  errors
279        are  found,  the  exit  code is <STRONG>0</STRONG>.  No indication of which
280        line failed can be given so exit code <STRONG>1</STRONG> will never appear.
281        Exit  codes <STRONG>2</STRONG>, <STRONG>3</STRONG>, and <STRONG>4</STRONG> retain their usual interpretation.
282        If the <STRONG>-S</STRONG> option is not used, the exit code depends on the
283        type of <EM>capname</EM>:
284
285           <EM>boolean</EM>
286                  a value of <STRONG>0</STRONG> is set for TRUE and <STRONG>1</STRONG> for FALSE.
287
288           <EM>string</EM> a  value  of  <STRONG>0</STRONG> is set if the <EM>capname</EM> is defined
289                  for this terminal <EM>type</EM> (the value of <EM>capname</EM>  is
290                  returned  on  standard  output); a value of <STRONG>1</STRONG> is
291                  set if <EM>capname</EM> is not defined for this  terminal
292                  <EM>type</EM> (nothing is written to standard output).
293
294           <EM>integer</EM>
295                  a  value of <STRONG>0</STRONG> is always set, whether or not <EM>cap-</EM>
296                  <EM>name</EM> is defined  for  this  terminal  <EM>type</EM>.   To
297                  determine  if <EM>capname</EM> is defined for this termi-
298                  nal <EM>type</EM>, the user must test the  value  written
299                  to  standard  output.   A value of <STRONG>-1</STRONG> means that
300                  <EM>capname</EM> is not defined for this terminal <EM>type</EM>.
301
302           <EM>other</EM>  <STRONG>reset</STRONG> or <STRONG>init</STRONG> may fail to find their  respective
303                  files.   In that case, the exit code is set to 4
304                  + <STRONG>errno</STRONG>.
305
306        Any other exit code indicates an error; see  the  DIAGNOS-
307        TICS section.
308
309
310 </PRE><H2><a name="h2-DIAGNOSTICS">DIAGNOSTICS</a></H2><PRE>
311        <STRONG>tput</STRONG> prints the following error messages and sets the cor-
312        responding exit codes.
313
314        exit code   error message
315        ---------------------------------------------------------------------
316        <STRONG>0</STRONG>           (<EM>capname</EM> is a numeric variable that is not specified  in
317                    the  <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>  database  for this terminal type, e.g.
318                    <STRONG>tput</STRONG> <STRONG>-T450</STRONG> <STRONG>lines</STRONG> and <STRONG>tput</STRONG> <STRONG>-T2621</STRONG> <STRONG>xmc</STRONG>)
319        <STRONG>1</STRONG>           no error message is printed, see the <STRONG>EXIT</STRONG> <STRONG>CODES</STRONG> section.
320        <STRONG>2</STRONG>           usage error
321        <STRONG>3</STRONG>           unknown terminal <EM>type</EM> or no <STRONG>terminfo</STRONG> database
322        <STRONG>4</STRONG>           unknown <STRONG>terminfo</STRONG> capability <EM>capname</EM>
323        <STRONG>&gt;4</STRONG>          error occurred in -S
324        ---------------------------------------------------------------------
325
326
327 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
328        The <STRONG>longname</STRONG> and <STRONG>-S</STRONG> options, and  the  parameter-substitu-
329        tion  features  used in the <STRONG>cup</STRONG> example, are not supported
330        in BSD curses or in AT&amp;T/USL curses before SVr4.
331
332        IEEE Std 1003.1/The Open Group  Base Specifications  Issue
333        7  (POSIX.1-2008)  documents  only the operands for <STRONG>clear</STRONG>,
334        <STRONG>init</STRONG> and <STRONG>reset</STRONG>.  There are a few interesting  observations
335        to make regarding that:
336
337        <STRONG>o</STRONG>   In  this  implementation, <STRONG>clear</STRONG> is part of the <EM>capname</EM>
338            support.  The others (<STRONG>init</STRONG> and <STRONG>longname</STRONG>) do not corre-
339            spond to terminal capabilities.
340
341        <STRONG>o</STRONG>   Other  implementations  of  <STRONG>tput</STRONG> on SVr4-based systems
342            such as Solaris, IRIX64 and HPUX  as  well  as  others
343            such  as AIX and Tru64 provide support for <EM>capname</EM> op-
344            erands.
345
346        <STRONG>o</STRONG>   A few platforms  such  as  FreeBSD  recognize  termcap
347            names  rather  than terminfo capability names in their
348            respective <STRONG>tput</STRONG> commands.  Since 2010,  NetBSD's  <STRONG>tput</STRONG>
349            uses  terminfo  names.  Before that, it (like FreeBSD)
350            recognized termcap names.
351
352        Because (apparently) <EM>all</EM> of  the  certified  Unix  systems
353        support  the  full  set of capability names, the reasoning
354        for documenting only a few may not be apparent.
355
356        <STRONG>o</STRONG>   X/Open Curses Issue 7 documents <STRONG>tput</STRONG> differently, with
357            <EM>capname</EM>  and the other features used in this implemen-
358            tation.
359
360        <STRONG>o</STRONG>   That is, there are two standards for  <STRONG>tput</STRONG>:  POSIX  (a
361            subset)  and  X/Open Curses (the full implementation).
362            POSIX documents a subset to avoid the complication  of
363            including  X/Open Curses and the terminal capabilities
364            database.
365
366        <STRONG>o</STRONG>   While it is certainly possible to write a <STRONG>tput</STRONG> program
367            without using curses, none of the systems which have a
368            curses implementation provide  a  <STRONG>tput</STRONG>  utility  which
369            does not provide the <EM>capname</EM> feature.
370
371        Most implementations which provide support for <EM>capname</EM> op-
372        erands use the <EM>tparm</EM> function to expand parameters in  it.
373        That  function  expects  a  mixture  of numeric and string
374        parameters, requiring <STRONG>tput</STRONG> to  know  which  type  to  use.
375        This implementation uses a table to determine that for the
376        standard <EM>capname</EM> operands, and an internal  library  func-
377        tion  to  analyze  nonstandard  <EM>capname</EM>  operands.   Other
378        implementations may simply guess that an operand  contain-
379        ing only digits is intended to be a number.
380
381
382 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
383        <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="tset.1.html">tset(1)</A></STRONG>,   <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>,
384        <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>.
385
386        This describes <STRONG>ncurses</STRONG> version 6.0 (patch 20160723).
387
388
389
390                                                                 <STRONG><A HREF="tput.1.html">tput(1)</A></STRONG>
391 </PRE>
392 <div class="nav">
393 <ul>
394 <li><a href="#h2-NAME">NAME</a></li>
395 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
396 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
397 <ul>
398 <li><a href="#h3-Options">Options</a></li>
399 <li><a href="#h3-Commands">Commands</a></li>
400 <li><a href="#h3-Aliases">Aliases</a></li>
401 </ul>
402 </li>
403 <li><a href="#h2-EXAMPLES">EXAMPLES</a></li>
404 <li><a href="#h2-FILES">FILES</a></li>
405 <li><a href="#h2-EXIT-CODES">EXIT CODES</a></li>
406 <li><a href="#h2-DIAGNOSTICS">DIAGNOSTICS</a></li>
407 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
408 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
409 </ul>
410 </div>
411 </BODY>
412 </HTML>