xref: /freebsd/usr.bin/ul/ul.1 (revision a866e170777b42fd7921eadd6e7e664f3a031d60)
1.\" Copyright (c) 1980, 1991, 1993
2.\"	The Regents of the University of California.  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	8.1 (Berkeley) 6/6/93
33.\" $FreeBSD$
34.\"
35.Dd August 4, 2004
36.Dt UL 1
37.Os
38.Sh NAME
39.Nm ul
40.Nd do underlining
41.Sh SYNOPSIS
42.Nm
43.Op Fl i
44.Op Fl t Ar terminal
45.Op Ar name Ar ...
46.Sh DESCRIPTION
47The
48.Nm
49utility reads the named files (or standard input if none are given)
50and translates occurrences of underscores to the sequence
51which indicates underlining for the terminal in use, as specified
52by the environment variable
53.Ev TERM .
54The file
55.Pa /etc/termcap
56is read to determine the appropriate sequences for underlining.
57If the terminal is incapable of underlining, but is capable of
58a standout mode then that is used instead.
59If the terminal can overstrike,
60or handles underlining automatically,
61.Nm
62degenerates to
63.Xr cat 1 .
64If the terminal cannot underline, underlining is ignored.
65.Pp
66The following options are available:
67.Bl -tag -width Ds
68.It Fl i
69Underlining is indicated by a separate line containing appropriate
70dashes `\-'; this is useful when you want to look at the underlining
71which is present in an
72.Xr nroff 1
73output stream on a crt-terminal.
74.It Fl t Ar terminal
75Overrides the terminal type specified in the environment with
76.Ar terminal .
77.El
78.Sh ENVIRONMENT
79The
80.Ev LANG , LC_ALL , LC_CTYPE
81and
82.Ev TERM
83environment variables affect the execution of
84.Nm
85as described in
86.Xr environ 7 .
87.Sh EXIT STATUS
88.Ex -std
89.Sh SEE ALSO
90.Xr colcrt 1 ,
91.Xr man 1 ,
92.Xr nroff 1
93.Sh BUGS
94The
95.Xr nroff 1
96command usually outputs a series of backspaces and underlines intermixed
97with the text to indicate underlining.
98No attempt is made to optimize
99the backward motion.
100.Sh HISTORY
101The
102.Nm
103command appeared in
104.Bx 3.0 .
105