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