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