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