Annotation of src/usr.bin/col/col.1, Revision 1.7
1.7 ! aaron 1: .\" $OpenBSD: col.1,v 1.6 2000/11/09 17:52:06 aaron 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
1.7 ! aaron 48: .Op Fl bfhx
1.1 deraadt 49: .Op Fl l Ar num
50: .Sh DESCRIPTION
1.4 aaron 51: .Nm
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 whitespace characters with tabs where possible.
1.1 deraadt 55: This can be useful in processing the output of
56: .Xr nroff 1
57: and
1.5 aaron 58: .Xr tbl 1 .
1.1 deraadt 59: .Pp
1.4 aaron 60: .Nm
1.1 deraadt 61: reads from the standard input and writes to the standard output.
62: .Pp
63: The options are as follows:
1.6 aaron 64: .Bl -tag -width Ds
1.1 deraadt 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
1.4 aaron 69: Forward half-line feeds are permitted
70: .Pf ( Ns Dq fine
71: mode).
72: Normally characters printed on a half-line boundary are printed
1.1 deraadt 73: on the following line.
1.7 ! aaron 74: .It Fl h
! 75: Compress spaces into tabs.
! 76: This is the default behavior.
1.1 deraadt 77: .It Fl x
78: Output multiple spaces instead of tabs.
79: .It Fl l Ar num
80: Buffer at least
81: .Ar num
82: lines in memory.
83: By default, 128 lines are buffered.
84: .El
85: .Pp
86: The control sequences for carriage motion that
1.4 aaron 87: .Nm
1.1 deraadt 88: understands and their decimal values are listed in the following
89: table:
90: .Pp
91: .Bl -tag -width "carriage return" -compact
92: .It ESC\-7
1.4 aaron 93: Reverse line feed (escape then 7).
1.7 ! aaron 94: .It ESC\-10
! 95: Half reverse line feed (escape then 10).
! 96: .It ESC\-11
! 97: Half forward line feed (escape then 11).
1.1 deraadt 98: .It backspace
1.4 aaron 99: Moves back one column (8); ignored in the first column.
1.1 deraadt 100: .It carriage return
101: (13)
102: .It newline
1.4 aaron 103: Forward line feed (10); also does carriage return.
1.1 deraadt 104: .It shift in
1.4 aaron 105: Shift to normal character set (15).
1.1 deraadt 106: .It shift out
1.4 aaron 107: Shift to alternate character set (14).
1.1 deraadt 108: .It space
1.4 aaron 109: Moves forward one column (32).
1.1 deraadt 110: .It tab
1.4 aaron 111: Moves forward to next tab stop (9).
1.1 deraadt 112: .It vertical tab
1.4 aaron 113: Reverse line feed (11).
1.1 deraadt 114: .El
115: .Pp
116: All unrecognized control characters and escape sequences are
117: discarded.
118: .Pp
1.4 aaron 119: .Nm
1.1 deraadt 120: keeps track of the character set as characters are read and makes
121: sure the character set is correct when they are output.
122: .Pp
123: If the input attempts to back up to the last flushed line,
1.4 aaron 124: .Nm
1.1 deraadt 125: will display a warning message.
126: .Sh SEE ALSO
127: .Xr expand 1 ,
128: .Xr nroff 1 ,
129: .Xr tbl 1
130: .Sh HISTORY
131: A
1.4 aaron 132: .Nm
133: command appeared in
1.1 deraadt 134: .At v6 .