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 .\" $DragonFly: src/usr.bin/tput/tput.1,v 1.4 2006/04/17 18:01:38 swildner Exp $
  35 .\"
  36 .Dd March 19, 1994
  37 .Dt TPUT 1
  38 .Os
  39 .Sh NAME
  40 .Nm tput ,
  41 .Nm clear
  42 .Nd terminal capability interface
  43 .Sh SYNOPSIS
  44 .Nm
  45 .Op Fl T Ar term
  46 .Ar attribute
  47 .Nm clear
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 command makes terminal-dependent information available to users or shell
  52 applications.  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 command outputs a string if the
  78 .Ar attribute
  79 is of type string; a number if it is 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 the
  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 clear
  96 Clear the screen (the
  97 .Xr termcap 5
  98 .Dq cl
  99 sequence).
 100 .It init
 101 Initialize the terminal (the
 102 .Xr termcap 5
 103 .Dq is
 104 sequence).
 105 .It longname
 106 Print the descriptive name of the user's terminal type.
 107 .It reset
 108 Reset the terminal (the
 109 .Xr termcap 5
 110 .Dq rs
 111 sequence).
 112 .El
 113 .Sh DIAGNOSTICS
 114 The exit value of
 115 .Nm
 116 is based on the last attribute specified.
 117 If the attribute is of type string or of type integer,
 118 .Nm
 119 exits 0 if the attribute is defined for this terminal type and 1
 120 if it is not.
 121 If the attribute is of type boolean,
 122 .Nm
 123 exits 0 if the terminal has this attribute, and 1 if it does not.
 124 The
 125 .Nm
 126 command exits 2 if any error occurred.
 127 .Sh SEE ALSO
 128 .Xr termcap 5 ,
 129 .Xr terminfo 5
 130 .Sh HISTORY
 131 The
 132 .Nm
 133 command appeared in
 134 .Bx 4.4 .
 135 .Sh BUGS
 136 The
 137 .Nm
 138 command can't really distinguish between different types of attributes.
 139 .Pp
 140 Some termcap entries depend upon having a
 141 .Sq %
 142 in them that is just a
 143 .Sq %
 144 and nothing more.  Right now we just warn about them if they don't
 145 have a valid type declaration.  These warnings are sent to
 146 stderr.