usr.bin/fmt/fmt.1

   1 .\" Copyright (c) 1980, 1990, 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 .\"     @(#)fmt.1       8.1 (Berkeley) 6/6/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 6, 1993
  36 .Dt FMT 1
  37 .Os
  38 .Sh NAME
  39 .Nm fmt
  40 .Nd simple text formatter
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl c
  44 .Oo
  45 .Ar goal
  46 .Op Ar maximum
  47 .Oc
  48 .Op name ...
  49 .Sh DESCRIPTION
  50 .Nm Fmt
  51 is a simple text formatter which reads the concatenation of input
  52 files (or standard input if none are given) and produces on standard
  53 output a version of its input with lines as close to the
  54 .Ar goal
  55 length
  56 as possible without exceeding the maximum.  The
  57 .Ar goal
  58 length defaults
  59 to 65 and the maximum to 75.  The spacing at the beginning of the
  60 input lines is preserved in the output, as are blank lines and
  61 interword spacing.
  62 .Pp
  63 .Fl c
  64 instructs
  65 .Nm
  66 to center the text.
  67 .Pp
  68 .Nm Fmt
  69 is meant to format mail messages prior to sending, but may also be useful
  70 for other simple tasks.
  71 For instance,
  72 within visual mode of the
  73 .Xr ex 1
  74 editor (e.g.
  75 .Xr vi 1 )
  76 the command
  77 .Pp
  78 .Dl \&!}fmt
  79 .Pp
  80 will reformat a paragraph,
  81 evening the lines.
  82 .Sh SEE ALSO
  83 .Xr mail 1 ,
  84 .Xr nroff 1
  85 .Sh HISTORY
  86 The
  87 .Nm
  88 command appeared in
  89 .Bx 3 .
  90 .\" .Sh AUTHOR
  91 .\" Kurt Shoens
  92 .\" .br
  93 .\" Liz Allen (added goal length concept)
  94 .Sh BUGS
  95 The program was designed to be simple and fast \- for more complex
  96 operations, the standard text processors are likely to be more appropriate.