xref: /netbsd-src/usr.bin/fold/fold.1 (revision 4b30c543a0b21e3ba94f2c569e9a82b4fdb2075f)
1.\" Copyright (c) 1980 The Regents of the University of California.
2.\" 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.\"	from: @(#)fold.1	6.5 (Berkeley) 5/6/91
33.\"	$Id: fold.1,v 1.4 1993/08/28 04:30:00 jtc Exp $
34.\"
35.Dd May 6, 1991
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 fold
43.Op Fl bs
44.Op Fl w Ar width
45.Ar
46.Sh DESCRIPTION
47.Nm Fold
48is a filter which folds the contents of the specified files,
49or the standard input if no files are specified,
50breaking the lines to have maximum of 80 characters.
51.Pp
52The options are as follows:
53.Bl -tag -width indent
54.It Fl b
55Count
56.Ar width
57in bytes rather than column positions.
58.It Fl s
59Fold line after the last blank character within the first
60.Ar width
61column positions (or bytes).
62.It Fl w
63Specifies a line width to use instead of the default 80 characters.
64.El
65.Pp
66The
67.Nm fold
68utility exits 0 on success, and >0 if an error occurs.
69.Sh SEE ALSO
70.Xr expand 1
71.Sh STANDARDS
72The
73.Nm fold
74utility conforms to
75.St -p1003.2-92 .
76.Sh BUGS
77If underlining is present it may be messed up by folding.
78.Pp
79.Ar Width
80should be a multiple of 8 if tabs are present, or the tabs should
81be expanded using
82.Xr expand 1
83before using
84.Nm fold .
85