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