usr.bin/tput/tput.1

   1 .\" Copyright (c) 1989, 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)tput.1      8.2 (Berkeley) 3/19/94
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 15, 2002
  36 .Dt TPUT 1
  37 .Os
  38 .Sh NAME
  39 .Nm tput ,
  40 .Nm clear
  41 .Nd terminal capability interface
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl T Ar term
  45 .Ar attribute ...
  46 .Nm clear
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility makes terminal-dependent information available to users or shell
  51 applications.
  52 When invoked as the
  53 .Nm clear
  54 utility, the screen will be cleared as if
  55 .Dl tput clear
  56 had been executed.
  57 The options to
  58 .Nm
  59 are as follows:
  60 .Bl -tag -width Ds
  61 .It Fl T
  62 The terminal name as specified in the
  63 .Xr termcap 5
  64 database, for example,
  65 .Dq vt100
  66 or
  67 .Dq xterm .
  68 If not specified,
  69 .Nm
  70 retrieves the
  71 .Dq Ev TERM
  72 variable from the environment.
  73 .El
  74 .Pp
  75 The
  76 .Nm
  77 utility outputs a string for each
  78 .Ar attribute
  79 that is of type string; a number for each of type integer.
  80 Otherwise,
  81 .Nm
  82 exits 0 if the terminal has the capability and 1 if it does not,
  83 without further action.
  84 .Pp
  85 If an
  86 .Ar attribute
  87 is of type string, and takes arguments (e.g.\& cursor movement,
  88 the termcap
  89 .Dq cm
  90 sequence) the arguments are taken from the command line immediately
  91 following the attribute.
  92 .Pp
  93 The following special attributes are available:
  94 .Bl -tag -width Ar
  95 .It Cm clear
  96 Clear the screen (the
  97 .Xr termcap 5
  98 .Dq cl
  99 sequence).
 100 .It Cm init
 101 Initialize the terminal (the
 102 .Xr termcap 5
 103 .Dq is
 104 sequence).
 105 .It Cm longname
 106 Print the descriptive name of the user's terminal type.
 107 .It Cm reset
 108 Reset the terminal (the
 109 .Xr termcap 5
 110 .Dq rs
 111 sequence).
 112 .El
 113 .Sh EXIT STATUS
 114 The exit status of
 115 .Nm
 116 is as follows:
 117 .Bl -tag -width indent
 118 .It 0
 119 If the last attribute
 120 .Ar attribute
 121 argument is of type string or integer, its value was successfully written
 122 to standard output.
 123 If the argument is of type boolean, the terminal has this attribute.
 124 .It 1
 125 This terminal does not have the specified boolean
 126 .Ar attribute .
 127 .It 2
 128 Usage error.
 129 .It 3
 130 No information is available about the specified terminal type.
 131 .El
 132 .Sh SEE ALSO
 133 .Xr termcap 5 ,
 134 .Xr terminfo 5
 135 .Sh STANDARDS
 136 The
 137 .Nm
 138 utility conforms to
 139 .St -p1003.1-2001 .
 140 .Sh HISTORY
 141 The
 142 .Nm
 143 utility appeared in
 144 .Bx 4.4 .
 145 .Sh BUGS
 146 The
 147 .Nm
 148 utility cannot really distinguish between different types of attributes.
 149 .Pp
 150 Some termcap entries depend upon having a
 151 .Sq %
 152 in them that is just a
 153 .Sq %
 154 and nothing more.
 155 Right now we just warn about them if they do not
 156 have a valid type declaration.
 157 These warnings are sent to
 158 stderr.