xref: /illumos-gate/usr/src/man/man1/ul.1 (revision edb348833aaacfa1176e502ad38875fd0b2717ab)
te
Copyright (c) 1994, Sun Microsystems, Inc.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
UL 1 "Mar 17, 1994"
NAME
ul - do underlining
SYNOPSIS

ul [-i] [-t terminal] [filename]...
DESCRIPTION

ul reads the named filenames (or the standard input if none are given) and translates occurrences of underscores to the sequence which indicates underlining for the terminal in use, as specified by the environment variable TERM. ul uses the /usr/share/lib/terminfo entry to determine the appropriate sequences for underlining. If the terminal is incapable of underlining, but is capable of a standout mode then that is used instead. If the terminal can overstrike, or handles underlining automatically, ul degenerates to cat(1). If the terminal cannot underline, underlining is ignored.

OPTIONS
-t terminal

Override the terminal kind specified in the environment. If the terminal cannot underline, underlining is ignored. If the terminal name is not found, no underlining is attempted.

-i

Indicate underlining by a separate line containing appropriate dashes `-'; this is useful when you want to look at the underlining which is present in an nroff(1) output stream on a CRT-terminal.

RETURN VALUES

ul returns exit code 1 if the file specified is not found.

FILES
/usr/share/lib/terminfo/*

SEE ALSO

cat(1), man(1), nroff(1), attributes(5)

BUGS

nroff usually generates a series of backspaces and underlines intermixed with the text to indicate underlining. ul makes attempt to optimize the backward motion.