xref: /freebsd/usr.bin/ul/ul.1 (revision 2008043f386721d58158e37e0d7e50df8095942d)
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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)ul.1	8.1 (Berkeley) 6/6/93
29.\"
30.Dd October 7, 2020
31.Dt UL 1
32.Os
33.Sh NAME
34.Nm ul
35.Nd do underlining
36.Sh SYNOPSIS
37.Nm
38.Op Fl i
39.Op Fl t Ar terminal
40.Op Ar
41.Sh DESCRIPTION
42The
43.Nm
44utility reads the named files (or standard input if none are given)
45and translates occurrences of underscores to the sequence
46which indicates underlining for the terminal in use, as specified
47by the environment variable
48.Ev TERM .
49The file
50.Pa /etc/termcap
51is read to determine the appropriate sequences for underlining.
52If the terminal is incapable of underlining, but is capable of
53a standout mode then that is used instead.
54If the terminal can overstrike,
55or handles underlining automatically,
56.Nm
57degenerates to
58.Xr cat 1 .
59If the terminal cannot underline, underlining is ignored.
60.Pp
61The following options are available:
62.Bl -tag -width indent
63.It Fl i
64Underlining is indicated by a separate line containing appropriate
65dashes
66.Ql \- .
67.It Fl t Ar terminal
68Overrides the terminal type specified in the environment with
69.Ar terminal .
70.El
71.Sh ENVIRONMENT
72The
73.Ev LANG , LC_ALL , LC_CTYPE
74and
75.Ev TERM
76environment variables affect the execution of
77.Nm
78as described in
79.Xr environ 7 .
80.Sh EXIT STATUS
81.Ex -std
82.Sh SEE ALSO
83.Xr man 1 ,
84.Xr mandoc 1
85.Sh HISTORY
86The
87.Nm
88command appeared in
89.Bx 3.0 .
90