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