Annotation of src/usr.bin/expand/expand.1, Revision 1.1.1.1
1.1 deraadt 1: .\" $NetBSD: expand.1,v 1.3 1995/09/02 06:19:45 jtc Exp $
2: .\"
3: .\" Copyright (c) 1980, 1990, 1993
4: .\" The Regents of the University of California. All rights reserved.
5: .\"
6: .\" Redistribution and use in source and binary forms, with or without
7: .\" modification, are permitted provided that the following conditions
8: .\" are met:
9: .\" 1. Redistributions of source code must retain the above copyright
10: .\" notice, this list of conditions and the following disclaimer.
11: .\" 2. Redistributions in binary form must reproduce the above copyright
12: .\" notice, this list of conditions and the following disclaimer in the
13: .\" documentation and/or other materials provided with the distribution.
14: .\" 3. All advertising materials mentioning features or use of this software
15: .\" must display the following acknowledgement:
16: .\" This product includes software developed by the University of
17: .\" California, Berkeley and its contributors.
18: .\" 4. Neither the name of the University nor the names of its contributors
19: .\" may be used to endorse or promote products derived from this software
20: .\" without specific prior written permission.
21: .\"
22: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32: .\" SUCH DAMAGE.
33: .\"
34: .\" @(#)expand.1 8.1 (Berkeley) 6/9/93
35: .\"
36: .Dd June 9, 1993
37: .Dt EXPAND 1
38: .Os BSD 4
39: .Sh NAME
40: .Nm expand ,
41: .Nm unexpand
42: .Nd expand tabs to spaces, and vice versa
43: .Sh SYNOPSIS
44: .Nm expand
45: .Op Fl Ns Ar tabstop
46: .Op Fl Ns Ar tab1,tab2,...,tabn
47: .Ar
48: .Nm unexpand
49: .Op Fl a
50: .Ar
51: .Sh DESCRIPTION
52: .Nm Expand
53: processes the named files or the standard input writing
54: the standard output with tabs changed into blanks.
55: Backspace characters are preserved into the output and decrement
56: the column count for tab calculations.
57: .Nm Expand
58: is useful for pre-processing character files
59: (before sorting, looking at specific columns, etc.) that
60: contain tabs.
61: .Pp
62: If a single
63: .Ar tabstop
64: argument is given, then tabs are set
65: .Ar tabstop
66: spaces apart instead of the default 8.
67: If multiple tabstops are given then the tabs are set at those
68: specific columns.
69: .Pp
70: .Nm Unexpand
71: puts tabs back into the data from the standard input or the named
72: files and writes the result on the standard output.
73: .Pp
74: Option (with
75: .Nm unexpand
76: only):
77: .Bl -tag -width flag
78: .It Fl a
79: By default, only leading blanks and tabs
80: are reconverted to maximal strings of tabs. 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: .El
85: .Sh HISTORY
86: The
87: .Nm expand
88: command appeared in
89: .Bx 3.0 .