xref: /freebsd/usr.bin/ul/ul.1 (revision a866e170777b42fd7921eadd6e7e664f3a031d60)
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
33c3aac50fSPeter Wemm.\" $FreeBSD$
349b50d902SRodney W. Grimes.\"
35ca57a58dSTim J. Robbins.Dd August 4, 2004
369b50d902SRodney W. Grimes.Dt UL 1
3762500372SRuslan Ermilov.Os
389b50d902SRodney W. Grimes.Sh NAME
399b50d902SRodney W. Grimes.Nm ul
409b50d902SRodney W. Grimes.Nd do underlining
419b50d902SRodney W. Grimes.Sh SYNOPSIS
428fe908efSRuslan Ermilov.Nm
439b50d902SRodney W. Grimes.Op Fl i
449b50d902SRodney W. Grimes.Op Fl t Ar terminal
459b50d902SRodney W. Grimes.Op Ar name Ar ...
469b50d902SRodney W. Grimes.Sh DESCRIPTION
47e8937ba0SPhilippe CharnierThe
48e8937ba0SPhilippe Charnier.Nm
49e8937ba0SPhilippe Charnierutility reads the named files (or standard input if none are given)
509b50d902SRodney W. Grimesand translates occurrences of underscores to the sequence
519b50d902SRodney W. Grimeswhich indicates underlining for the terminal in use, as specified
529b50d902SRodney W. Grimesby the environment variable
539b50d902SRodney W. Grimes.Ev TERM .
549b50d902SRodney W. GrimesThe file
559b50d902SRodney W. Grimes.Pa /etc/termcap
569b50d902SRodney W. Grimesis read to determine the appropriate sequences for underlining.
579b50d902SRodney W. GrimesIf the terminal is incapable of underlining, but is capable of
589b50d902SRodney W. Grimesa standout mode then that is used instead.
599b50d902SRodney W. GrimesIf the terminal can overstrike,
609b50d902SRodney W. Grimesor handles underlining automatically,
61575580b2SPhilippe Charnier.Nm
629b50d902SRodney W. Grimesdegenerates to
639b50d902SRodney W. Grimes.Xr cat 1 .
649b50d902SRodney W. GrimesIf the terminal cannot underline, underlining is ignored.
659b50d902SRodney W. Grimes.Pp
669b50d902SRodney W. GrimesThe following options are available:
679b50d902SRodney W. Grimes.Bl -tag -width Ds
689b50d902SRodney W. Grimes.It Fl i
699b50d902SRodney W. GrimesUnderlining is indicated by a separate line containing appropriate
709b50d902SRodney W. Grimesdashes `\-'; this is useful when you want to look at the underlining
719b50d902SRodney W. Grimeswhich is present in an
726a1be1f5SPhilippe Charnier.Xr nroff 1
739b50d902SRodney W. Grimesoutput stream on a crt-terminal.
749b50d902SRodney W. Grimes.It Fl t Ar terminal
759b50d902SRodney W. GrimesOverrides the terminal type specified in the environment with
769b50d902SRodney W. Grimes.Ar terminal .
779b50d902SRodney W. Grimes.El
789b50d902SRodney W. Grimes.Sh ENVIRONMENT
799b50d902SRodney W. GrimesThe
80e5afeeb3STim J. Robbins.Ev LANG , LC_ALL , LC_CTYPE
81e5afeeb3STim J. Robbinsand
829b50d902SRodney W. Grimes.Ev TERM
83e5afeeb3STim J. Robbinsenvironment variables affect the execution of
84e5afeeb3STim J. Robbins.Nm
85e5afeeb3STim J. Robbinsas described in
86e5afeeb3STim J. Robbins.Xr environ 7 .
87a866e170SRuslan Ermilov.Sh EXIT STATUS
88ca57a58dSTim J. Robbins.Ex -std
899b50d902SRodney W. Grimes.Sh SEE ALSO
90da1ff3cbSWolfram Schneider.Xr colcrt 1 ,
919b50d902SRodney W. Grimes.Xr man 1 ,
92da1ff3cbSWolfram Schneider.Xr nroff 1
939b50d902SRodney W. Grimes.Sh BUGS
94edf0e5b3SMike PritchardThe
95edf0e5b3SMike Pritchard.Xr nroff 1
96edf0e5b3SMike Pritchardcommand usually outputs a series of backspaces and underlines intermixed
976a3e8b0aSRuslan Ermilovwith the text to indicate underlining.
986a3e8b0aSRuslan ErmilovNo attempt is made to optimize
999b50d902SRodney W. Grimesthe backward motion.
1009b50d902SRodney W. Grimes.Sh HISTORY
1019b50d902SRodney W. GrimesThe
1029b50d902SRodney W. Grimes.Nm
1039b50d902SRodney W. Grimescommand appeared in
1049b50d902SRodney W. Grimes.Bx 3.0 .
105