Return to expand.1 CVS log

Up to [local] / src / usr.bin / expand

These utilities were already part of 1BSD, and some authors are known.
All facts from the CSRG archive CD 1, also available from minnie.tuhs.org.
Feedback and OK sobrado@, ok jmc@.

Kirk McKusick writes:
"Bill usually used "Bill Joy" when listing author information. Only
occationally did he choose to use William Joy. So, I would recommend
using Bill Joy."

So i'm using that here even though some of the original files
related to this commit do contain the form "William Joy".

.\"	$OpenBSD: expand.1,v 1.18 2011/12/28 01:52:33 schwarze Exp $
.\"	$NetBSD: expand.1,v 1.3 1995/09/02 06:19:45 jtc Exp $
.\"
.\" Copyright (c) 1980, 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)expand.1	8.1 (Berkeley) 6/9/93
.\"
.Dd $Mdocdate: December 28 2011 $
.Dt EXPAND 1
.Os
.Sh NAME
.Nm expand ,
.Nm unexpand
.Nd expand tabs to spaces, and vice versa
.Sh SYNOPSIS
.Nm expand
.Op Fl t Ar tablist
.Op Ar
.Nm unexpand
.Op Fl a
.Op Ar
.Sh DESCRIPTION
.Nm expand
processes the named files or the standard input,
writing the standard output with tabs changed into blanks.
Backspace characters are preserved into the output and decrement
the column count for tab calculations.
.Nm expand
is useful for pre-processing character files
(before sorting, looking at specific columns, etc.) that
contain tabs.
.Pp
.Nm unexpand
puts tabs back into the data from the standard input or the named
files and writes the result on the standard output.
.Pp
The options are as follows:
.Bl -tag -width flag
.It Fl a
.Pq Nm unexpand No only
By default, only leading blanks and tabs
are reconverted to maximal strings of tabs.
If the
.Fl a
option is given, tabs are inserted whenever they would compress the
resultant file by replacing two or more characters.
.It Fl t Ar tablist
.Pq Nm expand No only
If the argument to
.Fl t ,
.Ar tablist ,
consists of a single numerical argument, tabs are set
.Ar tablist
spaces apart instead of the default 8.
If multiple
.Fl t
options are given, then the tabs are set at those
specific columns.
.Pp
Otherwise the argument to
.Fl t
may consist of a list
of two or more positive decimal integers,
comma separated,
in ascending order:
in the event of having to process a
.Aq tab
at a position beyond the last of those specified in a multiple
.Fl t
list,
the
.Aq tab
is replaced by a single
.Aq space
character.
.Pp
This implementation of
.Nm
additionally allows
.Ar tablist
to be specified without using the
.Fl t
flag, by prefixing
.Ar tablist
with a dash
.Pq - .
.El
.Sh EXIT STATUS
The
.Nm expand
and
.Nm unexpand
utilities exit 0 on success or \*(Gt0 if an error occurred.
.Sh SEE ALSO
.Xr fold 1
.Sh STANDARDS
The
.Nm
and
.Nm unexpand
utilities are compliant with the
.St -p1003.1-2008
specification,
with the following exceptions:
.Bl -bullet -offset indent
.It
.Tn POSIX
does not support specifying tabstops without use of the
.Fl t
flag.
.It
.Tn POSIX
specifies that multiple tabstops may be given separated by
commas or blanks.
This implementation supports only comma-separated tabstops.
.It
.Nm unexpand
does not recognise the
.Fl t
flag.
.El
.Sh HISTORY
The
.Nm expand
utility first appeared in
.Bx 1 .