xref: /freebsd/usr.bin/ul/ul.1 (revision d643ff21f427e359be18ddbd254641e2118237a3)
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.
12fe5870b6SBaptiste Daroussin.\" 3. Neither the name of the University nor the names of its contributors
139b50d902SRodney W. Grimes.\"    may be used to endorse or promote products derived from this software
149b50d902SRodney W. Grimes.\"    without specific prior written permission.
159b50d902SRodney W. Grimes.\"
169b50d902SRodney W. Grimes.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
179b50d902SRodney W. Grimes.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
189b50d902SRodney W. Grimes.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
199b50d902SRodney W. Grimes.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
209b50d902SRodney W. Grimes.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
219b50d902SRodney W. Grimes.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
229b50d902SRodney W. Grimes.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
239b50d902SRodney W. Grimes.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
249b50d902SRodney W. Grimes.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
259b50d902SRodney W. Grimes.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
269b50d902SRodney W. Grimes.\" SUCH DAMAGE.
279b50d902SRodney W. Grimes.\"
289b50d902SRodney W. Grimes.\"     @(#)ul.1	8.1 (Berkeley) 6/6/93
29c3aac50fSPeter Wemm.\" $FreeBSD$
309b50d902SRodney W. Grimes.\"
31*d643ff21SFernando Apesteguía.Dd October 7, 2020
329b50d902SRodney W. Grimes.Dt UL 1
3362500372SRuslan Ermilov.Os
349b50d902SRodney W. Grimes.Sh NAME
359b50d902SRodney W. Grimes.Nm ul
369b50d902SRodney W. Grimes.Nd do underlining
379b50d902SRodney W. Grimes.Sh SYNOPSIS
388fe908efSRuslan Ermilov.Nm
399b50d902SRodney W. Grimes.Op Fl i
409b50d902SRodney W. Grimes.Op Fl t Ar terminal
41f682f10cSRuslan Ermilov.Op Ar
429b50d902SRodney W. Grimes.Sh DESCRIPTION
43e8937ba0SPhilippe CharnierThe
44e8937ba0SPhilippe Charnier.Nm
45e8937ba0SPhilippe Charnierutility reads the named files (or standard input if none are given)
469b50d902SRodney W. Grimesand translates occurrences of underscores to the sequence
479b50d902SRodney W. Grimeswhich indicates underlining for the terminal in use, as specified
489b50d902SRodney W. Grimesby the environment variable
499b50d902SRodney W. Grimes.Ev TERM .
509b50d902SRodney W. GrimesThe file
519b50d902SRodney W. Grimes.Pa /etc/termcap
529b50d902SRodney W. Grimesis read to determine the appropriate sequences for underlining.
539b50d902SRodney W. GrimesIf the terminal is incapable of underlining, but is capable of
549b50d902SRodney W. Grimesa standout mode then that is used instead.
559b50d902SRodney W. GrimesIf the terminal can overstrike,
569b50d902SRodney W. Grimesor handles underlining automatically,
57575580b2SPhilippe Charnier.Nm
589b50d902SRodney W. Grimesdegenerates to
599b50d902SRodney W. Grimes.Xr cat 1 .
609b50d902SRodney W. GrimesIf the terminal cannot underline, underlining is ignored.
619b50d902SRodney W. Grimes.Pp
629b50d902SRodney W. GrimesThe following options are available:
635897a066SRuslan Ermilov.Bl -tag -width indent
649b50d902SRodney W. Grimes.It Fl i
659b50d902SRodney W. GrimesUnderlining is indicated by a separate line containing appropriate
665897a066SRuslan Ermilovdashes
67*d643ff21SFernando Apesteguía.Ql \- .
689b50d902SRodney W. Grimes.It Fl t Ar terminal
699b50d902SRodney W. GrimesOverrides the terminal type specified in the environment with
709b50d902SRodney W. Grimes.Ar terminal .
719b50d902SRodney W. Grimes.El
729b50d902SRodney W. Grimes.Sh ENVIRONMENT
739b50d902SRodney W. GrimesThe
74e5afeeb3STim J. Robbins.Ev LANG , LC_ALL , LC_CTYPE
75e5afeeb3STim J. Robbinsand
769b50d902SRodney W. Grimes.Ev TERM
77e5afeeb3STim J. Robbinsenvironment variables affect the execution of
78e5afeeb3STim J. Robbins.Nm
79e5afeeb3STim J. Robbinsas described in
80e5afeeb3STim J. Robbins.Xr environ 7 .
81a866e170SRuslan Ermilov.Sh EXIT STATUS
82ca57a58dSTim J. Robbins.Ex -std
839b50d902SRodney W. Grimes.Sh SEE ALSO
849b50d902SRodney W. Grimes.Xr man 1 ,
85*d643ff21SFernando Apesteguía.Xr mandoc 1
866c7216dfSRuslan Ermilov.Sh HISTORY
876c7216dfSRuslan ErmilovThe
886c7216dfSRuslan Ermilov.Nm
896c7216dfSRuslan Ermilovcommand appeared in
906c7216dfSRuslan Ermilov.Bx 3.0 .
91