share/man/man1/col.1

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 1995, Sun Microsystems, Inc.  All Rights Reserved  Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH COL 1 "Feb 1, 1995"
  11 .SH NAME
  12 col \- reverse line-feeds filter
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 \fBcol\fR [\fB-bfpx\fR]
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBcol\fR utility reads from the standard input and writes to the standard
  23 output. It performs the line overlays implied by reverse line-feeds, and by
  24 forward and reverse half-line-feeds. Unless \fB-x\fR is used, all blank
  25 characters in the input will be converted to tab characters wherever possible.
  26 \fBcol\fR is particularly useful for filtering multi-column output made with
  27 the \fB\&.rt\fR command of \fBnroff\fR(1) and output resulting from use of the
  28 \fBtbl\fR(1) preprocessor.
  29 .sp
  30 .LP
  31 The \fBASCII\fR control characters \fBSO\fR and \fBSI\fR are assumed by
  32 \fBcol\fR to start and end text in an alternative character set. The character
  33 set to which each input character belongs is remembered, and on output \fBSI\fR
  34 and \fBSO\fR characters are generated as appropriate to ensure that each
  35 character is written in the correct character set.
  36 .sp
  37 .LP
  38 On input, the only control characters accepted are space, backspace, tab,
  39 carriage-return and newline characters, \fBSI,\fR \fBSO,\fR \fBVT,\fR reverse
  40 line-feed, forward half-line-feed and reverse half-line-feed. The \fBVT\fR
  41 character is an alternative form of full reverse line-feed, included for
  42 compatibility with some earlier programs of this type. The only other
  43 characters to be copied to the output are those that are printable.
  44 .sp
  45 .LP
  46 The \fBASCII\fR codes for the control functions and line-motion sequences
  47 mentioned above are as given in the table below. \fBESC\fR stands for the
  48 \fBASCII\fR escape character, with the octal code 033; \fBESC\fR\fB\(mi\fR
  49 means a sequence of two characters, \fBESC\fR followed by the character
  50 \fBx\fR.
  51 .sp
  52
  53 .sp
  54 .TS
  55 l l
  56 l l .
  57 reverse line-feed       ESC\(mi7
  58 reverse half-line-feed  ESC\(mi8
  59 forward half-line-feed  ESC\(mi9
  60 vertical-tab (VT)       013
  61 start-of-text (SO)      016
  62 end-of-text (SI)        017
  63 .TE
  64
  65 .SH OPTIONS
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fB-b\fR\fR
  70 .ad
  71 .RS 7n
  72 Assume that the output device in use is not capable of backspacing. In this
  73 case, if two or more characters are to appear in the same place, only the last
  74 one read will be output.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fB-f\fR \fR
  81 .ad
  82 .RS 7n
  83 Although \fBcol\fR accepts half-line motions in its input, it normally does not
  84 emit them on output. Instead, text that would appear between lines is moved to
  85 the next lower full-line boundary. This treatment can be suppressed by the
  86 \fB-f\fR (fine) option; in this case, the output from \fBcol\fR may contain
  87 forward half-line-feeds (ESC-9), but will still never contain either kind of
  88 reverse line motion.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fB-p\fR \fR
  95 .ad
  96 .RS 7n
  97 Normally, \fBcol\fR will ignore any escape sequences unknown to it that are
  98 found in its input; the \fB-p\fR option may be used to cause \fBcol\fR to
  99 output these sequences as regular characters, subject to overprinting from
 100 reverse line motions. The use of this option is highly discouraged unless the
 101 user is fully aware of the textual position of the escape sequences.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fB-x\fR \fR
 108 .ad
 109 .RS 7n
 110 Prevent \fBcol\fR from converting blank characters to tab characters on output
 111 wherever possible. Tab stops are considered to be at each column position
 112 \fIn\fR such that \fIn\fR modulo 8 equals 1.
 113 .RE
 114
 115 .SH ENVIRONMENT VARIABLES
 116 .sp
 117 .LP
 118 See \fBenviron\fR(5) for descriptions of the following environment variables
 119 that affect the execution of \fBcol\fR: \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and
 120 \fBNLSPATH\fR.
 121 .SH EXIT STATUS
 122 .sp
 123 .LP
 124 The following error values are returned:
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fB0\fR \fR
 129 .ad
 130 .RS 7n
 131 Successful completion.
 132 .RE
 133
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fB>0\fR \fR
 138 .ad
 139 .RS 7n
 140 An error occurred.
 141 .RE
 142
 143 .SH ATTRIBUTES
 144 .sp
 145 .LP
 146 See \fBattributes\fR(5) for descriptions of the following attributes:
 147 .sp
 148
 149 .sp
 150 .TS
 151 box;
 152 c | c
 153 l | l .
 154 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 155 CSI     enabled
 156 .TE
 157
 158 .SH SEE ALSO
 159 .sp
 160 .LP
 161 \fBnroff\fR(1), \fBtbl\fR(1), \fBascii\fR(5), \fBattributes\fR(5),
 162 \fBenviron\fR(5)
 163 .SH NOTES
 164 .sp
 165 .LP
 166 The input format accepted by \fBcol\fR matches the output produced by
 167 \fBnroff\fR with either the \fB-T37\fR or \fB-Tlp\fR options. Use \fB-T37\fR
 168 (and the \fB-f\fR option of \fBcol\fR) if the ultimate disposition of the
 169 output of \fBcol\fR will be a device that can interpret half-line motions, and
 170 \fB-Tlp\fR otherwise.
 171 .sp
 172 .LP
 173 \fBcol\fR cannot back up more than 128 lines or handle more than 800 characters
 174 per line.
 175 .sp
 176 .LP
 177 Local vertical motions that would result in backing up over the first line of
 178 the document are ignored. As a result, the first line must not have any
 179 superscripts.