kernel: Fix buildkernel without INVARIANTS.
[dragonfly.git] / usr.bin / ul / ul.1
blob8936df35f13a501af929b4c79a7f866ab172be84
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: src/usr.bin/ul/ul.1,v 1.6.2.4 2002/06/21 15:29:52 charnier Exp $
34 .\" $DragonFly: src/usr.bin/ul/ul.1,v 1.4 2006/04/17 18:01:38 swildner Exp $
35 .\"
36 .Dd June 6, 1993
37 .Dt UL 1
38 .Os
39 .Sh NAME
40 .Nm ul
41 .Nd do underlining
42 .Sh SYNOPSIS
43 .Nm
44 .Op Fl i
45 .Op Fl t Ar terminal
46 .Op Ar name Ar ...
47 .Sh DESCRIPTION
48 The
49 .Nm
50 utility reads the named files (or standard input if none are given)
51 and translates occurrences of underscores to the sequence
52 which indicates underlining for the terminal in use, as specified
53 by the environment variable
54 .Ev TERM .
55 The file
56 .Pa /etc/termcap
57 is read to determine the appropriate sequences for underlining.
58 If the terminal is incapable of underlining, but is capable of
59 a standout mode then that is used instead.
60 If the terminal can overstrike,
61 or handles underlining automatically,
62 .Nm
63 degenerates to
64 .Xr cat 1 .
65 If the terminal cannot underline, underlining is ignored.
66 .Pp
67 The following options are available:
68 .Bl -tag -width Ds
69 .It Fl i
70 Underlining is indicated by a separate line containing appropriate
71 dashes `\-'; this is useful when you want to look at the underlining
72 which is present in an
73 .Xr nroff 1
74 output stream on a crt-terminal.
75 .It Fl t Ar terminal
76 Overrides the terminal type specified in the environment with
77 .Ar terminal .
78 .El
79 .Sh ENVIRONMENT
80 The following environment variable is used:
81 .Bl -tag -width TERM
82 .It Ev TERM
83 The
84 .Ev TERM
85 variable is used to relate a tty device
86 with its device capability description (see
87 .Xr termcap 5 ) .
88 .Ev TERM
89 is set at login time, either by the default terminal type
90 specified in
91 .Pa /etc/ttys
92 or as set during the login process by the user in their
93 .Pa login
94 file (see
95 .Xr environ 7 ) .
96 .El
97 .Sh SEE ALSO
98 .Xr colcrt 1 ,
99 .Xr man 1 ,
100 .Xr nroff 1
101 .Sh HISTORY
104 command appeared in
105 .Bx 3.0 .
106 .Sh BUGS
108 .Xr nroff 1
109 command usually outputs a series of backspaces and underlines intermixed
110 with the text to indicate underlining.  No attempt is made to optimize
111 the backward motion.