Upload Tizen:Base source
[framework/base/util-linux-ng.git] / text-utils / colcrt.1
1 .\" Copyright (c) 1980, 1990, 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 .\"     @(#)colcrt.1    8.1 (Berkeley) 6/30/93
33 .\"
34 .Dd June 30, 1993
35 .Dt COLCRT 1
36 .Os BSD 3
37 .Sh NAME
38 .Nm colcrt
39 .Nd filter nroff output for CRT previewing
40 .Sh SYNOPSIS
41 .Nm colcrt
42 .Op Fl
43 .Op Fl \&2
44 .Op Ar
45 .Sh DESCRIPTION
46 .Nm Colcrt
47 provides virtual half-line and reverse line feed sequences
48 for terminals without such capability, and on which overstriking
49 is destructive.
50 Half-line characters and underlining (changed to dashing `\-')
51 are placed on new lines in between the normal output lines.
52 .Pp
53 Available options:
54 .Bl -tag -width Ds
55 .It Fl
56 Suppress all underlining.
57 This option is especially useful for previewing
58 .Em allboxed
59 tables from
60 .Xr tbl 1 .
61 .It Fl 2
62 Causes all half-lines to be printed, effectively double spacing the output.
63 Normally, a minimal space output format is used which will suppress empty
64 lines.
65 The program never suppresses two consecutive empty lines, however.
66 The
67 .Fl 2
68 option is useful for sending output to the line printer when the output
69 contains superscripts and subscripts which would otherwise be invisible.
70 .El
71 .Sh EXAMPLES
72 A typical use of
73 .Nm colcrt
74 would be
75 .Bd -literal
76 tbl exum2.n \&| nroff \-ms \&| colcrt \- \&| more
77 .Ed
78 .Sh SEE ALSO
79 .Xr nroff 1 ,
80 .Xr troff 1 ,
81 .Xr col 1 ,
82 .Xr more 1 ,
83 .Xr ul 1
84 .Sh BUGS
85 Should fold underlines onto blanks even with the
86 .Ql Fl
87 option so that
88 a true underline character would show.
89 .Pp
90 Can't back up more than 102 lines.
91 .Pp
92 General overstriking is lost;
93 as a special case
94 .Ql \&|
95 overstruck with
96 .Ql \-
97 or underline becomes
98 .Ql \&+ .
99 .Pp
100 Lines are trimmed to 132 characters.
101 .Pp
102 Some provision should be made for processing superscripts and subscripts
103 in documents which are already double-spaced.
104 .Sh HISTORY
105 The
106 .Nm
107 command appeared in 
108 .Bx 3.0 .
109 .Sh AVAILABILITY
110 The colcrt command is part of the util-linux-ng package and is available from
111 ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/.