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 .\"
  30 .Dd June 6, 2015
  31 .Dt EXPAND 1
  32 .Os
  33 .Sh NAME
  34 .Nm expand ,
  35 .Nm unexpand
  36 .Nd expand tabs to spaces, and vice versa
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Oo
  40 .Fl t
  41 .Sm off
  42 .Ar tab1 , tab2 , ... , tabn
  43 .Sm on
  44 .Oc
  45 .Op Ar
  46 .Nm unexpand
  47 .Oo
  48 .Fl a | t
  49 .Sm off
  50 .Ar tab1 , tab2 , ... , tabn
  51 .Sm on
  52 .Oc
  53 .Op Ar
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 utility processes the named files or the standard input writing
  58 the standard output with tabs changed into blanks.
  59 Backspace characters are preserved into the output and decrement
  60 the column count for tab calculations.
  61 The
  62 .Nm
  63 utility is useful for pre-processing character files
  64 (before sorting, looking at specific columns, etc.) that
  65 contain tabs.
  66 .Pp
  67 The
  68 .Nm unexpand
  69 utility puts tabs back into the data from the standard input or the named
  70 files and writes the result on the standard output.
  71 .Pp
  72 The following options are available:
  73 .Bl -tag -width indent
  74 .It Fl a
  75 .Nm ( unexpand
  76 only.)
  77 By default, only leading blanks and tabs
  78 are reconverted to maximal strings of tabs.
  79 If the
  80 .Fl a
  81 option is given, then tabs are inserted whenever they would compress the
  82 resultant file by replacing two or more characters.
  83 .It Fl t \&Sm Ar tab1 , tab2 , ... , tabn \&Sm
  84 Set tab stops at column positions
  85 .Ar tab1 , tab2 , ... , tabn .
  86 If only a single number is given, tab stops are set that number of
  87 column positions apart instead of the default number of 8.
  88 .El
  89 .Sh ENVIRONMENT
  90 The
  91 .Ev LANG , LC_ALL
  92 and
  93 .Ev LC_CTYPE
  94 environment variables affect the execution of
  95 .Nm
  96 and
  97 .Nm unexpand
  98 as described in
  99 .Xr environ 7 .
 100 .Sh EXIT STATUS
 101 .Ex -std expand unexpand
 102 .Sh STANDARDS
 103 The
 104 .Nm
 105 and
 106 .Nm unexpand
 107 utilities conform to
 108 .St -p1003.1-2001 .
 109 .Sh HISTORY
 110 The
 111 .Nm
 112 utility first appeared in
 113 .Bx 1 .