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