xref: /original-bsd/usr.bin/ul/ul.1 (revision c3e32dec)
1.\" Copyright (c) 1980, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" %sccs.include.redist.man%
5.\"
6.\"     @(#)ul.1	8.1 (Berkeley) 06/06/93
7.\"
8.Dd
9.Dt UL 1
10.Os BSD 4
11.Sh NAME
12.Nm ul
13.Nd do underlining
14.Sh SYNOPSIS
15.Nm ul
16.Op Fl i
17.Op Fl t Ar terminal
18.Op Ar name Ar ...
19.Sh DESCRIPTION
20.Nm Ul
21reads the named files (or standard input if none are given)
22and translates occurrences of underscores to the sequence
23which indicates underlining for the terminal in use, as specified
24by the environment variable
25.Ev TERM .
26The file
27.Pa /etc/termcap
28is read to determine the appropriate sequences for underlining.
29If the terminal is incapable of underlining, but is capable of
30a standout mode then that is used instead.
31If the terminal can overstrike,
32or handles underlining automatically,
33.Nm ul
34degenerates to
35.Xr cat 1 .
36If the terminal cannot underline, underlining is ignored.
37.Pp
38The following options are available:
39.Bl -tag -width Ds
40.It Fl i
41Underlining is indicated by a separate line containing appropriate
42dashes `\-'; this is useful when you want to look at the underlining
43which is present in an
44.Xr nroff
45output stream on a crt-terminal.
46.It Fl t Ar terminal
47Overrides the terminal type specified in the environment with
48.Ar terminal .
49.El
50.Sh ENVIRONMENT
51The following environment variable is used:
52.Bl -tag -width TERM
53.It Ev TERM
54The
55.Ev TERM
56variable is used to relate a tty device
57with its device capability description (see
58.Xr termcap 5 ) .
59.Ev TERM
60is set at login time, either by the default terminal type
61specified in
62.Pa /etc/ttys
63or as set during the login process by the user in their
64.Pa login
65file (see
66.Xr setenv 1 ) .
67.El
68.Sh SEE ALSO
69.Xr man 1 ,
70.Xr nroff 1 ,
71.Xr colcrt 1
72.Sh BUGS
73.Xr Nroff
74usually outputs a series of backspaces and underlines intermixed
75with the text to indicate underlining.  No attempt is made to optimize
76the backward motion.
77.Sh HISTORY
78The
79.Nm
80command appeared in
81.Bx 3.0 .
82