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. All advertising materials mentioning features or use of this software 13.\" must display the following acknowledgement: 14.\" This product includes software developed by the University of 15.\" California, Berkeley and its contributors. 16.\" 4. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)ul.1 8.1 (Berkeley) 6/6/93 33.\" $FreeBSD: src/usr.bin/ul/ul.1,v 1.6.2.4 2002/06/21 15:29:52 charnier Exp $ 34.\" 35.Dd June 6, 1993 36.Dt UL 1 37.Os 38.Sh NAME 39.Nm ul 40.Nd do underlining 41.Sh SYNOPSIS 42.Nm 43.Op Fl i 44.Op Fl t Ar terminal 45.Op Ar name Ar ... 46.Sh DESCRIPTION 47The 48.Nm 49utility reads the named files (or standard input if none are given) 50and translates occurrences of underscores to the sequence 51which indicates underlining for the terminal in use, as specified 52by the environment variable 53.Ev TERM . 54The file 55.Pa /etc/termcap 56is read to determine the appropriate sequences for underlining. 57If the terminal is incapable of underlining, but is capable of 58a standout mode then that is used instead. 59If the terminal can overstrike, 60or handles underlining automatically, 61.Nm 62degenerates to 63.Xr cat 1 . 64If the terminal cannot underline, underlining is ignored. 65.Pp 66The following options are available: 67.Bl -tag -width Ds 68.It Fl i 69Underlining is indicated by a separate line containing appropriate 70dashes `\-'; this is useful when you want to look at the underlining 71which is present in an 72.Xr nroff 73output stream on a crt-terminal. 74.It Fl t Ar terminal 75Overrides the terminal type specified in the environment with 76.Ar terminal . 77.El 78.Sh ENVIRONMENT 79The following environment variable is used: 80.Bl -tag -width TERM 81.It Ev TERM 82The 83.Ev TERM 84variable is used to relate a tty device 85with its device capability description (see 86.Xr termcap 5 ) . 87.Ev TERM 88is set at login time, either by the default terminal type 89specified in 90.Pa /etc/ttys 91or as set during the login process by the user in their 92.Pa login 93file (see 94.Xr environ 7 ) . 95.El 96.Sh SEE ALSO 97.Xr colcrt 1 , 98.Xr man 1 , 99.Xr nroff 1 100.Sh BUGS 101The 102.Xr nroff 1 103command usually outputs a series of backspaces and underlines intermixed 104with the text to indicate underlining. No attempt is made to optimize 105the backward motion. 106.Sh HISTORY 107The 108.Nm 109command appeared in 110.Bx 3.0 . 111