Fix mdoc(7)/man(7) mix up.
[netbsd-mini2440.git] / usr.bin / colcrt / colcrt.1
blobe749cff9309bf6050595aab9efc08e5e51ef9d3c
1 .\"     $NetBSD: colcrt.1,v 1.7 2001/12/01 18:57:03 wiz Exp $
2 .\"
3 .\" Copyright (c) 1980, 1990, 1993
4 .\"     The Regents of the University of California.  All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the University nor the names of its contributors
15 .\"    may be used to endorse or promote products derived from this software
16 .\"    without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\"     @(#)colcrt.1    8.1 (Berkeley) 6/30/93
31 .\"
32 .Dd June 30, 1993
33 .Dt COLCRT 1
34 .Os
35 .Sh NAME
36 .Nm colcrt
37 .Nd filter nroff output for CRT previewing
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl
41 .Op Fl \&2
42 .Op Ar
43 .Sh DESCRIPTION
44 .Nm
45 provides virtual half-line and reverse line feed sequences
46 for terminals without such capability, and on which overstriking
47 is destructive.
48 Half-line characters and underlining (changed to dashing `\-')
49 are placed on new lines in between the normal output lines.
50 .Pp
51 Available options:
52 .Bl -tag -width Ds
53 .It Fl
54 Suppress all underlining.
55 This option is especially useful for previewing
56 .Em allboxed
57 tables from
58 .Xr tbl 1 .
59 .It Fl 2
60 Causes all half-lines to be printed, effectively double spacing the output.
61 Normally, a minimal space output format is used which will suppress empty
62 lines.
63 The program never suppresses two consecutive empty lines, however.
64 The
65 .Fl 2
66 option is useful for sending output to the line printer when the output
67 contains superscripts and subscripts which would otherwise be invisible.
68 .El
69 .Sh EXAMPLES
70 A typical use of
71 .Nm
72 would be
73 .Bd -literal
74 tbl exum2.n \&| nroff \-ms \&| colcrt \- \&| more
75 .Ed
76 .Sh SEE ALSO
77 .Xr col 1 ,
78 .Xr more 1 ,
79 .Xr nroff 1 ,
80 .Xr troff 1 ,
81 .Xr ul 1
82 .Sh HISTORY
83 The
84 .Nm
85 command appeared in
86 .Bx 3.0 .
87 .Sh BUGS
88 Should fold underlines onto blanks even with the
89 .Ql Fl
90 option so that
91 a true underline character would show.
92 .Pp
93 Can't back up more than 102 lines.
94 .Pp
95 General overstriking is lost;
96 as a special case
97 .Ql \&|
98 overstruck with
99 .Ql \-
100 or underline becomes
101 .Ql \&+ .
103 Lines are trimmed to 132 characters.
105 Some provision should be made for processing superscripts and subscripts
106 in documents which are already double-spaced.