usr.bin/fmt/fmt.1

   1 .\"     $NetBSD: fmt.1,v 1.11 2008/08/26 12:12:58 lukem Exp $
   2 .\"
   3 .\" Copyright (c) 1980, 1990, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)fmt.1       8.1 (Berkeley) 6/6/93
  31 .\"
  32 .Dd May 29, 2007
  33 .Dt FMT 1
  34 .Os
  35 .Sh NAME
  36 .Nm fmt
  37 .Nd simple text formatter
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl Cr
  41 .Oo
  42 .Ar goal
  43 .Op Ar maximum
  44 .Oc
  45 .Op name ...
  46 .Nm
  47 .Op Fl Cr
  48 .Op Fl g Ar goal
  49 .Op Fl m Ar maximum
  50 .Op name ...
  51 .Sh DESCRIPTION
  52 .Nm
  53 is a simple text formatter which reads the concatenation of input
  54 files (or standard input if none are given) and produces on standard
  55 output a version of its input with lines as close to the
  56 .Ar goal
  57 length as possible without exceeding the
  58 .Ar maximum .
  59 The
  60 .Ar goal
  61 length defaults to 65 and the
  62 .Ar maximum
  63 to 75.
  64 The spacing at the beginning of the input lines is preserved in
  65 the output, as are blank lines and interword spacing.
  66 In non raw mode, lines that look like mail headers or begin with
  67 a period are not formatted.
  68 .Pp
  69 .Bl -tag -width ".Fl m Ar maximum"
  70 .It Fl C
  71 instructs
  72 .Nm
  73 to center the text.
  74 .It Fl g Ar goal
  75 New way to set the goal length.
  76 .It Fl m Ar maximum
  77 New way to set the maximum length.
  78 .It Fl r
  79 Raw mode; formats all lines and does not make exceptions for lines
  80 that start with a period or look like mail headers.
  81 .El
  82 .Pp
  83 .Nm
  84 is meant to format mail messages prior to sending, but may also be useful
  85 for other simple tasks.
  86 For instance, within visual mode of the
  87 .Xr ex 1
  88 editor (e.g.,
  89 .Xr vi 1 )
  90 the command
  91 .Pp
  92 .Dl \&!}fmt
  93 .Pp
  94 will reformat a paragraph, evening the lines.
  95 .Sh SEE ALSO
  96 .Xr mail 1 ,
  97 .Xr nroff 1
  98 .Sh HISTORY
  99 The
 100 .Nm
 101 command appeared in
 102 .Bx 3 .
 103 .\" .Sh AUTHORS
 104 .\" Kurt Shoens
 105 .\" .Pp
 106 .\" Liz Allen (added goal length concept)
 107 .Sh BUGS
 108 The program was designed to be simple and fast \- for more complex
 109 operations, the standard text processors are likely to be more
 110 appropriate.