usr.bin/expand/expand.1

   1 .\" Copyright (c) 1980, 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)expand.1    8.1 (Berkeley) 6/9/93
  33 .\" $FreeBSD: src/usr.bin/expand/expand.1,v 1.3.2.7 2003/02/25 00:54:13 trhodes Exp $
  34 .\" $DragonFly: src/usr.bin/expand/expand.1,v 1.2 2003/06/17 04:29:26 dillon Exp $
  35 .\"
  36 .Dd April 21, 2002
  37 .Dt EXPAND 1
  38 .Os
  39 .Sh NAME
  40 .Nm expand ,
  41 .Nm unexpand
  42 .Nd expand tabs to spaces, and vice versa
  43 .Sh SYNOPSIS
  44 .Nm
  45 .Oo
  46 .Fl t
  47 .Sm off
  48 .Ar tab1 , tab2 , ... , tabn
  49 .Sm on
  50 .Oc
  51 .Op Ar
  52 .Nm unexpand
  53 .Op Fl a
  54 .Oo
  55 .Fl t
  56 .Sm off
  57 .Ar tab1 , tab2 , ... , tabn
  58 .Sm on
  59 .Oc
  60 .Op Ar
  61 .Sh DESCRIPTION
  62 The
  63 .Nm
  64 utility processes the named files or the standard input writing
  65 the standard output with tabs changed into blanks.
  66 Backspace characters are preserved into the output and decrement
  67 the column count for tab calculations.
  68 The
  69 .Nm
  70 utility is useful for pre-processing character files
  71 (before sorting, looking at specific columns, etc.) that
  72 contain tabs.
  73 .Pp
  74 The
  75 .Nm unexpand
  76 utility puts tabs back into the data from the standard input or the named
  77 files and writes the result on the standard output.
  78 .Pp
  79 The following options are available:
  80 .Bl -tag -width indent
  81 .It Fl a
  82 .Nm ( unexpand
  83 only.)
  84 By default, only leading blanks and tabs
  85 are reconverted to maximal strings of tabs.  If the
  86 .Fl a
  87 option is given, then tabs are inserted whenever they would compress the
  88 resultant file by replacing two or more characters.
  89 .It Fl t Sm Ar tab1 , tab2 , ... , tabn Sm
  90 Set tab stops at column positions
  91 .Ar tab1 , tab2 , ... , tabn .
  92 If only a single number is given, tab stops are set that number of
  93 column positions apart instead of the default number of 8.
  94 .El
  95 .Sh ENVIRONMENT
  96 The
  97 .Ev LANG , LC_ALL
  98 and
  99 .Ev LC_CTYPE
 100 environment variables affect the execution of
 101 .Nm
 102 and
 103 .Nm unexpand
 104 as described in
 105 .Xr environ 7 .
 106 .Sh EXIT STATUS
 107 .Ex -std expand unexpand
 108 .Sh STANDARDS
 109 The
 110 .Nm
 111 and
 112 .Nm unexpand
 113 utilities conform to
 114 .St -p1003.1-2001 .
 115 .Sh HISTORY
 116 The
 117 .Nm
 118 command appeared in
 119 .Bx 3.0 .