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