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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)ul.1        8.1 (Berkeley) 6/6/93
  29 .\" $FreeBSD: src/usr.bin/ul/ul.1,v 1.6.2.4 2002/06/21 15:29:52 charnier Exp $
  30 .\" $DragonFly: src/usr.bin/ul/ul.1,v 1.4 2006/04/17 18:01:38 swildner Exp $
  31 .\"
  32 .Dd June 6, 1993
  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 The
  45 .Nm
  46 utility reads the named files (or standard input if none are given)
  47 and translates occurrences of underscores to the sequence
  48 which indicates underlining for the terminal in use, as specified
  49 by the environment variable
  50 .Ev TERM .
  51 The file
  52 .Pa /etc/termcap
  53 is read to determine the appropriate sequences for underlining.
  54 If the terminal is incapable of underlining, but is capable of
  55 a standout mode then that is used instead.
  56 If the terminal can overstrike,
  57 or handles underlining automatically,
  58 .Nm
  59 degenerates to
  60 .Xr cat 1 .
  61 If the terminal cannot underline, underlining is ignored.
  62 .Pp
  63 The following options are available:
  64 .Bl -tag -width Ds
  65 .It Fl i
  66 Underlining is indicated by a separate line containing appropriate
  67 dashes `\-'; this is useful when you want to look at the underlining
  68 which is present in an
  69 .Xr nroff 1
  70 output stream on a crt-terminal.
  71 .It Fl t Ar terminal
  72 Overrides the terminal type specified in the environment with
  73 .Ar terminal .
  74 .El
  75 .Sh ENVIRONMENT
  76 The following environment variable is used:
  77 .Bl -tag -width TERM
  78 .It Ev TERM
  79 The
  80 .Ev TERM
  81 variable is used to relate a tty device
  82 with its device capability description (see
  83 .Xr termcap 5 ) .
  84 .Ev TERM
  85 is set at login time, either by the default terminal type
  86 specified in
  87 .Pa /etc/ttys
  88 or as set during the login process by the user in their
  89 .Pa login
  90 file (see
  91 .Xr environ 7 ) .
  92 .El
  93 .Sh SEE ALSO
  94 .Xr colcrt 1 ,
  95 .Xr man 1 ,
  96 .Xr nroff 1
  97 .Sh HISTORY
  98 The
  99 .Nm
 100 command appeared in
 101 .Bx 3.0 .
 102 .Sh BUGS
 103 The
 104 .Xr nroff 1
 105 command usually outputs a series of backspaces and underlines intermixed
 106 with the text to indicate underlining.  No attempt is made to optimize
 107 the backward motion.