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