Return to fold.1 CVS log

Up to [local] / src / usr.bin / fold

Annotation of src/usr.bin/fold/fold.1, Revision 1.6

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