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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)tput.1      8.2 (Berkeley) 3/19/94
  29 .\" $FreeBSD: src/usr.bin/tput/tput.1,v 1.5.2.3 2001/08/16 13:17:08 ru Exp $
  30 .\" $DragonFly: src/usr.bin/tput/tput.1,v 1.4 2006/04/17 18:01:38 swildner Exp $
  31 .\"
  32 .Dd March 19, 1994
  33 .Dt TPUT 1
  34 .Os
  35 .Sh NAME
  36 .Nm tput ,
  37 .Nm clear
  38 .Nd terminal capability interface
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Op Fl T Ar term
  42 .Ar attribute
  43 .Nm clear
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 command makes terminal-dependent information available to users or shell
  48 applications.  When invoked as the
  49 .Nm clear
  50 utility, the screen will be cleared as if
  51 .Dl tput clear
  52 had been executed.
  53 The options to
  54 .Nm
  55 are as follows:
  56 .Bl -tag -width Ds
  57 .It Fl T
  58 The terminal name as specified in the
  59 .Xr termcap 5
  60 database, for example,
  61 .Dq vt100
  62 or
  63 .Dq xterm .
  64 If not specified,
  65 .Nm
  66 retrieves the
  67 .Dq Ev TERM
  68 variable from the environment.
  69 .El
  70 .Pp
  71 The
  72 .Nm
  73 command outputs a string if the
  74 .Ar attribute
  75 is of type string; a number if it is of type integer.
  76 Otherwise,
  77 .Nm
  78 exits 0 if the terminal has the capability and 1 if it does not,
  79 without further action.
  80 .Pp
  81 If the
  82 .Ar attribute
  83 is of type string, and takes arguments (e.g. cursor movement,
  84 the termcap
  85 .Dq cm
  86 sequence) the arguments are taken from the command line immediately
  87 following the attribute.
  88 .Pp
  89 The following special attributes are available:
  90 .Bl -tag -width Ar
  91 .It clear
  92 Clear the screen (the
  93 .Xr termcap 5
  94 .Dq cl
  95 sequence).
  96 .It init
  97 Initialize the terminal (the
  98 .Xr termcap 5
  99 .Dq is
 100 sequence).
 101 .It longname
 102 Print the descriptive name of the user's terminal type.
 103 .It reset
 104 Reset the terminal (the
 105 .Xr termcap 5
 106 .Dq rs
 107 sequence).
 108 .El
 109 .Sh DIAGNOSTICS
 110 The exit value of
 111 .Nm
 112 is based on the last attribute specified.
 113 If the attribute is of type string or of type integer,
 114 .Nm
 115 exits 0 if the attribute is defined for this terminal type and 1
 116 if it is not.
 117 If the attribute is of type boolean,
 118 .Nm
 119 exits 0 if the terminal has this attribute, and 1 if it does not.
 120 The
 121 .Nm
 122 command exits 2 if any error occurred.
 123 .Sh SEE ALSO
 124 .Xr termcap 5 ,
 125 .Xr terminfo 5
 126 .Sh HISTORY
 127 The
 128 .Nm
 129 command appeared in
 130 .Bx 4.4 .
 131 .Sh BUGS
 132 The
 133 .Nm
 134 command can't really distinguish between different types of attributes.
 135 .Pp
 136 Some termcap entries depend upon having a
 137 .Sq %
 138 in them that is just a
 139 .Sq %
 140 and nothing more.  Right now we just warn about them if they don't
 141 have a valid type declaration.  These warnings are sent to
 142 stderr.