Annotation of src/usr.bin/ul/ul.1, Revision 1.7
1.7 ! aaron 1: .\" $OpenBSD: ul.1,v 1.6 2000/03/11 21:40:06 aaron Exp $
1.1 deraadt 2: .\" $NetBSD: ul.1,v 1.3 1994/12/07 00:28:23 jtc Exp $
3: .\"
4: .\" Copyright (c) 1980, 1991, 1993
5: .\" The Regents of the University of California. All rights reserved.
6: .\"
7: .\" Redistribution and use in source and binary forms, with or without
8: .\" modification, are permitted provided that the following conditions
9: .\" are met:
10: .\" 1. Redistributions of source code must retain the above copyright
11: .\" notice, this list of conditions and the following disclaimer.
12: .\" 2. Redistributions in binary form must reproduce the above copyright
13: .\" notice, this list of conditions and the following disclaimer in the
14: .\" documentation and/or other materials provided with the distribution.
15: .\" 3. All advertising materials mentioning features or use of this software
16: .\" must display the following acknowledgement:
17: .\" This product includes software developed by the University of
18: .\" California, Berkeley and its contributors.
19: .\" 4. Neither the name of the University nor the names of its contributors
20: .\" may be used to endorse or promote products derived from this software
21: .\" without specific prior written permission.
22: .\"
23: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33: .\" SUCH DAMAGE.
34: .\"
35: .\" @(#)ul.1 8.1 (Berkeley) 6/6/93
36: .\"
37: .Dd June 6, 1993
38: .Dt UL 1
1.4 aaron 39: .Os
1.1 deraadt 40: .Sh NAME
41: .Nm ul
42: .Nd do underlining
43: .Sh SYNOPSIS
44: .Nm ul
45: .Op Fl i
46: .Op Fl t Ar terminal
47: .Op Ar name Ar ...
48: .Sh DESCRIPTION
1.5 aaron 49: .Nm
1.1 deraadt 50: reads the named files (or standard input if none are given)
51: and translates occurrences of underscores to the sequence
52: which indicates underlining for the terminal in use, as specified
53: by the environment variable
54: .Ev TERM .
55: The file
56: .Pa /etc/termcap
57: is read to determine the appropriate sequences for underlining.
58: If the terminal is incapable of underlining, but is capable of
1.3 aaron 59: a standout mode, then that is used instead.
1.1 deraadt 60: If the terminal can overstrike,
61: or handles underlining automatically,
1.5 aaron 62: .Nm
1.1 deraadt 63: degenerates to
64: .Xr cat 1 .
65: If the terminal cannot underline, underlining is ignored.
66: .Pp
1.5 aaron 67: The options are as follows:
1.1 deraadt 68: .Bl -tag -width Ds
69: .It Fl i
70: Underlining is indicated by a separate line containing appropriate
1.6 aaron 71: dashes
72: .Pq Ql - ;
73: this is useful when you want to look at the underlining
1.1 deraadt 74: which is present in an
1.3 aaron 75: .Xr nroff 1
1.1 deraadt 76: output stream on a crt-terminal.
77: .It Fl t Ar terminal
78: Overrides the terminal type specified in the environment with
79: .Ar terminal .
80: .El
81: .Sh ENVIRONMENT
1.6 aaron 82: The following environment variables affect the execution of
83: .Nm ul :
1.1 deraadt 84: .Bl -tag -width TERM
85: .It Ev TERM
1.6 aaron 86: Used to relate a tty device
1.1 deraadt 87: with its device capability description (see
88: .Xr termcap 5 ) .
89: .Ev TERM
90: is set at login time, either by the default terminal type
91: specified in
92: .Pa /etc/ttys
93: or as set during the login process by the user in their
94: .Pa login
95: file (see
1.4 aaron 96: .Xr setenv 1 ) .
1.1 deraadt 97: .El
98: .Sh SEE ALSO
1.3 aaron 99: .Xr colcrt 1 ,
1.1 deraadt 100: .Xr man 1 ,
1.3 aaron 101: .Xr nroff 1
1.7 ! aaron 102: .Sh HISTORY
! 103: The
! 104: .Nm
! 105: command appeared in
! 106: .Bx 3.0 .
1.1 deraadt 107: .Sh BUGS
1.3 aaron 108: .Xr nroff 1
1.1 deraadt 109: usually outputs a series of backspaces and underlines intermixed
1.6 aaron 110: with the text to indicate underlining.
111: No attempt is made to optimize the backward motion.