diff options
author | John-Mark Gurney <jmg@FreeBSD.org> | 1997-04-27 08:45:46 +0000 |
---|---|---|
committer | John-Mark Gurney <jmg@FreeBSD.org> | 1997-04-27 08:45:46 +0000 |
commit | 93e0d62d1c2a83232e87912c20f74ab92b0f22b2 (patch) | |
tree | 328f08ba7316273f1f02ee69acd5e41cf335b459 /usr.bin/tput | |
parent | 7594bf018f94e4934501263b7183c55a8c1f55e7 (diff) | |
download | src-93e0d62d1c2a83232e87912c20f74ab92b0f22b2.tar.gz src-93e0d62d1c2a83232e87912c20f74ab92b0f22b2.zip |
Notes
Diffstat (limited to 'usr.bin/tput')
-rw-r--r-- | usr.bin/tput/tput.1 | 49 |
1 files changed, 30 insertions, 19 deletions
diff --git a/usr.bin/tput/tput.1 b/usr.bin/tput/tput.1 index 3baa4ce8d61a..403f4ccb3a29 100644 --- a/usr.bin/tput/tput.1 +++ b/usr.bin/tput/tput.1 @@ -30,6 +30,7 @@ .\" SUCH DAMAGE. .\" .\" @(#)tput.1 8.2 (Berkeley) 3/19/94 +.\" $Id$ .\" .Dd March 19, 1994 .Dt TPUT 1 @@ -38,32 +39,37 @@ .Nm tput .Nd terminal capability interface .Sh SYNOPSIS -.Nm tput +.Nm .Op Fl T Ar term .Ar attribute .Sh DESCRIPTION -.Nm Tput -makes terminal-dependent information available to users or shell +The +.Nm +command makes terminal-dependent information available to users or shell applications. The options are as follows: .Bl -tag -width Ds .It Fl T The terminal name as specified in the .Xr termcap -database, for example, ``vt100'' or ``xterm''. +database, for example, +.Dq vt100 +or +.Dq xterm . If not specified, -.Nm tput +.Nm retrieves the .Dq Ev TERM variable from the environment. .El .Pp -.Nm Tput -outputs a string if the +The +.Nm +command outputs a string if the .Ar attribute is of type string; a number if it is of type integer. Otherwise, -.Nm tput +.Nm exits 0 if the terminal has the capability and 1 if it does not, without further action. .Pp @@ -80,36 +86,41 @@ The following special attributes are available: .It clear Clear the screen (the .Xr termcap -``cl'' sequence). +.Dq cl +sequence). .It init Initialize the terminal (the .Xr termcap -``is'' sequence). +.Dq is +sequence). .It longname Print the descriptive name of the user's terminal type. .It reset Reset the terminal (the .Xr termcap -``rs'' sequence). +.Dq rs +sequence). .Sh DIAGNOSTICS The exit value of -.Nm tput +.Nm is based on the last attribute specified. If the attribute is of type string or of type integer, -.Nm tput +.Nm exits 0 if the attribute is defined for this terminal type and 1 if it is not. If the attribute is of type boolean, -.Nm tput +.Nm exits 0 if the terminal has this attribute, and 1 if it does not. -.Nm Tput -exits 2 if any error occurred. +The +.Nm +command exits 2 if any error occurred. .Sh SEE ALSO .Xr termcap 3 , .Xr termcap 5 .Sh BUGS -.Nm Tput -can't really distinguish between different types of attributes. +The +.Nm +command can't really distinguish between different types of attributes. .Pp Some termcap entries depend upon having a .Sq % @@ -121,5 +132,5 @@ stderr. .Sh HISTORY The .Nm -command appears in +command appeared in .Bx 4.4 . |