xref: /freebsd/usr.bin/ul/ul.1 (revision 9768746b)
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.\" $FreeBSD$
30.\"
31.Dd October 7, 2020
32.Dt UL 1
33.Os
34.Sh NAME
35.Nm ul
36.Nd do underlining
37.Sh SYNOPSIS
38.Nm
39.Op Fl i
40.Op Fl t Ar terminal
41.Op Ar
42.Sh DESCRIPTION
43The
44.Nm
45utility reads the named files (or standard input if none are given)
46and translates occurrences of underscores to the sequence
47which indicates underlining for the terminal in use, as specified
48by the environment variable
49.Ev TERM .
50The file
51.Pa /etc/termcap
52is read to determine the appropriate sequences for underlining.
53If the terminal is incapable of underlining, but is capable of
54a standout mode then that is used instead.
55If the terminal can overstrike,
56or handles underlining automatically,
57.Nm
58degenerates to
59.Xr cat 1 .
60If the terminal cannot underline, underlining is ignored.
61.Pp
62The following options are available:
63.Bl -tag -width indent
64.It Fl i
65Underlining is indicated by a separate line containing appropriate
66dashes
67.Ql \- .
68.It Fl t Ar terminal
69Overrides the terminal type specified in the environment with
70.Ar terminal .
71.El
72.Sh ENVIRONMENT
73The
74.Ev LANG , LC_ALL , LC_CTYPE
75and
76.Ev TERM
77environment variables affect the execution of
78.Nm
79as described in
80.Xr environ 7 .
81.Sh EXIT STATUS
82.Ex -std
83.Sh SEE ALSO
84.Xr man 1 ,
85.Xr mandoc 1
86.Sh HISTORY
87The
88.Nm
89command appeared in
90.Bx 3.0 .
91