freebsd-skq/usr.bin/fold/fold.1

.\" 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
.\" $FreeBSD$
.\"
.Dd June 6, 2015
.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
The
.Nm
utility 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 columns.
.Pp
The options are as follows:
.Bl -tag -width indent
.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).
.It Fl w Ar width
Specify a line width to use instead of the default 80 columns.
The
.Ar width
value
should be a multiple of 8 if tabs are present, or the tabs should
be expanded using
.Xr expand 1
before using
.Nm .
.El
.Sh ENVIRONMENT
The
.Ev LANG , LC_ALL
and
.Ev LC_CTYPE
environment variables affect the execution of
.Nm
as described in
.Xr environ 7 .
.Sh SEE ALSO
.Xr expand 1 ,
.Xr fmt 1
.Sh STANDARDS
The
.Nm
utility conforms to
.St -p1003.1-2001 .
.Sh HISTORY
The
.Nm
utility first appeared in
.Bx 1 .
It was rewritten for
.Bx 4.3 Reno
to improve speed and modernize style.
The
.Fl b
and
.Fl s
options were added to
.Nx 1.0
for
.St -p1003.2
compliance.
.Sh AUTHORS
.An -nosplit
.An Bill Joy
wrote the original version of
.Nm
on June 28, 1977.
.An Kevin Ruddy
rewrote the command in 1990, and
.An J. T. Conklin
added the missing options in 1993.
.Sh BUGS
If underlining (see
.Xr ul 1 )
is present it may be messed up by folding.
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" 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.`
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96 2017-02-28 23:42:47 +00:00			`.\" 3. Neither the name of the University nor the names of its contributors`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00: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.`
			`.\"`
			`.\" @(#)fold.1 8.1 (Berkeley) 6/6/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			`.\"`
Complete documenting the HISTORY Obtained from: OpenBSD (by schwarze@) 2015-06-06 12:01:35 +00:00			`.Dd June 6, 2015`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Dt FOLD 1`
			`.Os`
			`.Sh NAME`
			`.Nm fold`
			`.Nd "fold long lines for finite width output device"`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
Add the -b option (break at byte position, not column number) and the -s option (try to break at word bounaries) for SUSv3 conformance. Partially based on the NetBSD version, with the following changes: - style(9) - break on <blank>s, not spaces, per POSIX (and GNU) - when looking for last space on line, search backwards instead of forwards; less comparisons needed this way. - use LINE_MAX macro instead of a magic number and a comment saying it is LINE_MAX. PR: 36245 Reviewed by: mike Obtained from: NetBSD (partially) 2002-04-18 03:33:51 +00:00			`.Op Fl bs`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Op Fl w Ar width`
The `file' argument is optional. Obtained from: OpenBSD 2001-06-26 02:14:13 +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 is a filter which folds the contents of the specified files,`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`or the standard input if no files are specified,`
Only advance the column position for printable characters, update manual page to emphasise that we count column positions, not characters. 2002-06-17 12:11:05 +00:00			`breaking the lines to have a maximum of 80 columns.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Pp`
Typo: use plural now that we have more than one option. 2002-05-25 03:08:21 +00:00			`The options are as follows:`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Bl -tag -width indent`
Add the -b option (break at byte position, not column number) and the -s option (try to break at word bounaries) for SUSv3 conformance. Partially based on the NetBSD version, with the following changes: - style(9) - break on <blank>s, not spaces, per POSIX (and GNU) - when looking for last space on line, search backwards instead of forwards; less comparisons needed this way. - use LINE_MAX macro instead of a magic number and a comment saying it is LINE_MAX. PR: 36245 Reviewed by: mike Obtained from: NetBSD (partially) 2002-04-18 03:33:51 +00: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`
			`column positions (or bytes).`
Make clear that -w gets an argument. Add __FBSDID and remove unused #include 2001-12-12 18:25:53 +00:00			`.It Fl w Ar width`
Only advance the column position for printable characters, update manual page to emphasise that we count column positions, not characters. 2002-06-17 12:11:05 +00:00			`Specify a line width to use instead of the default 80 columns.`
Mention what underlining is meant here. 2006-12-15 11:23:59 +00:00			`The`
			`.Ar width`
			`value`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`should be a multiple of 8 if tabs are present, or the tabs should`
			`be expanded using`
			`.Xr expand 1`
			`before using`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm .`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.El`
Add cross-reference to fmt(1) and a fairly standard ENVIRONMENT section. 2004-08-02 11:15:01 +00:00			`.Sh ENVIRONMENT`
			`The`
			`.Ev LANG , LC_ALL`
			`and`
			`.Ev LC_CTYPE`
			`environment variables affect the execution of`
			`.Nm`
			`as described in`
			`.Xr environ 7 .`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh SEE ALSO`
Add cross-reference to fmt(1) and a fairly standard ENVIRONMENT section. 2004-08-02 11:15:01 +00:00			`.Xr expand 1 ,`
			`.Xr fmt 1`
Add the -b option (break at byte position, not column number) and the -s option (try to break at word bounaries) for SUSv3 conformance. Partially based on the NetBSD version, with the following changes: - style(9) - break on <blank>s, not spaces, per POSIX (and GNU) - when looking for last space on line, search backwards instead of forwards; less comparisons needed this way. - use LINE_MAX macro instead of a magic number and a comment saying it is LINE_MAX. PR: 36245 Reviewed by: mike Obtained from: NetBSD (partially) 2002-04-18 03:33:51 +00:00			`.Sh STANDARDS`
			`The`
			`.Nm`
			`utility conforms to`
			`.St -p1003.1-2001 .`
Complete documenting the HISTORY Obtained from: OpenBSD (by schwarze@) 2015-06-06 12:01:35 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`utility first appeared in`
			`.Bx 1 .`
			`It was rewritten for`
			`.Bx 4.3 Reno`
			`to improve speed and modernize style.`
			`The`
			`.Fl b`
			`and`
			`.Fl s`
			`options were added to`
			`.Nx 1.0`
			`for`
			`.St -p1003.2`
			`compliance.`
			`.Sh AUTHORS`
			`.An -nosplit`
			`.An Bill Joy`
			`wrote the original version of`
			`.Nm`
			`on June 28, 1977.`
			`.An Kevin Ruddy`
			`rewrote the command in 1990, and`
			`.An J. T. Conklin`
			`added the missing options in 1993.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh BUGS`
Mention what underlining is meant here. 2006-12-15 11:23:59 +00:00			`If underlining (see`
			`.Xr ul 1 )`
			`is present it may be messed up by folding.`