BSD 4_3_Net_2 release

[unix-history] / usr / src / usr.bin / tput / tput.1

diff --git a/usr/src/usr.bin/tput/tput.1 b/usr/src/usr.bin/tput/tput.1
index 7836d09..de57040 100644 (file)
--- a/usr/src/usr.bin/tput/tput.1
+++ b/usr/src/usr.bin/tput/tput.1
@@ -1,93 +1,112 @@
 .\" Copyright (c) 1989, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" Copyright (c) 1989, 1990 The Regents of the University of California.
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"     @(#)tput.1     6.4 (Berkeley) 6/24/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.TH TPUT 1 "%Q"
-.UC 7
-.SH NAME
-tput \- terminal capability interface
-.SH SYNOPSIS
-.ft B
-tput [ -T term ] attribute
-.ft R
-.SH DESCRIPTION
-.I Tput
+.\"     @(#)tput.1     6.4 (Berkeley) 4/23/91
+.\"
+.Dd April 23, 1991
+.Dt TPUT 1
+.Os
+.Sh NAME
+.Nm tput
+.Nd terminal capability interface
+.Sh SYNOPSIS
+.Nm tput
+.Op Fl T Ar term
+.Ar attribute
+.Sh DESCRIPTION
+.Nm Tput

 makes terminal-dependent information available to users or shell
 applications.
 The options are as follows:
 makes terminal-dependent information available to users or shell
 applications.
 The options are as follows:

-.TP
-\-T
+.Bl -tag -width Ds
+.It Fl T

 The terminal name as specified in the
 The terminal name as specified in the

-.I termcap
+.Xr termcap

 database, for example, ``vt100'' or ``xterm''.
 If not specified,
 database, for example, ``vt100'' or ``xterm''.
 If not specified,

-.I tput
-retrieves the ``TERM'' variable from the environment.
-.PP
-.I Tput
+.Nm tput
+retrieves the
+.Dq Ev TERM
+variable from the environment.
+.El
+.Pp
+.Nm Tput

 outputs a string if the
 outputs a string if the

-.I attribute
+.Ar attribute

 is of type string; a number if it is of type integer.
 Otherwise,
 is of type string; a number if it is of type integer.
 Otherwise,

-.I tput
+.Nm tput

 exits 0 if the terminal has the capability and 1 if it does not,
 without further action.
 exits 0 if the terminal has the capability and 1 if it does not,
 without further action.

-.PP
+.Pp

 The following special attributes are available:
 The following special attributes are available:

-.TP
-clear
-.br
+.Bl -tag -width Ar
+.It Ar clear

 Clear the screen (the
 Clear the screen (the

-.I termcap
+.Xr termcap

 ``cl'' sequence).
 ``cl'' sequence).

-.TP
-init
-.br
+.It Ar init

 Initialize the terminal (the
 Initialize the terminal (the

-.I termcap
+.Xr termcap

 ``is'' sequence).
 ``is'' sequence).

-.TP
-longname
+.It Ar longname

 Print the descriptive name of the user's terminal type.
 Print the descriptive name of the user's terminal type.

-.TP
-reset
-.br
+.It Ar reset

 Reset the terminal (the
 Reset the terminal (the

-.I termcap
+.Xr termcap

 ``rs'' sequence).
 ``rs'' sequence).

-.SH DIAGNOSTICS
+.Sh DIAGNOSTICS

 The exit value of
 The exit value of

-.I tput
+.Nm tput

 is based on the last attribute specified.
 If the attribute is of type string or of type integer,
 is based on the last attribute specified.
 If the attribute is of type string or of type integer,

-.I tput
+.Nm tput

 exits 0 if the attribute is defined for this terminal type and 1
 if it is not.
 If the attribute is of type boolean,
 exits 0 if the attribute is defined for this terminal type and 1
 if it is not.
 If the attribute is of type boolean,

-.I tput
+.Nm tput

 exits 0 if the terminal has this attribute, and 1 if it does not.
 exits 0 if the terminal has this attribute, and 1 if it does not.

-.I Tput
+.Nm Tput

 exits 2 if any error occurred.
 exits 2 if any error occurred.

-.SH "SEE ALSO"
-termcap(3), termcap(5)
-.SH BUGS
-.I Tput
+.Sh SEE ALSO
+.Xr termcap 3 ,
+.Xr termcap 5
+.Sh BUGS
+.Nm Tput

 can't really distinguish between different types of attributes.
 This is due to the limited interface in the current version of
 can't really distinguish between different types of attributes.
 This is due to the limited interface in the current version of

-.IR termcap (3),
+.Xr termcap 3 ,

 and will be fixed in the near future.
 and will be fixed in the near future.

+.Sh HISTORY
+The
+.Nm
+command is
+.Ud .