usr/src/man/man1/ul.1

   1 '\" te
   2 .\" Copyright (c) 1994, Sun Microsystems, Inc.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH UL 1 "Mar 17, 1994"
   7 .SH NAME
   8 ul \- do underlining
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBul\fR [\fB-i\fR] [\fB-t\fR \fIterminal\fR] [\fIfilename\fR]...
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 \fBul\fR reads the named \fIfilename\fRs (or the standard input if none are
  19 given) and translates occurrences of underscores to the sequence which
  20 indicates underlining for the terminal in use, as specified by the environment
  21 variable \fB\fR \fBTERM.\fR \fBul\fR uses the \fB/usr/share/lib/terminfo
  22 \fRentry to determine the appropriate sequences for underlining. If the
  23 terminal is incapable of underlining, but is capable of a standout mode then
  24 that is used instead. If the terminal can overstrike, or handles underlining
  25 automatically, \fBul\fR degenerates to \fBcat\fR(1). If the terminal cannot
  26 underline, underlining is ignored.
  27 .SH OPTIONS
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fB-t\fR\fI terminal\fR\fR
  32 .ad
  33 .RS 15n
  34 Override the terminal kind specified in the environment. If the terminal cannot
  35 underline, underlining is ignored. If the terminal name is not found, no
  36 underlining is attempted.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fB-i\fR\fR
  43 .ad
  44 .RS 15n
  45 Indicate underlining by a separate line containing appropriate dashes
  46 `\fB\(mi\fR\&'; this is useful when you want to look at the underlining which
  47 is present in an \fBnroff\fR(1) output stream on a \fBCRT-terminal.\fR
  48 .RE
  49
  50 .SH RETURN VALUES
  51 .sp
  52 .LP
  53 \fBul\fR returns exit code 1 if the file specified is not found.
  54 .SH FILES
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fB/usr/share/lib/terminfo/*\fR\fR
  59 .ad
  60 .RS 29n
  61
  62 .RE
  63
  64 .SH SEE ALSO
  65 .sp
  66 .LP
  67 \fBcat\fR(1), \fBman\fR(1), \fBnroff\fR(1), \fBattributes\fR(5)
  68 .SH BUGS
  69 .sp
  70 .LP
  71 \fBnroff\fR usually generates a series of backspaces and underlines intermixed
  72 with the text to indicate underlining. \fBul\fR makes attempt to optimize the
  73 backward motion.