kernel: Remove the FFS_ROOT option. It was a no-op since 4.9.
[dragonfly.git] / usr.bin / ul / ul.1
blob6548093706ff435d339f918be6f9f8c42f70694b
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: head/usr.bin/ul/ul.1 216370 2010-12-11 08:32:16Z joel $
30 .\"
31 .Dd December 30, 2013
32 .Dt UL 1
33 .Os
34 .Sh NAME
35 .Nm ul
36 .Nd do underlining
37 .Sh SYNOPSIS
38 .Nm
39 .Op Fl i
40 .Op Fl t Ar terminal
41 .Op Ar
42 .Sh DESCRIPTION
43 The
44 .Nm
45 utility 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 /etc/termcap
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 indent
64 .It Fl i
65 Underlining is indicated by a separate line containing appropriate
66 dashes
67 .Ql \- ;
68 this is useful when you want to look at the underlining
69 which is present in an
70 .Xr nroff 1
71 output stream on a CRT-terminal.
72 .It Fl t Ar terminal
73 Overrides the terminal type specified in the environment with
74 .Ar terminal .
75 .El
76 .Sh ENVIRONMENT
77 The
78 .Ev LANG , LC_ALL , LC_CTYPE
79 and
80 .Ev TERM
81 environment variables affect the execution of
82 .Nm
83 as described in
84 .Xr environ 7 .
85 .Sh EXIT STATUS
86 .Ex -std
87 .Sh SEE ALSO
88 .Xr colcrt 1 ,
89 .Xr man 1 ,
90 .Xr nroff 1
91 .Sh HISTORY
92 The
93 .Nm
94 command appeared in
95 .Bx 3.0 .
96 .Sh BUGS
97 The
98 .Xr nroff 1
99 command usually outputs a series of backspaces and underlines intermixed
100 with the text to indicate underlining.
101 No attempt is made to optimize
102 the backward motion.