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 .\"
  34 .Dd March 19, 1994
  35 .Dt TPUT 1
  36 .Os BSD 4.4
  37 .Sh NAME
  38 .Nm tput
  39 .Nd terminal capability interface
  40 .Sh SYNOPSIS
  41 .Nm tput
  42 .Op Fl T Ar term
  43 .Ar attribute
  44 .Sh DESCRIPTION
  45 .Nm Tput
  46 makes terminal-dependent information available to users or shell
  47 applications.
  48 The options are as follows:
  49 .Bl -tag -width Ds
  50 .It Fl T
  51 The terminal name as specified in the
  52 .Xr termcap
  53 database, for example, ``vt100'' or ``xterm''.
  54 If not specified,
  55 .Nm tput
  56 retrieves the
  57 .Dq Ev TERM
  58 variable from the environment.
  59 .El
  60 .Pp
  61 .Nm Tput
  62 outputs a string if the
  63 .Ar attribute
  64 is of type string; a number if it is of type integer.
  65 Otherwise,
  66 .Nm tput
  67 exits 0 if the terminal has the capability and 1 if it does not,
  68 without further action.
  69 .Pp
  70 If the
  71 .Ar attribute
  72 is of type string, and takes arguments (e.g. cursor movement,
  73 the termcap
  74 .Dq cm
  75 sequence) the arguments are taken from the command line immediately
  76 following the attribute.
  77 .Pp
  78 The following special attributes are available:
  79 .Bl -tag -width Ar
  80 .It clear
  81 Clear the screen (the
  82 .Xr termcap
  83 ``cl'' sequence).
  84 .It init
  85 Initialize the terminal (the
  86 .Xr termcap
  87 ``is'' sequence).
  88 .It longname
  89 Print the descriptive name of the user's terminal type.
  90 .It reset
  91 Reset the terminal (the
  92 .Xr termcap
  93 ``rs'' sequence).
  94 .Sh DIAGNOSTICS
  95 The exit value of
  96 .Nm tput
  97 is based on the last attribute specified.
  98 If the attribute is of type string or of type integer,
  99 .Nm tput
 100 exits 0 if the attribute is defined for this terminal type and 1
 101 if it is not.
 102 If the attribute is of type boolean,
 103 .Nm tput
 104 exits 0 if the terminal has this attribute, and 1 if it does not.
 105 .Nm Tput
 106 exits 2 if any error occurred.
 107 .Sh SEE ALSO
 108 .Xr termcap 3 ,
 109 .Xr termcap 5
 110 .Sh BUGS
 111 .Nm Tput
 112 can't really distinguish between different types of attributes.
 113 .Sh HISTORY
 114 The
 115 .Nm
 116 command appears in
 117 .Bx 4.4 .