xref: /freebsd/usr.bin/ul/ul.1 (revision 9b50d9027575220cb6dd09b3e62f03f511e908b8)
19b50d902SRodney W. Grimes.\" Copyright (c) 1980, 1991, 1993
29b50d902SRodney W. Grimes.\"	The Regents of the University of California.  All rights reserved.
39b50d902SRodney W. Grimes.\"
49b50d902SRodney W. Grimes.\" Redistribution and use in source and binary forms, with or without
59b50d902SRodney W. Grimes.\" modification, are permitted provided that the following conditions
69b50d902SRodney W. Grimes.\" are met:
79b50d902SRodney W. Grimes.\" 1. Redistributions of source code must retain the above copyright
89b50d902SRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer.
99b50d902SRodney W. Grimes.\" 2. Redistributions in binary form must reproduce the above copyright
109b50d902SRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer in the
119b50d902SRodney W. Grimes.\"    documentation and/or other materials provided with the distribution.
129b50d902SRodney W. Grimes.\" 3. All advertising materials mentioning features or use of this software
139b50d902SRodney W. Grimes.\"    must display the following acknowledgement:
149b50d902SRodney W. Grimes.\"	This product includes software developed by the University of
159b50d902SRodney W. Grimes.\"	California, Berkeley and its contributors.
169b50d902SRodney W. Grimes.\" 4. Neither the name of the University nor the names of its contributors
179b50d902SRodney W. Grimes.\"    may be used to endorse or promote products derived from this software
189b50d902SRodney W. Grimes.\"    without specific prior written permission.
199b50d902SRodney W. Grimes.\"
209b50d902SRodney W. Grimes.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
219b50d902SRodney W. Grimes.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
229b50d902SRodney W. Grimes.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
239b50d902SRodney W. Grimes.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
249b50d902SRodney W. Grimes.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
259b50d902SRodney W. Grimes.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
269b50d902SRodney W. Grimes.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
279b50d902SRodney W. Grimes.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
289b50d902SRodney W. Grimes.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
299b50d902SRodney W. Grimes.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
309b50d902SRodney W. Grimes.\" SUCH DAMAGE.
319b50d902SRodney W. Grimes.\"
329b50d902SRodney W. Grimes.\"     @(#)ul.1	8.1 (Berkeley) 6/6/93
339b50d902SRodney W. Grimes.\"
349b50d902SRodney W. Grimes.Dd June 6, 1993
359b50d902SRodney W. Grimes.Dt UL 1
369b50d902SRodney W. Grimes.Os BSD 4
379b50d902SRodney W. Grimes.Sh NAME
389b50d902SRodney W. Grimes.Nm ul
399b50d902SRodney W. Grimes.Nd do underlining
409b50d902SRodney W. Grimes.Sh SYNOPSIS
419b50d902SRodney W. Grimes.Nm ul
429b50d902SRodney W. Grimes.Op Fl i
439b50d902SRodney W. Grimes.Op Fl t Ar terminal
449b50d902SRodney W. Grimes.Op Ar name Ar ...
459b50d902SRodney W. Grimes.Sh DESCRIPTION
469b50d902SRodney W. Grimes.Nm Ul
479b50d902SRodney W. Grimesreads the named files (or standard input if none are given)
489b50d902SRodney W. Grimesand translates occurrences of underscores to the sequence
499b50d902SRodney W. Grimeswhich indicates underlining for the terminal in use, as specified
509b50d902SRodney W. Grimesby the environment variable
519b50d902SRodney W. Grimes.Ev TERM .
529b50d902SRodney W. GrimesThe file
539b50d902SRodney W. Grimes.Pa /etc/termcap
549b50d902SRodney W. Grimesis read to determine the appropriate sequences for underlining.
559b50d902SRodney W. GrimesIf the terminal is incapable of underlining, but is capable of
569b50d902SRodney W. Grimesa standout mode then that is used instead.
579b50d902SRodney W. GrimesIf the terminal can overstrike,
589b50d902SRodney W. Grimesor handles underlining automatically,
599b50d902SRodney W. Grimes.Nm ul
609b50d902SRodney W. Grimesdegenerates to
619b50d902SRodney W. Grimes.Xr cat 1 .
629b50d902SRodney W. GrimesIf the terminal cannot underline, underlining is ignored.
639b50d902SRodney W. Grimes.Pp
649b50d902SRodney W. GrimesThe following options are available:
659b50d902SRodney W. Grimes.Bl -tag -width Ds
669b50d902SRodney W. Grimes.It Fl i
679b50d902SRodney W. GrimesUnderlining is indicated by a separate line containing appropriate
689b50d902SRodney W. Grimesdashes `\-'; this is useful when you want to look at the underlining
699b50d902SRodney W. Grimeswhich is present in an
709b50d902SRodney W. Grimes.Xr nroff
719b50d902SRodney W. Grimesoutput stream on a crt-terminal.
729b50d902SRodney W. Grimes.It Fl t Ar terminal
739b50d902SRodney W. GrimesOverrides the terminal type specified in the environment with
749b50d902SRodney W. Grimes.Ar terminal .
759b50d902SRodney W. Grimes.El
769b50d902SRodney W. Grimes.Sh ENVIRONMENT
779b50d902SRodney W. GrimesThe following environment variable is used:
789b50d902SRodney W. Grimes.Bl -tag -width TERM
799b50d902SRodney W. Grimes.It Ev TERM
809b50d902SRodney W. GrimesThe
819b50d902SRodney W. Grimes.Ev TERM
829b50d902SRodney W. Grimesvariable is used to relate a tty device
839b50d902SRodney W. Grimeswith its device capability description (see
849b50d902SRodney W. Grimes.Xr termcap 5 ) .
859b50d902SRodney W. Grimes.Ev TERM
869b50d902SRodney W. Grimesis set at login time, either by the default terminal type
879b50d902SRodney W. Grimesspecified in
889b50d902SRodney W. Grimes.Pa /etc/ttys
899b50d902SRodney W. Grimesor as set during the login process by the user in their
909b50d902SRodney W. Grimes.Pa login
919b50d902SRodney W. Grimesfile (see
929b50d902SRodney W. Grimes.Xr setenv 1 ) .
939b50d902SRodney W. Grimes.El
949b50d902SRodney W. Grimes.Sh SEE ALSO
959b50d902SRodney W. Grimes.Xr man 1 ,
969b50d902SRodney W. Grimes.Xr nroff 1 ,
979b50d902SRodney W. Grimes.Xr colcrt 1
989b50d902SRodney W. Grimes.Sh BUGS
999b50d902SRodney W. Grimes.Xr Nroff
1009b50d902SRodney W. Grimesusually outputs a series of backspaces and underlines intermixed
1019b50d902SRodney W. Grimeswith the text to indicate underlining.  No attempt is made to optimize
1029b50d902SRodney W. Grimesthe backward motion.
1039b50d902SRodney W. Grimes.Sh HISTORY
1049b50d902SRodney W. GrimesThe
1059b50d902SRodney W. Grimes.Nm
1069b50d902SRodney W. Grimescommand appeared in
1079b50d902SRodney W. Grimes.Bx 3.0 .
108