Return to tput.1 CVS log

Up to [CSRG BSD Unix] / 43BSDReno / usr.bin / tput

Annotation of 43BSDReno/usr.bin/tput/tput.1, revision 1.1.1.1

1.1       root        1: .\" Copyright (c) 1989, 1990 The Regents of the University of California.
                      2: .\" All rights reserved.
                      3: .\"
                      4: .\" Redistribution and use in source and binary forms are permitted provided
                      5: .\" that: (1) source distributions retain this entire copyright notice and
                      6: .\" comment, and (2) distributions including binaries display the following
                      7: .\" acknowledgement:  ``This product includes software developed by the
                      8: .\" University of California, Berkeley and its contributors'' in the
                      9: .\" documentation or other materials provided with the distribution and in
                     10: .\" all advertising materials mentioning features or use of this software.
                     11: .\" Neither the name of the University nor the names of its contributors may
                     12: .\" be used to endorse or promote products derived from this software without
                     13: .\" specific prior written permission.
                     14: .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
                     15: .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
                     16: .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
                     17: .\"
                     18: .\"     @(#)tput.1     6.4 (Berkeley) 6/24/90
                     19: .\"
                     20: .TH TPUT 1 "%Q"
                     21: .UC 7
                     22: .SH NAME
                     23: tput \- terminal capability interface
                     24: .SH SYNOPSIS
                     25: .ft B
                     26: tput [ -T term ] attribute
                     27: .ft R
                     28: .SH DESCRIPTION
                     29: .I Tput
                     30: makes terminal-dependent information available to users or shell
                     31: applications.
                     32: The options are as follows:
                     33: .TP
                     34: \-T
                     35: The terminal name as specified in the
                     36: .I termcap
                     37: database, for example, ``vt100'' or ``xterm''.
                     38: If not specified,
                     39: .I tput
                     40: retrieves the ``TERM'' variable from the environment.
                     41: .PP
                     42: .I Tput
                     43: outputs a string if the
                     44: .I attribute
                     45: is of type string; a number if it is of type integer.
                     46: Otherwise,
                     47: .I tput
                     48: exits 0 if the terminal has the capability and 1 if it does not,
                     49: without further action.
                     50: .PP
                     51: The following special attributes are available:
                     52: .TP
                     53: clear
                     54: .br
                     55: Clear the screen (the
                     56: .I termcap
                     57: ``cl'' sequence).
                     58: .TP
                     59: init
                     60: .br
                     61: Initialize the terminal (the
                     62: .I termcap
                     63: ``is'' sequence).
                     64: .TP
                     65: longname
                     66: Print the descriptive name of the user's terminal type.
                     67: .TP
                     68: reset
                     69: .br
                     70: Reset the terminal (the
                     71: .I termcap
                     72: ``rs'' sequence).
                     73: .SH DIAGNOSTICS
                     74: The exit value of
                     75: .I tput
                     76: is based on the last attribute specified.
                     77: If the attribute is of type string or of type integer,
                     78: .I tput
                     79: exits 0 if the attribute is defined for this terminal type and 1
                     80: if it is not.
                     81: If the attribute is of type boolean,
                     82: .I tput
                     83: exits 0 if the terminal has this attribute, and 1 if it does not.
                     84: .I Tput
                     85: exits 2 if any error occurred.
                     86: .SH "SEE ALSO"
                     87: termcap(3), termcap(5)
                     88: .SH BUGS
                     89: .I Tput
                     90: can't really distinguish between different types of attributes.
                     91: This is due to the limited interface in the current version of
                     92: .IR termcap (3),
                     93: and will be fixed in the near future.

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.