text-utils/col.1

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