4.3BSD-Reno/src/usr.bin/col/col.1

.\" Copyright (c) 1990 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Michael Rendell.
.\"
.\" Redistribution and use in source and binary forms are permitted provided
.\" that: (1) source distributions retain this entire copyright notice and
.\" comment, and (2) distributions including binaries display the following
.\" acknowledgement:  ``This product includes software developed by the
.\" University of California, Berkeley and its contributors'' in the
.\" documentation or other materials provided with the distribution and in
.\" all advertising materials mentioning features or use of this software.
.\" Neither the name of the University nor the names of its contributors may
.\" be used to endorse or promote products derived from this software without
.\" specific prior written permission.
.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
.\"
.\"     @(#)col.1	6.6 (Berkeley) 7/24/90
.\"
.Dd July 24, 1990
.Dt COL 1
.Os BSD 4.4
.Sh NAME
.Nm col
.Nd filter reverse line feeds from input
.Sh SYNOPSIS
.Nm col
.Op Fl bfx
.Op Fl l Ar num
.Sh DESCRIPTION
.Nm Col
filters out reverse (and half reverse) line feeds so that the output is
in the correct order and contains only forward and half forward line
feeds, and replaces white-space characters with tabs where possible.
This can be useful in processing the output of
.Xr nroff 1
and
.Xr tbl  1 .
.Pp
.Nm Col
reads from standard input and writes to standard output.
.Pp
The options are as follows:
.Tw Fl
.Tp Fl b
Do not output any backspaces \- print only the last character
written to each column position.
.Tp Fl f
Forward half line feeds are permitted (``fine'' mode).
Normally characters printed on a half line boundary are printed
on the following line.
.Tp Fl x
Output multiple spaces instead of tabs.
.Tp Cx Fl l
.Cx Ar num
.Cx
Buffer at least
.Ar num
lines in memory.
By default, 128 lines are buffered.
.Tp
.Pp
The control sequences for carriage motion that
.Nm col
understands and their decimal values are listed in the following
table:
.Pp
.Dw carriage\ return
.Di L
.Dp ESC\-7
reverse line feed (escape then 7)
.Dp ESC\-8
half reverse line feed (escape then 8)
.Dp ESC\-9
half forward line feed (escape then 9)
.Dp backspace
moves back one column (8); ignored in the first column
.Dp carriage return
(13)
.Dp newline
forward line feed (10); also does carriage return
.Dp shift in
shift to normal character set (15)
.Dp shift out
shift to alternate character set (14)
.Dp space
moves forward one column (32)
.Dp tab
moves forward to next tab stop (9)
.Dp vertical tab
reverse line feed (11)
.Dp
.Pp
All unrecognized control characters and escape sequences are
discarded.
.Pp
.Nm Col
keeps track of the character set as characters are read and makes
sure the character set is correct when they are output.
.Pp
If the input attempts to back up to the last flushed line,
.Nm col
will display a warning message.
.Sh SEE ALSO
.Xr expand 1 ,
.Xr nroff 1 ,
.Xr tbl 1
.Sh HISTORY
A
.Nm col
command
appeared in Version 6 AT&T UNIX.  The BSD
.Nm col
is derived from code written by Michael Rendell.