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$
  34 .\"
  35 .Dd June 9, 1993
  36 .Dt EXPAND 1
  37 .Os BSD 4
  38 .Sh NAME
  39 .Nm expand ,
  40 .Nm unexpand
  41 .Nd expand tabs to spaces, and vice versa
  42 .Sh SYNOPSIS
  43 .Nm expand
  44 .Op Fl Ns Ar tabstop
  45 .Op Fl Ns Ar tab1,tab2,...,tabn
  46 .Ar
  47 .Nm unexpand
  48 .Op Fl a
  49 .Ar
  50 .Sh DESCRIPTION
  51 .Nm Expand
  52 processes the named files or the standard input writing
  53 the standard output with tabs changed into blanks.
  54 Backspace characters are preserved into the output and decrement
  55 the column count for tab calculations.
  56 .Nm Expand
  57 is useful for pre-processing character files
  58 (before sorting, looking at specific columns, etc.) that
  59 contain tabs.
  60 .Pp
  61 If a single
  62 .Ar tabstop
  63 argument is given, then tabs are set
  64 .Ar tabstop
  65 spaces apart instead of the default 8.
  66 If multiple tabstops are given then the tabs are set at those
  67 specific columns.
  68 .Pp
  69 .Nm Unexpand
  70 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 Option (with
  74 .Nm unexpand
  75 only):
  76 .Bl -tag -width flag
  77 .It Fl a
  78 By default, only leading blanks and tabs
  79 are reconverted to maximal strings of tabs.  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 .El
  84 .Sh HISTORY
  85 The
  86 .Nm expand
  87 command appeared in
  88 .Bx 3.0 .