freebsd-dev/usr.bin/expand/expand.1

.\" 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.
.\" 4. 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
.\" $FreeBSD$
.\"
.Dd October 13, 2006
.Dt EXPAND 1
.Os
.Sh NAME
.Nm expand ,
.Nm unexpand
.Nd expand tabs to spaces, and vice versa
.Sh SYNOPSIS
.Nm
.Oo
.Fl t
.Sm off
.Ar tab1 , tab2 , ... , tabn
.Sm on
.Oc
.Op Ar
.Nm unexpand
.Oo
.Fl a | t
.Sm off
.Ar tab1 , tab2 , ... , tabn
.Sm on
.Oc
.Op Ar
.Sh DESCRIPTION
The
.Nm
utility 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.
The
.Nm
utility is useful for pre-processing character files
(before sorting, looking at specific columns, etc.) that
contain tabs.
.Pp
The
.Nm unexpand
utility puts tabs back into the data from the standard input or the named
files and writes the result on the standard output.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl a
.Nm ( unexpand
only.)
By default, only leading blanks and tabs
are reconverted to maximal strings of tabs.
If the
.Fl a
option is given, then tabs are inserted whenever they would compress the
resultant file by replacing two or more characters.
.It Fl t Sm Ar tab1 , tab2 , ... , tabn Sm
Set tab stops at column positions
.Ar tab1 , tab2 , ... , tabn .
If only a single number is given, tab stops are set that number of
column positions apart instead of the default number of 8.
.El
.Sh ENVIRONMENT
The
.Ev LANG , LC_ALL
and
.Ev LC_CTYPE
environment variables affect the execution of
.Nm
and
.Nm unexpand
as described in
.Xr environ 7 .
.Sh EXIT STATUS
.Ex -std expand unexpand
.Sh STANDARDS
The
.Nm
and
.Nm unexpand
utilities conform to
.St -p1003.1-2001 .
.Sh HISTORY
The
.Nm
command appeared in
.Bx 3.0 .
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" 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.`
			`.\" 4. 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`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\"`
Document that unexpand(1)'s -a and -t options are exclusive. PR: docs/85063 2006-10-13 16:22:25 +00:00			`.Dd October 13, 2006`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Dt EXPAND 1`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 14:16:33 +00:00			`.Os`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh NAME`
			`.Nm expand ,`
			`.Nm unexpand`
			`.Nd expand tabs to spaces, and vice versa`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +00:00			`.Oo`
			`.Fl t`
			`.Sm off`
			`.Ar tab1 , tab2 , ... , tabn`
			`.Sm on`
			`.Oc`
Use errx(), remove unused #include. Correct SYNOPSIS 2000-03-26 14:28:31 +00:00			`.Op Ar`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Nm unexpand`
Add the -t option, which allows tab stop positions to be specified similarly to the way expand(1) allows. This brings unexpand(1) up to SUSv3 conformance, and it now passes all relevant parts of the GNU textutils test suite. PR: 35621 Reviewed by: mike 2002-04-23 07:15:09 +00:00			`.Oo`
Document that unexpand(1)'s -a and -t options are exclusive. PR: docs/85063 2006-10-13 16:22:25 +00:00			`.Fl a \| t`
Add the -t option, which allows tab stop positions to be specified similarly to the way expand(1) allows. This brings unexpand(1) up to SUSv3 conformance, and it now passes all relevant parts of the GNU textutils test suite. PR: 35621 Reviewed by: mike 2002-04-23 07:15:09 +00:00			`.Sm off`
			`.Ar tab1 , tab2 , ... , tabn`
			`.Sm on`
			`.Oc`
Use errx(), remove unused #include. Correct SYNOPSIS 2000-03-26 14:28:31 +00:00			`.Op Ar`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh DESCRIPTION`
Use `The .Nm utility' 2002-04-19 23:44:58 +00:00			`The`
			`.Nm`
			`utility processes the named files or the standard input writing`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`the standard output with tabs changed into blanks.`
			`Backspace characters are preserved into the output and decrement`
			`the column count for tab calculations.`
Use `The .Nm utility' 2002-04-19 23:44:58 +00:00			`The`
			`.Nm`
			`utility is useful for pre-processing character files`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`(before sorting, looking at specific columns, etc.) that`
			`contain tabs.`
			`.Pp`
Use `The .Nm utility' 2002-04-19 23:44:58 +00:00			`The`
			`.Nm unexpand`
			`utility puts tabs back into the data from the standard input or the named`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`files and writes the result on the standard output.`
			`.Pp`
Remove obsolescent -tabstop option from Synopsis (it was already removed from the usage() message). Document what the -t option does in a more standard place. Add a standard Diagnostics section. 2002-06-15 10:52:20 +00:00			`The following options are available:`
Use errx(), remove unused #include. Correct SYNOPSIS 2000-03-26 14:28:31 +00:00			`.Bl -tag -width indent`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl a`
mdoc(7) police: markup polishing. Approved by: re 2002-11-26 10:57:57 +00:00			`.Nm ( unexpand`
			`only.)`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`By default, only leading blanks and tabs`
Mechanically kill hard sentence breaks. 2004-07-02 22:22:35 +00:00			`are reconverted to maximal strings of tabs.`
			`If the`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Fl a`
			`option is given, then tabs are inserted whenever they would compress the`
			`resultant file by replacing two or more characters.`
mdoc(7) police: markup polishing. Approved by: re 2002-11-26 10:57:57 +00:00			`.It Fl t Sm Ar tab1 , tab2 , ... , tabn Sm`
Remove obsolescent -tabstop option from Synopsis (it was already removed from the usage() message). Document what the -t option does in a more standard place. Add a standard Diagnostics section. 2002-06-15 10:52:20 +00:00			`Set tab stops at column positions`
mdoc(7) police: markup polishing. Approved by: re 2002-11-26 10:57:57 +00:00			`.Ar tab1 , tab2 , ... , tabn .`
Remove obsolescent -tabstop option from Synopsis (it was already removed from the usage() message). Document what the -t option does in a more standard place. Add a standard Diagnostics section. 2002-06-15 10:52:20 +00:00			`If only a single number is given, tab stops are set that number of`
			`column positions apart instead of the default number of 8.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.El`
Allow <blank>s to be used to separate tab stop positions with the -t argument, not just ASCII space characters and commas. Don't count non-printing characters when determining column position. 2002-06-15 10:16:39 +00:00			`.Sh ENVIRONMENT`
			`The`
mdoc(7) police: markup polishing. Approved by: re 2002-11-26 10:57:57 +00:00			`.Ev LANG , LC_ALL`
Allow <blank>s to be used to separate tab stop positions with the -t argument, not just ASCII space characters and commas. Don't count non-printing characters when determining column position. 2002-06-15 10:16:39 +00:00			`and`
			`.Ev LC_CTYPE`
			`environment variables affect the execution of`
mdoc(7) police: markup polishing. Approved by: re 2002-11-26 10:57:57 +00:00			`.Nm`
Allow <blank>s to be used to separate tab stop positions with the -t argument, not just ASCII space characters and commas. Don't count non-printing characters when determining column position. 2002-06-15 10:16:39 +00:00			`and`
			`.Nm unexpand`
			`as described in`
			`.Xr environ 7 .`
Added the EXIT STATUS section where appropriate. 2005-01-17 07:44:44 +00:00			`.Sh EXIT STATUS`
Remove obsolescent -tabstop option from Synopsis (it was already removed from the usage() message). Document what the -t option does in a more standard place. Add a standard Diagnostics section. 2002-06-15 10:52:20 +00:00			`.Ex -std expand unexpand`
Add the -t option, which allows tab stop positions to be specified similarly to the way expand(1) allows. This brings unexpand(1) up to SUSv3 conformance, and it now passes all relevant parts of the GNU textutils test suite. PR: 35621 Reviewed by: mike 2002-04-23 07:15:09 +00:00			`.Sh STANDARDS`
			`The`
mdoc(7) police: markup polishing. Approved by: re 2002-11-26 10:57:57 +00:00			`.Nm`
Add the -t option, which allows tab stop positions to be specified similarly to the way expand(1) allows. This brings unexpand(1) up to SUSv3 conformance, and it now passes all relevant parts of the GNU textutils test suite. PR: 35621 Reviewed by: mike 2002-04-23 07:15:09 +00:00			`and`
			`.Nm unexpand`
			`utilities conform to`
			`.St -p1003.1-2001 .`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh HISTORY`
			`The`
Use errx(), remove unused #include. Correct SYNOPSIS 2000-03-26 14:28:31 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`command appeared in`
			`.Bx 3.0 .`