usr/src/man/man1/expand.1

   1 '\" te
   2 .\"  Copyright (c) 1992, X/Open Company Limited  All Rights Reserved  Portions Copyright (c) 1995, Sun Microsystems, Inc.  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 EXPAND 1 "Feb 1, 1995"
  11 .SH NAME
  12 expand, unexpand \- expand TAB characters to SPACE characters, and vice versa
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 \fBexpand\fR [\fB-t\fR \fItablist\fR] [\fIfile\fR]...
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBexpand\fR [\fB-\fItabstop\fR\fR] [\fB-\fItab1,\fR\fR \fItab2,.\fR \fI\&.\fR \fI\&.,\fR \fItabn\fR] [\fIfile\fR]...
  22 .fi
  23
  24 .LP
  25 .nf
  26 \fBunexpand\fR [\fB-a\fR] [\fB-t\fR \fItablist\fR] [\fIfile\fR]...
  27 .fi
  28
  29 .SH DESCRIPTION
  30 .sp
  31 .LP
  32 The \fBexpand\fR utility copies \fIfile\fRs (or the standard input) to the
  33 standard output, with TAB characters expanded to SPACE characters. BACKSPACE
  34 characters are preserved into the output and decrement the column count for TAB
  35 calculations. \fBexpand\fR is useful for pre-processing character files (before
  36 sorting, looking at specific columns, and so forth) that contain TAB
  37 characters.
  38 .sp
  39 .LP
  40 \fBunexpand\fR copies \fIfile\fRs (or the standard input) to the standard
  41 output, putting TAB characters back into the data. By default, only leading
  42 SPACE and TAB characters are converted to strings of tabs, but this can be
  43 overridden by the \fB-a\fR option (see the OPTIONS section below).
  44 .SH OPTIONS
  45 .sp
  46 .LP
  47 The following options are supported for \fBexpand\fR:
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fB-t\fR \fItablist\fR \fR
  52 .ad
  53 .RS 26n
  54 Specifies the tab stops. The argument \fItablist\fR must consist of a single
  55 positive decimal integer or multiple positive decimal integers, separated by
  56 blank characters or commas, in ascending order. If a single number is given,
  57 tabs will be set \fItablist\fR column positions apart instead of the default
  58 \fB8\fR. If multiple numbers are given, the tabs will be set at those specific
  59 column positions.
  60 .sp
  61 Each tab-stop position \fIN\fR must be an integer value greater than zero, and
  62 the list must be in strictly ascending order. This is taken to mean that, from
  63 the start of a line of output, tabbing to position \fIN\fR causes the next
  64 character output to be in the (\fIN\fR+1)th column position on that line.
  65 .sp
  66 In the event of \fBexpand\fR having to process a tab character at a position
  67 beyond the last of those specified in a multiple tab-stop list, the tab
  68 character is replaced by a single space character in the output.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fB-\fR\fItabstop\fR \fR
  75 .ad
  76 .RS 26n
  77 Specifies as a single argument, sets TAB characters \fItabstop\fR SPACE
  78 characters apart instead of the default \fB8\fR.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fB-\fR\fItab1\fR\fI,\|tab2,...,tabn\fR \fR
  85 .ad
  86 .RS 26n
  87 Sets TAB characters at the columns specified by
  88 \fB-\fR\fItab1,tab2,...,\|tabn\fR
  89 .RE
  90
  91 .sp
  92 .LP
  93 The following options are supported for \fBunexpand\fR:
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fB-a\fR \fR
  98 .ad
  99 .RS 15n
 100 Inserts TAB characters when replacing a run of two or more SPACE characters
 101 would produce a smaller output file.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fB-t\fR \fItablist\fR \fR
 108 .ad
 109 .RS 15n
 110 Specifies the tab stops. The option-argument \fItablist\fR must be a single
 111 argument consisting of a single positive decimal integer or multiple positive
 112 decimal integers, separated by blank characters or commas, in ascending order.
 113 If a single number is given, tabs will be set \fItablist\fR column positions
 114 apart instead of the default \fB8\fR. If multiple numbers are given, the tabs
 115 will be set at those specific column positions. Each tab-stop position \fIN\fR
 116 must be an integer value greater than zero, and the list must be in strictly
 117 ascending order. This is taken to mean that, from the start of a line of
 118 output, tabbing to position \fIN\fR will cause the next character output to be
 119 in the (\fIN\fR+1)th column position on that line. When the \fB-t\fR option is
 120 not specified, the default is the equivalent of specifying \fB-t\fR \fB8\fR
 121 (except for the interaction with \fB-a\fR, described below).
 122 .sp
 123 No space-to-tab character conversions occur for characters at positions beyond
 124 the last of those specified in a multiple tab-stop list.
 125 .sp
 126 When \fB-t\fR is specified, the presence or absence of the \fB-a\fR option is
 127 ignored; conversion will not be limited to the processing of leading blank
 128 characters.
 129 .RE
 130
 131 .SH OPERANDS
 132 .sp
 133 .LP
 134 The following ooperand is supported for \fBexpand\fR and \fBunexpand\fR:
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fB\fIfile\fR\fR \fR
 139 .ad
 140 .RS 9n
 141 The path name of a text file to be used as input.
 142 .RE
 143
 144 .SH ENVIRONMENT VARIABLES
 145 .sp
 146 .LP
 147 See \fBenviron\fR(5) for descriptions of the following environment variables
 148 that affect the execution of \fBexpand\fR and \fBunexpand\fR: \fBLANG\fR,
 149 \fBLC_ALL\fR, \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
 150 .SH EXIT STATUS
 151 .sp
 152 .LP
 153 The following exit values are returned:
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fB0\fR \fR
 158 .ad
 159 .RS 7n
 160 Successful completion
 161 .RE
 162
 163 .sp
 164 .ne 2
 165 .na
 166 \fB\fB>0\fR \fR
 167 .ad
 168 .RS 7n
 169 An error occurred.
 170 .RE
 171
 172 .SH ATTRIBUTES
 173 .sp
 174 .LP
 175 See \fBattributes\fR(5) for descriptions of the following attributes:
 176 .sp
 177
 178 .sp
 179 .TS
 180 box;
 181 c | c
 182 l | l .
 183 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 184 _
 185 CSI     enabled
 186 _
 187 Interface Stability     Standard
 188 .TE
 189
 190 .SH SEE ALSO
 191 .sp
 192 .LP
 193 \fBtabs\fR(1), \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5)