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