usr.bin/ul/ul.1

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