usr.bin/fold/fold.1

   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: src/usr.bin/fold/fold.1,v 1.3.2.6 2002/07/11 01:01:44 tjr Exp $
  34 .\" $DragonFly: src/usr.bin/fold/fold.1,v 1.2 2003/06/17 04:29:26 dillon Exp $
  35 .\"
  36 .Dd April 17, 2002
  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
  44 .Op Fl bs
  45 .Op Fl w Ar width
  46 .Op Ar
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility is a filter which folds the contents of the specified files,
  51 or the standard input if no files are specified,
  52 breaking the lines to have a maximum of 80 columns.
  53 .Pp
  54 The options are as follows:
  55 .Bl -tag -width indent
  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
  63 column positions (or bytes).
  64 .It Fl w Ar width
  65 Specify a line width to use instead of the default 80 columns.
  66 .Ar Width
  67 should be a multiple of 8 if tabs are present, or the tabs should
  68 be expanded using
  69 .Xr expand 1
  70 before using
  71 .Nm .
  72 .El
  73 .Sh SEE ALSO
  74 .Xr expand 1
  75 .Sh STANDARDS
  76 The
  77 .Nm
  78 utility conforms to
  79 .St -p1003.1-2001 .
  80 .Sh BUGS
  81 If underlining is present it may be messed up by folding.