src/col/col.1

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