usr.bin/ul/ul.1

   1 .\"     $NetBSD: ul.1,v 1.11 2012/04/21 12:27:30 roy Exp $
   2 .\"
   3 .\" Copyright (c) 1980, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)ul.1        8.1 (Berkeley) 6/6/93
  31 .\"
  32 .Dd April 5, 2012
  33 .Dt UL 1
  34 .Os
  35 .Sh NAME
  36 .Nm ul
  37 .Nd do underlining
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl i
  41 .Op Fl t Ar terminal
  42 .Op Ar name Ar ...
  43 .Sh DESCRIPTION
  44 .Nm
  45 reads the named files (or standard input if none are given)
  46 and translates occurrences of underscores to the sequence
  47 which indicates underlining for the terminal in use, as specified
  48 by the environment variable
  49 .Ev TERM .
  50 The file
  51 .Pa /usr/share/misc/terminfo
  52 is read to determine the appropriate sequences for underlining.
  53 If the terminal is incapable of underlining, but is capable of
  54 a standout mode then that is used instead.
  55 If the terminal can overstrike,
  56 or handles underlining automatically,
  57 .Nm
  58 degenerates to
  59 .Xr cat 1 .
  60 If the terminal cannot underline, underlining is ignored.
  61 .Pp
  62 The following options are available:
  63 .Bl -tag -width Ds
  64 .It Fl i
  65 Underlining is indicated by a separate line containing appropriate
  66 dashes `\-'; this is useful when you want to look at the underlining
  67 which is present in an
  68 .Xr nroff 1
  69 output stream on a crt-terminal.
  70 .It Fl t Ar terminal
  71 Overrides the terminal type specified in the environment with
  72 .Ar terminal .
  73 .El
  74 .Sh ENVIRONMENT
  75 The following environment variable is used:
  76 .Bl -tag -width TERM
  77 .It Ev TERM
  78 The
  79 .Ev TERM
  80 variable is used to relate a tty device
  81 with its device capability description (see
  82 .Xr terminfo 5 ) .
  83 .Ev TERM
  84 is set at login time, either by the default terminal type
  85 specified in
  86 .Pa /etc/ttys
  87 or as set during the login process by the user in their
  88 .Pa login
  89 file (see for example
  90 .Xr csh 1 Ns 's Ic setenv ) .
  91 .El
  92 .Sh SEE ALSO
  93 .Xr colcrt 1 ,
  94 .Xr man 1 ,
  95 .Xr nroff 1
  96 .Sh HISTORY
  97 The
  98 .Nm
  99 command appeared in
 100 .Bx 3.0 .
 101 .Sh BUGS
 102 .Xr nroff 1
 103 usually outputs a series of backspaces and underlines intermixed
 104 with the text to indicate underlining.  No attempt is made to optimize
 105 the backward motion.