xref: /freebsd/usr.bin/fold/fold.1 (revision f9dd3a8b6fa74d58850bad970b10c8486e9f6cd3)
19b50d902SRodney W. Grimes.\" Copyright (c) 1980, 1993
29b50d902SRodney W. Grimes.\"	The Regents of the University of California.  All rights reserved.
39b50d902SRodney W. Grimes.\"
49b50d902SRodney W. Grimes.\" Redistribution and use in source and binary forms, with or without
59b50d902SRodney W. Grimes.\" modification, are permitted provided that the following conditions
69b50d902SRodney W. Grimes.\" are met:
79b50d902SRodney W. Grimes.\" 1. Redistributions of source code must retain the above copyright
89b50d902SRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer.
99b50d902SRodney W. Grimes.\" 2. Redistributions in binary form must reproduce the above copyright
109b50d902SRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer in the
119b50d902SRodney W. Grimes.\"    documentation and/or other materials provided with the distribution.
129b50d902SRodney W. Grimes.\" 3. All advertising materials mentioning features or use of this software
139b50d902SRodney W. Grimes.\"    must display the following acknowledgement:
149b50d902SRodney W. Grimes.\"	This product includes software developed by the University of
159b50d902SRodney W. Grimes.\"	California, Berkeley and its contributors.
169b50d902SRodney W. Grimes.\" 4. Neither the name of the University nor the names of its contributors
179b50d902SRodney W. Grimes.\"    may be used to endorse or promote products derived from this software
189b50d902SRodney W. Grimes.\"    without specific prior written permission.
199b50d902SRodney W. Grimes.\"
209b50d902SRodney W. Grimes.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
219b50d902SRodney W. Grimes.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
229b50d902SRodney W. Grimes.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
239b50d902SRodney W. Grimes.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
249b50d902SRodney W. Grimes.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
259b50d902SRodney W. Grimes.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
269b50d902SRodney W. Grimes.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
279b50d902SRodney W. Grimes.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
289b50d902SRodney W. Grimes.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
299b50d902SRodney W. Grimes.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
309b50d902SRodney W. Grimes.\" SUCH DAMAGE.
319b50d902SRodney W. Grimes.\"
329b50d902SRodney W. Grimes.\"	@(#)fold.1	8.1 (Berkeley) 6/6/93
33c3aac50fSPeter Wemm.\" $FreeBSD$
349b50d902SRodney W. Grimes.\"
35f9dd3a8bSTim J. Robbins.Dd August 2, 2004
369b50d902SRodney W. Grimes.Dt FOLD 1
379b50d902SRodney W. Grimes.Os
389b50d902SRodney W. Grimes.Sh NAME
399b50d902SRodney W. Grimes.Nm fold
409b50d902SRodney W. Grimes.Nd "fold long lines for finite width output device"
419b50d902SRodney W. Grimes.Sh SYNOPSIS
428fe908efSRuslan Ermilov.Nm
4313e06695STim J. Robbins.Op Fl bs
449b50d902SRodney W. Grimes.Op Fl w Ar width
451fec918bSDima Dorfman.Op Ar
469b50d902SRodney W. Grimes.Sh DESCRIPTION
473898680cSPhilippe CharnierThe
483898680cSPhilippe Charnier.Nm
493898680cSPhilippe Charnierutility is a filter which folds the contents of the specified files,
509b50d902SRodney W. Grimesor the standard input if no files are specified,
51b887806dSTim J. Robbinsbreaking the lines to have a maximum of 80 columns.
529b50d902SRodney W. Grimes.Pp
53816dde7dSTim J. RobbinsThe options are as follows:
549b50d902SRodney W. Grimes.Bl -tag -width indent
5513e06695STim J. Robbins.It Fl b
5613e06695STim J. RobbinsCount
5713e06695STim J. Robbins.Ar width
5813e06695STim J. Robbinsin bytes rather than column positions.
5913e06695STim J. Robbins.It Fl s
6013e06695STim J. RobbinsFold line after the last blank character within the first
6113e06695STim J. Robbins.Ar width
6213e06695STim J. Robbinscolumn positions (or bytes).
63a9c9a0d1SPhilippe Charnier.It Fl w Ar width
64b887806dSTim J. RobbinsSpecify a line width to use instead of the default 80 columns.
659b50d902SRodney W. Grimes.Ar Width
669b50d902SRodney W. Grimesshould be a multiple of 8 if tabs are present, or the tabs should
679b50d902SRodney W. Grimesbe expanded using
689b50d902SRodney W. Grimes.Xr expand 1
699b50d902SRodney W. Grimesbefore using
708fe908efSRuslan Ermilov.Nm .
719b50d902SRodney W. Grimes.El
72f9dd3a8bSTim J. Robbins.Sh ENVIRONMENT
73f9dd3a8bSTim J. RobbinsThe
74f9dd3a8bSTim J. Robbins.Ev LANG , LC_ALL
75f9dd3a8bSTim J. Robbinsand
76f9dd3a8bSTim J. Robbins.Ev LC_CTYPE
77f9dd3a8bSTim J. Robbinsenvironment variables affect the execution of
78f9dd3a8bSTim J. Robbins.Nm
79f9dd3a8bSTim J. Robbinsas described in
80f9dd3a8bSTim J. Robbins.Xr environ 7 .
819b50d902SRodney W. Grimes.Sh SEE ALSO
82f9dd3a8bSTim J. Robbins.Xr expand 1 ,
83f9dd3a8bSTim J. Robbins.Xr fmt 1
8413e06695STim J. Robbins.Sh STANDARDS
8513e06695STim J. RobbinsThe
8613e06695STim J. Robbins.Nm
8713e06695STim J. Robbinsutility conforms to
8813e06695STim J. Robbins.St -p1003.1-2001 .
899b50d902SRodney W. Grimes.Sh BUGS
909b50d902SRodney W. GrimesIf underlining is present it may be messed up by folding.
91