]>
Commit | Line | Data |
---|---|---|
6dbe3af9 KZ |
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 | .\" | |
e6ed925d SK |
34 | .TH UL "1" "September 2011" "util-linux" "User Commands" |
35 | .SH NAME | |
36 | ul \- do underlining | |
37 | .SH SYNOPSIS | |
07990fdc BS |
38 | .BR ul " [options]" |
39 | .RI [ file ...] | |
e6ed925d SK |
40 | .SH DESCRIPTION |
41 | .B ul | |
42 | reads the named files (or standard input if none are given) and translates | |
43 | occurrences of underscores to the sequence which indicates underlining for | |
44 | the terminal in use, as specified by the environment variable | |
45 | .BR TERM . | |
fd6b7a7f | 46 | The |
e6ed925d SK |
47 | .I terminfo |
48 | database is read to determine the appropriate sequences for underlining. If | |
49 | the terminal is incapable of underlining but is capable of a standout mode, | |
50 | then that is used instead. If the terminal can overstrike, or handles | |
51 | underlining automatically, | |
52 | .B ul | |
6dbe3af9 | 53 | degenerates to |
e6ed925d | 54 | .BR cat (1). |
6dbe3af9 | 55 | If the terminal cannot underline, underlining is ignored. |
e6ed925d SK |
56 | .SH OPTIONS |
57 | .TP | |
58 | \fB\-i\fR, \fB\-\-indicated\fR | |
59 | Underlining is indicated by a separate line containing appropriate dashes | |
60 | `\-'; this is useful when you want to look at the underlining which is | |
61 | present in an | |
62 | .B nroff | |
6dbe3af9 | 63 | output stream on a crt-terminal. |
e6ed925d | 64 | .TP |
a2343e03 | 65 | \fB\-t\fR, \fB\-T\fR, \fB\-\-terminal\fR \fIterminal\fR |
07990fdc BS |
66 | Override the environment variable |
67 | .B TERM | |
68 | with the specified | |
e6ed925d | 69 | .I terminal |
07990fdc | 70 | type. |
e6ed925d SK |
71 | .TP |
72 | \fB\-V\fR, \fB\-\-version\fR | |
d6ff021a | 73 | Display version information and exit. |
e6ed925d SK |
74 | .TP |
75 | \fB\-h\fR, \fB\-\-help\fR | |
b4362b6f | 76 | Display help text and exit. |
e6ed925d | 77 | .SH ENVIRONMENT |
6dbe3af9 | 78 | The following environment variable is used: |
e6ed925d SK |
79 | .TP |
80 | .B TERM | |
6dbe3af9 | 81 | The |
e6ed925d SK |
82 | .B TERM |
83 | variable is used to relate a tty device with its device capability | |
84 | description (see | |
85 | .BR terminfo (5)). | |
86 | .B TERM | |
87 | is set at login time, either by the default terminal type specified in | |
88 | .I /etc/ttys | |
6dbe3af9 | 89 | or as set during the login process by the user in their |
e6ed925d | 90 | .B login |
6dbe3af9 | 91 | file (see |
dbeb1d73 | 92 | .BR setenv (3)). |
e6ed925d SK |
93 | .SH SEE ALSO |
94 | .BR colcrt (1), | |
95 | .BR login (1), | |
96 | .BR man (1), | |
97 | .BR nroff (1), | |
dbeb1d73 | 98 | .BR setenv (3), |
e6ed925d SK |
99 | .BR terminfo (5) |
100 | .SH BUGS | |
07990fdc | 101 | .B nroff |
e6ed925d SK |
102 | usually outputs a series of backspaces and underlines intermixed with the |
103 | text to indicate underlining. No attempt is made to optimize the backward | |
104 | motion. | |
105 | .SH HISTORY | |
6dbe3af9 | 106 | The |
e6ed925d SK |
107 | .B ul |
108 | command appeared in 3.0BSD. | |
109 | .SH AVAILABILITY | |
601d12fb | 110 | The ul command is part of the util-linux package and is available from |
d673b74e | 111 | .UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/ |
e6ed925d SK |
112 | Linux Kernel Archive |
113 | .UE . |