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