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