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