xref: /original-bsd/usr.bin/col/col.1 (revision bacd16ee)
1.\" Copyright (c) 1990, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" Michael Rendell.
6.\"
7.\" %sccs.include.redist.man%
8.\"
9.\"     @(#)col.1	8.1 (Berkeley) 06/29/93
10.\"
11.Dd
12.Dt COL 1
13.Os
14.Sh NAME
15.Nm col
16.Nd filter reverse line feeds from input
17.Sh SYNOPSIS
18.Nm col
19.Op Fl bfx
20.Op Fl l Ar num
21.Sh DESCRIPTION
22.Nm Col
23filters out reverse (and half reverse) line feeds so that the output is
24in the correct order with only forward and half forward line
25feeds, and replaces white-space characters with tabs where possible.
26This can be useful in processing the output of
27.Xr nroff 1
28and
29.Xr tbl  1 .
30.Pp
31.Nm Col
32reads from the standard input and writes to the standard output.
33.Pp
34The options are as follows:
35.Bl -tag -width "-l num  "
36.It Fl b
37Do not output any backspaces, printing only the last character
38written to each column position.
39.It Fl f
40Forward half line feeds are permitted (``fine'' mode).
41Normally characters printed on a half line boundary are printed
42on the following line.
43.It Fl x
44Output multiple spaces instead of tabs.
45.It Fl l Ar num
46Buffer at least
47.Ar num
48lines in memory.
49By default, 128 lines are buffered.
50.El
51.Pp
52The control sequences for carriage motion that
53.Nm col
54understands and their decimal values are listed in the following
55table:
56.Pp
57.Bl -tag -width "carriage return" -compact
58.It ESC\-7
59reverse line feed (escape then 7)
60.It ESC\-8
61half reverse line feed (escape then 8)
62.It ESC\-9
63half forward line feed (escape then 9)
64.It backspace
65moves back one column (8); ignored in the first column
66.It carriage return
67(13)
68.It newline
69forward line feed (10); also does carriage return
70.It shift in
71shift to normal character set (15)
72.It shift out
73shift to alternate character set (14)
74.It space
75moves forward one column (32)
76.It tab
77moves forward to next tab stop (9)
78.It vertical tab
79reverse line feed (11)
80.El
81.Pp
82All unrecognized control characters and escape sequences are
83discarded.
84.Pp
85.Nm Col
86keeps track of the character set as characters are read and makes
87sure the character set is correct when they are output.
88.Pp
89If the input attempts to back up to the last flushed line,
90.Nm col
91will display a warning message.
92.Sh SEE ALSO
93.Xr expand 1 ,
94.Xr nroff 1 ,
95.Xr tbl 1
96.Sh HISTORY
97A
98.Nm col
99command
100appeared in Version 6 AT&T UNIX.
101