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$
  34 .\"
  35 .Dd August 2, 2004
  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
  43 .Op Fl bs
  44 .Op Fl w Ar width
  45 .Op Ar
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility 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 a maximum of 80 columns.
  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 Ar width
  64 Specify a line width to use instead of the default 80 columns.
  65 .Ar Width
  66 should be a multiple of 8 if tabs are present, or the tabs should
  67 be expanded using
  68 .Xr expand 1
  69 before using
  70 .Nm .
  71 .El
  72 .Sh ENVIRONMENT
  73 The
  74 .Ev LANG , LC_ALL
  75 and
  76 .Ev LC_CTYPE
  77 environment variables affect the execution of
  78 .Nm
  79 as described in
  80 .Xr environ 7 .
  81 .Sh SEE ALSO
  82 .Xr expand 1 ,
  83 .Xr fmt 1
  84 .Sh STANDARDS
  85 The
  86 .Nm
  87 utility conforms to
  88 .St -p1003.1-2001 .
  89 .Sh BUGS
  90 If underlining is present it may be messed up by folding.