xref: /openbsd/usr.bin/fold/fold.1 (revision 17df1aa7)
1.\"	$OpenBSD: fold.1,v 1.14 2009/08/16 09:41:08 sobrado Exp $
2.\"	$NetBSD: fold.1,v 1.5 1995/09/01 01:42:42 jtc Exp $
3.\"
4.\" Copyright (c) 1980, 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. Neither the name of the University nor the names of its contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.\"	@(#)fold.1	8.1 (Berkeley) 6/6/93
32.\"
33.Dd $Mdocdate: August 16 2009 $
34.Dt FOLD 1
35.Os
36.Sh NAME
37.Nm fold
38.Nd fold long lines for finite width output device
39.Sh SYNOPSIS
40.Nm fold
41.Op Fl bs
42.Op Fl w Ar width
43.Op Ar
44.Sh DESCRIPTION
45.Nm
46is a filter which folds the contents of the specified files,
47or the standard input if no files are specified,
48breaking the lines to have a maximum of 80 characters.
49.Pp
50The options are as follows:
51.Bl -tag -width Ds
52.It Fl b
53Count
54.Ar width
55in bytes rather than column positions.
56.It Fl s
57Fold line after the last blank character within the first
58.Ar width
59column positions (or bytes).
60.It Fl w Ar width
61Specifies a line width to use instead of the default 80 characters.
62.El
63.Pp
64.Ex -std fold
65.Sh SEE ALSO
66.Xr expand 1
67.Sh STANDARDS
68The
69.Nm
70utility is compliant with the
71.St -p1003.1-2008
72specification.
73.Sh BUGS
74If underlining (see
75.Xr ul 1 )
76is present it may be messed up by folding.
77.Pp
78.Ar width
79should be a multiple of 8 if tabs are present, or the tabs should
80be expanded using
81.Xr expand 1
82before using
83.Nm fold .
84