Return to colcrt.1 CVS log

Up to [local] / src / usr.bin / colcrt

Annotation of src/usr.bin/colcrt/colcrt.1, Revision 1.13

1.13    ! jmc         1: .\"    $OpenBSD: colcrt.1,v 1.12 2006/05/26 17:32:19 jmc Exp $
1.1       deraadt     2: .\"    $NetBSD: colcrt.1,v 1.3 1995/03/26 05:30:59 glass Exp $
                      3: .\"
                      4: .\" Copyright (c) 1980, 1990, 1993
                      5: .\"    The Regents of the University of California.  All rights reserved.
                      6: .\"
                      7: .\" Redistribution and use in source and binary forms, with or without
                      8: .\" modification, are permitted provided that the following conditions
                      9: .\" are met:
                     10: .\" 1. Redistributions of source code must retain the above copyright
                     11: .\"    notice, this list of conditions and the following disclaimer.
                     12: .\" 2. Redistributions in binary form must reproduce the above copyright
                     13: .\"    notice, this list of conditions and the following disclaimer in the
                     14: .\"    documentation and/or other materials provided with the distribution.
1.9       millert    15: .\" 3. Neither the name of the University nor the names of its contributors
1.1       deraadt    16: .\"    may be used to endorse or promote products derived from this software
                     17: .\"    without specific prior written permission.
                     18: .\"
                     19: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     20: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     21: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     22: .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     23: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     24: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     25: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     26: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     27: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     28: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     29: .\" SUCH DAMAGE.
                     30: .\"
                     31: .\"     @(#)colcrt.1   8.1 (Berkeley) 6/30/93
                     32: .\"
1.13    ! jmc        33: .Dd $Mdocdate$
1.1       deraadt    34: .Dt COLCRT 1
1.4       aaron      35: .Os
1.1       deraadt    36: .Sh NAME
                     37: .Nm colcrt
1.11      jmc        38: .Nd filter nroff output
1.1       deraadt    39: .Sh SYNOPSIS
                     40: .Nm colcrt
                     41: .Op Fl
1.12      jmc        42: .Op Fl 2
1.1       deraadt    43: .Op Ar
                     44: .Sh DESCRIPTION
1.5       aaron      45: .Nm
1.1       deraadt    46: provides virtual half-line and reverse line feed sequences
                     47: for terminals without such capability, and on which overstriking
                     48: is destructive.
1.4       aaron      49: Half-line characters and underlining (changed to dashing
                     50: .Sq - )
1.1       deraadt    51: are placed on new lines in between the normal output lines.
                     52: .Pp
1.6       aaron      53: The options are as follows:
1.1       deraadt    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
1.5       aaron      73: .Nm
1.12      jmc        74: would be:
                     75: .Bd -literal -offset indent
                     76: $ tbl exum2.n | nroff -ms | colcrt - | more
1.1       deraadt    77: .Ed
                     78: .Sh SEE ALSO
1.3       aaron      79: .Xr col 1 ,
                     80: .Xr more 1 ,
1.1       deraadt    81: .Xr nroff 1 ,
                     82: .Xr troff 1 ,
                     83: .Xr ul 1
1.7       aaron      84: .Sh HISTORY
                     85: The
                     86: .Nm
                     87: command appeared in
                     88: .Bx 3.0 .
1.1       deraadt    89: .Sh BUGS
                     90: Should fold underlines onto blanks even with the
1.10      jmc        91: .Sq Fl
1.1       deraadt    92: option so that
                     93: a true underline character would show.
                     94: .Pp
                     95: Can't back up more than 102 lines.
                     96: .Pp
                     97: General overstriking is lost;
                     98: as a special case
1.4       aaron      99: .Ql |
1.1       deraadt   100: overstruck with
1.4       aaron     101: .Ql -
1.1       deraadt   102: or underline becomes
1.4       aaron     103: .Ql + .
1.1       deraadt   104: .Pp
                    105: Lines are trimmed to 132 characters.
                    106: .Pp
                    107: Some provision should be made for processing superscripts and subscripts
                    108: in documents which are already double-spaced.