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