xref: /netbsd-src/usr.bin/fold/fold.1 (revision 53d1339bf7f9c7367b35a9e1ebe693f9b047a47b)
1.\"	$NetBSD: fold.1,v 1.17 2012/05/12 15:17:15 wiz Exp $
2.\"
3.\" Copyright (c) 1980, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\"	@(#)fold.1	8.1 (Berkeley) 6/6/93
31.\"
32.Dd May 12, 2012
33.Dt FOLD 1
34.Os
35.Sh NAME
36.Nm fold
37.Nd "fold long lines for finite width output device"
38.Sh SYNOPSIS
39.Nm
40.Op Fl bs
41.Op Fl w Ar width
42.Op Ar
43.Sh DESCRIPTION
44.Nm
45is a filter which folds the contents of the specified files,
46or the standard input if no files are specified,
47breaking the lines to have a maximum of 80 characters.
48.Pp
49The options are as follows:
50.Bl -tag -width XwXwidthXX
51.It Fl b
52Count
53.Ar width
54in bytes rather than column positions.
55.It Fl s
56Fold line after the last blank character within the first
57.Ar width
58column positions (or bytes).
59If a blank character does not exist within the width, then
60a longer line will still be split at the width.
61.It Fl w Ar width
62Specifies
63.Ar width
64to use as a line width, instead of the default 80 characters.
65.El
66.Sh ENVIRONMENT
67.Bl -tag -width indent
68.It Ev LC_CTYPE
69.El
70.Sh EXIT STATUS
71.Ex -std
72.Sh SEE ALSO
73.Xr expand 1 ,
74.Xr fmt 1
75.Sh STANDARDS
76The
77.Nm
78utility conforms to
79.St -p1003.1-2008 .
80.Sh HISTORY
81The
82.Nm
83utility appeared in
84.Bx 1 .
85.Sh BUGS
86If underlining is present it may be messed up by folding.
87.Pp
88.Ar Width
89should be a multiple of 8 if tabs are present, or the tabs should
90be expanded using
91.Xr expand 1
92before using
93.Nm .
94