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