NetBSD/usr.bin/fold/fold.1

.\"	$NetBSD: fold.1,v 1.17 2012/05/12 15:17:15 wiz Exp $
.\"
.\" Copyright (c) 1980, 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.
.\"
.\"	@(#)fold.1	8.1 (Berkeley) 6/6/93
.\"
.Dd May 12, 2012
.Dt FOLD 1
.Os
.Sh NAME
.Nm fold
.Nd "fold long lines for finite width output device"
.Sh SYNOPSIS
.Nm
.Op Fl bs
.Op Fl w Ar width
.Op Ar
.Sh DESCRIPTION
.Nm
is a filter which folds the contents of the specified files,
or the standard input if no files are specified,
breaking the lines to have a maximum of 80 characters.
.Pp
The options are as follows:
.Bl -tag -width XwXwidthXX
.It Fl b
Count
.Ar width
in bytes rather than column positions.
.It Fl s
Fold line after the last blank character within the first
.Ar width
column positions (or bytes).
If a blank character does not exist within the width, then
a longer line will still be split at the width.
.It Fl w Ar width
Specifies
.Ar width
to use as a line width, instead of the default 80 characters.
.El
.Sh ENVIRONMENT
.Bl -tag -width indent
.It Ev LC_CTYPE
.El
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr expand 1 ,
.Xr fmt 1
.Sh STANDARDS
The
.Nm
utility conforms to
.St -p1003.1-2008 .
.Sh HISTORY
The
.Nm
utility appeared in
.Bx 1 .
.Sh BUGS
If underlining is present it may be messed up by folding.
.Pp
.Ar Width
should be a multiple of 8 if tabs are present, or the tabs should
be expanded using
.Xr expand 1
before using
.Nm .
Remove trailing whitespace. 2012-05-12 19:17:15 +04:00			`.\" $NetBSD: fold.1,v 1.17 2012/05/12 15:17:15 wiz Exp $`
Sync with 4.4lite2 1995-09-01 05:42:41 +04:00			`.\"`
			`.\" Copyright (c) 1980, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
			`.\" 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.`
Move UCB-licensed code from 4-clause to 3-clause licence. Patches provided by Joel Baker in PR 22365, verified by myself. 2003-08-07 15:13:06 +04:00			`.\" 3. Neither the name of the University nor the names of its contributors`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\" 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.`
			`.\"`
Sync with 4.4lite2 1995-09-01 05:42:41 +04:00			`.\" @(#)fold.1 8.1 (Berkeley) 6/6/93`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
Clarify description of -s switch. 2012-05-12 18:42:12 +04:00			`.Dd May 12, 2012`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Dt FOLD 1`
			`.Os`
			`.Sh NAME`
			`.Nm fold`
			`.Nd "fold long lines for finite width output device"`
			`.Sh SYNOPSIS`
WARNSify, fix .Nm usage 1997-10-18 19:02:15 +04:00			`.Nm`
Document the fact that fold is POSIX.2 compliant. Update usage string. 1993-08-28 08:30:00 +04:00			`.Op Fl bs`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Op Fl w Ar width`
Mark file argument(s) as being optional (as does the usage message from fold.c, which is correct); minor spelling correction; note `width' as being an argument to `-w'; reference fmt(1) in `SEE ALSO' section. From Snader_LB. 2011-09-15 13:39:57 +04:00			`.Op Ar`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh DESCRIPTION`
WARNSify, fix .Nm usage 1997-10-18 19:02:15 +04:00			`.Nm`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`is a filter which folds the contents of the specified files,`
			`or the standard input if no files are specified,`
Mark file argument(s) as being optional (as does the usage message from fold.c, which is correct); minor spelling correction; note `width' as being an argument to `-w'; reference fmt(1) in `SEE ALSO' section. From Snader_LB. 2011-09-15 13:39:57 +04:00			`breaking the lines to have a maximum of 80 characters.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Pp`
			`The options are as follows:`
Add argument in options table. Resize to fit. 2011-09-15 13:40:57 +04:00			`.Bl -tag -width XwXwidthXX`
Make POSIX 1003.2 (D11.2) compliant by adding -s (split at blank) and -b (count bytes, not column positions) flags. 1993-07-20 03:22:09 +04:00			`.It Fl b`
			`Count`
			`.Ar width`
			`in bytes rather than column positions.`
			`.It Fl s`
			`Fold line after the last blank character within the first`
			`.Ar width`
Whitespace cleanup. 2001-12-01 19:43:07 +03:00			`column positions (or bytes).`
Clarify description of -s switch. 2012-05-12 18:42:12 +04:00			`If a blank character does not exist within the width, then`
			`a longer line will still be split at the width.`
Add argument in options table. Resize to fit. 2011-09-15 13:40:57 +04:00			`.It Fl w Ar width`
Mark file argument(s) as being optional (as does the usage message from fold.c, which is correct); minor spelling correction; note `width' as being an argument to `-w'; reference fmt(1) in `SEE ALSO' section. From Snader_LB. 2011-09-15 13:39:57 +04:00			`Specifies`
			`.Ar width`
			`to use as a line width, instead of the default 80 characters.`
Make POSIX 1003.2 (D11.2) compliant by adding -s (split at blank) and -b (count bytes, not column positions) flags. 1993-07-20 03:22:09 +04:00			`.El`
Modify to support multibyte characters. 2009-07-21 05:35:02 +04:00			`.Sh ENVIRONMENT`
			`.Bl -tag -width indent`
			`.It Ev LC_CTYPE`
			`.El`
Fix section order. Use .Ex -std 2010-05-14 20:54:48 +04:00			`.Sh EXIT STATUS`
			`.Ex -std`
Make POSIX 1003.2 (D11.2) compliant by adding -s (split at blank) and -b (count bytes, not column positions) flags. 1993-07-20 03:22:09 +04:00			`.Sh SEE ALSO`
Mark file argument(s) as being optional (as does the usage message from fold.c, which is correct); minor spelling correction; note `width' as being an argument to `-w'; reference fmt(1) in `SEE ALSO' section. From Snader_LB. 2011-09-15 13:39:57 +04:00			`.Xr expand 1 ,`
			`.Xr fmt 1`
Document the fact that fold is POSIX.2 compliant. Update usage string. 1993-08-28 08:30:00 +04:00			`.Sh STANDARDS`
Whitespace cleanup. 2001-12-01 19:43:07 +03:00			`The`
WARNSify, fix .Nm usage 1997-10-18 19:02:15 +04:00			`.Nm`
Whitespace cleanup. 2001-12-01 19:43:07 +03:00			`utility conforms to`
Modify to support multibyte characters. 2009-07-21 05:35:02 +04:00			`.St -p1003.1-2008 .`
Change or add history. I checked the 1bsd archives and this first appeared in 1BSD (before it was known as 1BSD). I looked at code and later sccs history to confirm. In the case of rewritten code, we are not consistent in manpages indicating that history. 2012-05-12 18:52:57 +04:00			`.Sh HISTORY`
Remove trailing whitespace. 2012-05-12 19:17:15 +04:00			`The`
			`.Nm`
Change or add history. I checked the 1bsd archives and this first appeared in 1BSD (before it was known as 1BSD). I looked at code and later sccs history to confirm. In the case of rewritten code, we are not consistent in manpages indicating that history. 2012-05-12 18:52:57 +04:00			`utility appeared in`
			`.Bx 1 .`
Make POSIX 1003.2 (D11.2) compliant by adding -s (split at blank) and -b (count bytes, not column positions) flags. 1993-07-20 03:22:09 +04:00			`.Sh BUGS`
			`If underlining is present it may be messed up by folding.`
			`.Pp`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Ar Width`
			`should be a multiple of 8 if tabs are present, or the tabs should`
			`be expanded using`
			`.Xr expand 1`
			`before using`
.Nm does not need a dummy argument ("") before punctuation or for correct formatting of the SYNOPSIS any longer. 2003-02-25 13:34:36 +03:00			`.Nm .`