Annotation of src/usr.bin/col/col.1, Revision 1.3
1.3 ! aaron 1: .\" $OpenBSD: col.1,v 1.2 1996/06/26 05:32:09 deraadt Exp $
1.1 deraadt 2: .\" $NetBSD: col.1,v 1.4 1995/03/26 05:25:52 glass Exp $
3: .\"
4: .\" Copyright (c) 1990, 1993
5: .\" The Regents of the University of California. All rights reserved.
6: .\"
7: .\" This code is derived from software contributed to Berkeley by
8: .\" Michael Rendell.
9: .\"
10: .\" Redistribution and use in source and binary forms, with or without
11: .\" modification, are permitted provided that the following conditions
12: .\" are met:
13: .\" 1. Redistributions of source code must retain the above copyright
14: .\" notice, this list of conditions and the following disclaimer.
15: .\" 2. Redistributions in binary form must reproduce the above copyright
16: .\" notice, this list of conditions and the following disclaimer in the
17: .\" documentation and/or other materials provided with the distribution.
18: .\" 3. All advertising materials mentioning features or use of this software
19: .\" must display the following acknowledgement:
20: .\" This product includes software developed by the University of
21: .\" California, Berkeley and its contributors.
22: .\" 4. Neither the name of the University nor the names of its contributors
23: .\" may be used to endorse or promote products derived from this software
24: .\" without specific prior written permission.
25: .\"
26: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36: .\" SUCH DAMAGE.
37: .\"
38: .\" @(#)col.1 8.1 (Berkeley) 6/29/93
39: .\"
40: .Dd June 29, 1993
41: .Dt COL 1
42: .Os
43: .Sh NAME
44: .Nm col
45: .Nd filter reverse line feeds from input
46: .Sh SYNOPSIS
47: .Nm col
48: .Op Fl bfx
49: .Op Fl l Ar num
50: .Sh DESCRIPTION
1.3 ! aaron 51: .Nm col
1.1 deraadt 52: filters out reverse (and half reverse) line feeds so that the output is
53: in the correct order with only forward and half forward line
54: feeds, and replaces white-space characters with tabs where possible.
55: This can be useful in processing the output of
56: .Xr nroff 1
57: and
58: .Xr tbl 1 .
59: .Pp
1.3 ! aaron 60: .Nm col
1.1 deraadt 61: reads from the standard input and writes to the standard output.
62: .Pp
63: The options are as follows:
64: .Bl -tag -width "-l num "
65: .It Fl b
66: Do not output any backspaces, printing only the last character
67: written to each column position.
68: .It Fl f
69: Forward half line feeds are permitted (``fine'' mode).
70: Normally characters printed on a half line boundary are printed
71: on the following line.
72: .It Fl x
73: Output multiple spaces instead of tabs.
74: .It Fl l Ar num
75: Buffer at least
76: .Ar num
77: lines in memory.
78: By default, 128 lines are buffered.
79: .El
80: .Pp
81: The control sequences for carriage motion that
82: .Nm col
83: understands and their decimal values are listed in the following
84: table:
85: .Pp
86: .Bl -tag -width "carriage return" -compact
87: .It ESC\-7
88: reverse line feed (escape then 7)
89: .It ESC\-8
90: half reverse line feed (escape then 8)
91: .It ESC\-9
92: half forward line feed (escape then 9)
93: .It backspace
94: moves back one column (8); ignored in the first column
95: .It carriage return
96: (13)
97: .It newline
98: forward line feed (10); also does carriage return
99: .It shift in
100: shift to normal character set (15)
101: .It shift out
102: shift to alternate character set (14)
103: .It space
104: moves forward one column (32)
105: .It tab
106: moves forward to next tab stop (9)
107: .It vertical tab
108: reverse line feed (11)
109: .El
110: .Pp
111: All unrecognized control characters and escape sequences are
112: discarded.
113: .Pp
1.3 ! aaron 114: .Nm col
1.1 deraadt 115: keeps track of the character set as characters are read and makes
116: sure the character set is correct when they are output.
117: .Pp
118: If the input attempts to back up to the last flushed line,
119: .Nm col
120: will display a warning message.
121: .Sh SEE ALSO
122: .Xr expand 1 ,
123: .Xr nroff 1 ,
124: .Xr tbl 1
125: .Sh HISTORY
126: A
127: .Nm col
128: command appeared in
129: .At v6 .