Return to fold.1 CVS log

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

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

1.16    ! schwarze    1: .\"    $OpenBSD: fold.1,v 1.15 2010/09/03 11:09:28 jmc 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.
1.8       millert    15: .\" 3. Neither the name of the University nor the names of its contributors
1.1       deraadt    16: .\"    may be used to endorse or promote products derived from this software
                     17: .\"    without specific prior written permission.
                     18: .\"
                     19: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     20: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     21: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     22: .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     23: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     24: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     25: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     26: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     27: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     28: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     29: .\" SUCH DAMAGE.
                     30: .\"
                     31: .\"    @(#)fold.1      8.1 (Berkeley) 6/6/93
                     32: .\"
1.16    ! schwarze   33: .Dd $Mdocdate: September 3 2010 $
1.1       deraadt    34: .Dt FOLD 1
                     35: .Os
                     36: .Sh NAME
                     37: .Nm fold
1.3       aaron      38: .Nd fold long lines for finite width output device
1.1       deraadt    39: .Sh SYNOPSIS
                     40: .Nm fold
                     41: .Op Fl bs
                     42: .Op Fl w Ar width
1.14      sobrado    43: .Op Ar
1.1       deraadt    44: .Sh DESCRIPTION
1.4       aaron      45: .Nm
1.1       deraadt    46: is a filter which folds the contents of the specified files,
                     47: or the standard input if no files are specified,
1.3       aaron      48: breaking the lines to have a maximum of 80 characters.
1.1       deraadt    49: .Pp
                     50: The options are as follows:
1.6       aaron      51: .Bl -tag -width Ds
1.1       deraadt    52: .It Fl b
                     53: Count
                     54: .Ar width
                     55: in bytes rather than column positions.
                     56: .It Fl s
                     57: Fold line after the last blank character within the first
                     58: .Ar width
1.4       aaron      59: column positions (or bytes).
1.5       deraadt    60: .It Fl w Ar width
1.1       deraadt    61: Specifies a line width to use instead of the default 80 characters.
                     62: .El
1.15      jmc        63: .Sh EXIT STATUS
1.10      jmc        64: .Ex -std fold
1.1       deraadt    65: .Sh SEE ALSO
                     66: .Xr expand 1
                     67: .Sh STANDARDS
1.4       aaron      68: The
                     69: .Nm
1.11      jmc        70: utility is compliant with the
1.13      jmc        71: .St -p1003.1-2008
1.11      jmc        72: specification.
1.16    ! schwarze   73: .Sh HISTORY
        !            74: The
        !            75: .Nm
        !            76: utility first appeared in
        !            77: .Bx 1 .
        !            78: It was rewritten for
        !            79: .Bx 4.3 Reno
        !            80: to improve speed and modernize style.
        !            81: The
        !            82: .Fl b
        !            83: and
        !            84: .Fl s
        !            85: options were added to
        !            86: .Nx 1.0
        !            87: for
        !            88: .St -p1003.2
        !            89: compliance.
        !            90: .Sh AUTHORS
        !            91: .An -nosplit
        !            92: .An Bill Joy
        !            93: wrote the original version of
        !            94: .Nm
        !            95: on June 28, 1977.
        !            96: .An Kevin Ruddy
        !            97: rewrote the command in 1990, and
        !            98: .An J. T. Conklin
        !            99: added the missing options in 1993.
1.1       deraadt   100: .Sh BUGS
1.9       jmc       101: If underlining (see
                    102: .Xr ul 1 )
                    103: is present it may be messed up by folding.
1.1       deraadt   104: .Pp
1.3       aaron     105: .Ar width
1.1       deraadt   106: should be a multiple of 8 if tabs are present, or the tabs should
                    107: be expanded using
                    108: .Xr expand 1
                    109: before using
                    110: .Nm fold .