fix exit change; major whitespace cleanup
[unix-history] / usr / src / usr.bin / colcrt / colcrt.1
CommitLineData
b5dc1377 1.\" Copyright (c) 1980, 1990 The Regents of the University of California.
297a0a40 2.\" All rights reserved.
d5baed0e 3.\"
b5dc1377 4.\" %sccs.include.redist.man%
297a0a40 5.\"
0e853b88 6.\" @(#)colcrt.1 6.7 (Berkeley) %G%
d5baed0e 7.\"
b5dc1377
CL
8.Dd
9.Dt COLCRT 1
0e853b88 10.Os BSD 3
b5dc1377
CL
11.Sh NAME
12.Nm colcrt
13.Nd filter nroff output for CRT previewing
14.Sh SYNOPSIS
15.Nm colcrt
16.Op Fl
5325ced3 17.Op Fl \&2
0e853b88 18.Op Ar
b5dc1377
CL
19.Sh DESCRIPTION
20.Nm Colcrt
d5baed0e
KM
21provides virtual half-line and reverse line feed sequences
22for terminals without such capability, and on which overstriking
23is destructive.
24Half-line characters and underlining (changed to dashing `\-')
25are placed on new lines in between the normal output lines.
b5dc1377 26.Pp
0e853b88
CL
27Available options:
28.Bl -tag -width Ds
29.It Fl
b5dc1377 30Suppress all underlining.
d5baed0e 31It is especially useful for previewing
0e853b88 32.Em allboxed
d5baed0e 33tables from
b5dc1377 34.Xr tbl 1 .
0e853b88 35.It Fl 2
b5dc1377 36Causes all half-lines to be printed, effectively double spacing the output.
d5baed0e
KM
37Normally, a minimal space output format is used which will suppress empty
38lines.
39The program never suppresses two consecutive empty lines, however.
40The
b5dc1377 41.Fl 2
d5baed0e
KM
42option is useful for sending output to the line printer when the output
43contains superscripts and subscripts which would otherwise be invisible.
0e853b88
CL
44.El
45.Sh EXAMPLES
d5baed0e 46A typical use of
b5dc1377 47.Nm colcrt
d5baed0e 48would be
0e853b88
CL
49.Bd -literal
50tbl exum2.n \&| nroff \-ms \&| colcrt \- \&| more
51.Ed
b5dc1377
CL
52.Sh SEE ALSO
53.Xr nroff 1 ,
54.Xr troff 1 ,
55.Xr col 1 ,
56.Xr more 1 ,
57.Xr ul 1
b5dc1377 58.Sh BUGS
d5baed0e 59Should fold underlines onto blanks even with the
0e853b88 60.Ql Fl
d5baed0e
KM
61option so that
62a true underline character would show; if we did this, however,
b5dc1377 63.Nm colcrt
d5baed0e 64wouldn't get rid of
0e853b88 65.Ar cu Ns 'd
d5baed0e
KM
66underlining
67completely.
b5dc1377 68.Pp
d5baed0e 69Can't back up more than 102 lines.
b5dc1377 70.Pp
d5baed0e 71General overstriking is lost;
0e853b88
CL
72as a special case
73.Ql \&|
74overstruck with
75.Ql \-
76or underline becomes
77.Ql \&+ .
b5dc1377 78.Pp
d5baed0e 79Lines are trimmed to 132 characters.
b5dc1377 80.Pp
d5baed0e
KM
81Some provision should be made for processing superscripts and subscripts
82in documents which are already double-spaced.
0e853b88
CL
83.Sh HISTORY
84The
85.Nm
86command appeared in
87.Bx 3.0 .