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: src/usr.bin/tput/tput.1,v 1.5.2.3 2001/08/16 13:17:08 ru Exp $
  34 .\"
  35 .Dd March 19, 1994
  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 command makes terminal-dependent information available to users or shell
  51 applications.  When invoked as the
  52 .Nm clear
  53 utility, the screen will be cleared as if
  54 .Dl tput clear
  55 had been executed.
  56 The options to
  57 .Nm
  58 are as follows:
  59 .Bl -tag -width Ds
  60 .It Fl T
  61 The terminal name as specified in the
  62 .Xr termcap
  63 database, for example,
  64 .Dq vt100
  65 or
  66 .Dq xterm .
  67 If not specified,
  68 .Nm
  69 retrieves the
  70 .Dq Ev TERM
  71 variable from the environment.
  72 .El
  73 .Pp
  74 The
  75 .Nm
  76 command outputs a string if the
  77 .Ar attribute
  78 is of type string; a number if it is of type integer.
  79 Otherwise,
  80 .Nm
  81 exits 0 if the terminal has the capability and 1 if it does not,
  82 without further action.
  83 .Pp
  84 If the
  85 .Ar attribute
  86 is of type string, and takes arguments (e.g. cursor movement,
  87 the termcap
  88 .Dq cm
  89 sequence) the arguments are taken from the command line immediately
  90 following the attribute.
  91 .Pp
  92 The following special attributes are available:
  93 .Bl -tag -width Ar
  94 .It clear
  95 Clear the screen (the
  96 .Xr termcap
  97 .Dq cl
  98 sequence).
  99 .It init
 100 Initialize the terminal (the
 101 .Xr termcap
 102 .Dq is
 103 sequence).
 104 .It longname
 105 Print the descriptive name of the user's terminal type.
 106 .It reset
 107 Reset the terminal (the
 108 .Xr termcap
 109 .Dq rs
 110 sequence).
 111 .El
 112 .Sh DIAGNOSTICS
 113 The exit value of
 114 .Nm
 115 is based on the last attribute specified.
 116 If the attribute is of type string or of type integer,
 117 .Nm
 118 exits 0 if the attribute is defined for this terminal type and 1
 119 if it is not.
 120 If the attribute is of type boolean,
 121 .Nm
 122 exits 0 if the terminal has this attribute, and 1 if it does not.
 123 The
 124 .Nm
 125 command exits 2 if any error occurred.
 126 .Sh SEE ALSO
 127 .Xr termcap 5 ,
 128 .Xr terminfo 5
 129 .Sh BUGS
 130 The
 131 .Nm
 132 command can't really distinguish between different types of attributes.
 133 .Pp
 134 Some termcap entries depend upon having a
 135 .Sq %
 136 in them that is just a
 137 .Sq %
 138 and nothing more.  Right now we just warn about them if they don't
 139 have a valid type declaration.  These warnings are sent to
 140 stderr.
 141 .Sh HISTORY
 142 The
 143 .Nm
 144 command appeared in
 145 .Bx 4.4 .