Return to tput.1 CVS log

Up to [local] / src / usr.bin / tput

Annotation of src/usr.bin/tput/tput.1, Revision 1.1.1.1

1.1       deraadt     1: .\"    $NetBSD: tput.1,v 1.4 1994/12/07 08:49:10 jtc Exp $
                      2: .\"
                      3: .\" Copyright (c) 1989, 1990, 1993
                      4: .\"    The Regents of the University of California.  All rights reserved.
                      5: .\"
                      6: .\" Redistribution and use in source and binary forms, with or without
                      7: .\" modification, are permitted provided that the following conditions
                      8: .\" are met:
                      9: .\" 1. Redistributions of source code must retain the above copyright
                     10: .\"    notice, this list of conditions and the following disclaimer.
                     11: .\" 2. Redistributions in binary form must reproduce the above copyright
                     12: .\"    notice, this list of conditions and the following disclaimer in the
                     13: .\"    documentation and/or other materials provided with the distribution.
                     14: .\" 3. All advertising materials mentioning features or use of this software
                     15: .\"    must display the following acknowledgement:
                     16: .\"    This product includes software developed by the University of
                     17: .\"    California, Berkeley and its contributors.
                     18: .\" 4. Neither the name of the University nor the names of its contributors
                     19: .\"    may be used to endorse or promote products derived from this software
                     20: .\"    without specific prior written permission.
                     21: .\"
                     22: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     23: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     24: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     25: .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     26: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     27: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     28: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     29: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     30: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     31: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     32: .\" SUCH DAMAGE.
                     33: .\"
                     34: .\"     @(#)tput.1     8.2 (Berkeley) 3/19/94
                     35: .\"
                     36: .Dd March 19, 1994
                     37: .Dt TPUT 1
                     38: .Os BSD 4.4
                     39: .Sh NAME
                     40: .Nm tput
                     41: .Nd terminal capability interface
                     42: .Sh SYNOPSIS
                     43: .Nm tput
                     44: .Op Fl T Ar term
                     45: .Ar attribute
                     46: .Op Ar attribute-args
                     47: .Ar ...
                     48: .Sh DESCRIPTION
                     49: .Nm Tput
                     50: makes terminal-dependent information available to users or shell
                     51: applications.
                     52: The options are as follows:
                     53: .Bl -tag -width Ds
                     54: .It Fl T
                     55: The terminal name as specified in the
                     56: .Xr termcap
                     57: database, for example, ``vt100'' or ``xterm''.
                     58: If not specified,
                     59: .Nm tput
                     60: retrieves the
                     61: .Dq Ev TERM
                     62: variable from the environment.
                     63: .El
                     64: .Pp
                     65: .Nm Tput
                     66: outputs a string if the
                     67: .Ar attribute
                     68: is of type string; a number if it is of type integer.
                     69: Otherwise,
                     70: .Nm tput
                     71: exits 0 if the terminal has the capability and 1 if it does not,
                     72: without further action.
                     73: .Pp
                     74: If the
                     75: .Ar attribute
                     76: is of type string, and takes arguments (e.g. cursor movement,
                     77: the termcap
                     78: .Dq cm
                     79: sequence) the arguments are taken from the command line immediately
                     80: following the attribute.
                     81: .Pp
                     82: The following special attributes are available:
                     83: .Bl -tag -width Ar
                     84: .It clear
                     85: Clear the screen (the
                     86: .Xr termcap
                     87: ``cl'' sequence).
                     88: .It init
                     89: Initialize the terminal (the
                     90: .Xr termcap
                     91: ``is'' sequence).
                     92: .It longname
                     93: Print the descriptive name of the user's terminal type.
                     94: .It reset
                     95: Reset the terminal (the
                     96: .Xr termcap
                     97: ``rs'' sequence).
                     98: .Sh DIAGNOSTICS
                     99: The exit value of
                    100: .Nm tput
                    101: is based on the last attribute specified.
                    102: If the attribute is of type string or of type integer,
                    103: .Nm tput
                    104: exits 0 if the attribute is defined for this terminal type and 1
                    105: if it is not.
                    106: If the attribute is of type boolean,
                    107: .Nm tput
                    108: exits 0 if the terminal has this attribute, and 1 if it does not.
                    109: .Nm Tput
                    110: exits 2 if any error occurred.
                    111: .Sh EXAMPLES
                    112: .Bl -tag -width "tput cm 6 11 DC 6" -compact
                    113: .It Li "tput cl cm 5 10"
                    114: clear the screen and goto line 5 column 10
                    115: .Pp
                    116: .It Li "tput cm 6 11 DC 6"
                    117: goto line 6 column 11 and delete 6 characters
                    118: .Sh SEE ALSO
                    119: .Xr termcap 3 ,
                    120: .Xr termcap 5
                    121: .Sh BUGS
                    122: .Nm Tput
                    123: can't really distinguish between different types of attributes.
                    124: .Sh HISTORY
                    125: The
                    126: .Nm
                    127: command appears in
                    128: .Bx 4.4 .