usr.bin/fmt/fmt.1

   1 .\"     $NetBSD: fmt.1,v 1.13 2012/06/30 21:31:15 christos 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 June 31, 2012
  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 Fl w Ar maximum
  51 .Op name ...
  52 .Sh DESCRIPTION
  53 .Nm
  54 is a simple text formatter which reads the concatenation of input
  55 files (or standard input if none are given) and produces on standard
  56 output a version of its input with lines as close to the
  57 .Ar goal
  58 length as possible without exceeding the
  59 .Ar maximum .
  60 The
  61 .Ar goal
  62 length defaults to 65 and the
  63 .Ar maximum
  64 to 75.
  65 The spacing at the beginning of the input lines is preserved in
  66 the output, as are blank lines and interword spacing.
  67 In non raw mode, lines that look like mail headers or begin with
  68 a period are not formatted.
  69 .Pp
  70 .Bl -tag -width ".Fl m Ar maximum"
  71 .It Fl C
  72 instructs
  73 .Nm
  74 to center the text.
  75 .It Fl g Ar goal
  76 New way to set the goal length.
  77 .It Fl m Ar maximum
  78 New way to set the maximum length.
  79 .It Fl w Ar maximum
  80 New way to set the maximum length.
  81 .It Fl r
  82 Raw mode; formats all lines and does not make exceptions for lines
  83 that start with a period or look like mail headers.
  84 .El
  85 .Pp
  86 .Nm
  87 is meant to format mail messages prior to sending, but may also be useful
  88 for other simple tasks.
  89 For instance, within visual mode of the
  90 .Xr ex 1
  91 editor (e.g.,
  92 .Xr vi 1 )
  93 the command
  94 .Pp
  95 .Dl \&!}fmt
  96 .Pp
  97 will reformat a paragraph, evening the lines.
  98 .Sh SEE ALSO
  99 .Xr mail 1 ,
 100 .Xr nroff 1
 101 .Sh HISTORY
 102 The
 103 .Nm
 104 command appeared in
 105 .Bx 3 .
 106 .\" .Sh AUTHORS
 107 .\" Kurt Shoens
 108 .\" .Pp
 109 .\" Liz Allen (added goal length concept)
 110 .Sh BUGS
 111 The program was designed to be simple and fast \- for more complex
 112 operations, the standard text processors are likely to be more
 113 appropriate.