Return to fmt.1 CVS log

Up to [local] / src / usr.bin / fmt

Annotation of src/usr.bin/fmt/fmt.1, Revision 1.3

1.3     ! millert     1: .\"    $OpenBSD: fmt.1,v 1.2 1996/06/26 05:33:20 deraadt Exp $
1.1       deraadt     2: .\"    $NetBSD: fmt.1,v 1.3 1995/09/01 01:29:40 jtc Exp $
                      3: .\"
                      4: .\" Copyright (c) 1980, 1990, 1993
                      5: .\"    The Regents of the University of California.  All rights reserved.
                      6: .\"
                      7: .\" Redistribution and use in source and binary forms, with or without
                      8: .\" modification, are permitted provided that the following conditions
                      9: .\" are met:
                     10: .\" 1. Redistributions of source code must retain the above copyright
                     11: .\"    notice, this list of conditions and the following disclaimer.
                     12: .\" 2. Redistributions in binary form must reproduce the above copyright
                     13: .\"    notice, this list of conditions and the following disclaimer in the
                     14: .\"    documentation and/or other materials provided with the distribution.
                     15: .\" 3. All advertising materials mentioning features or use of this software
                     16: .\"    must display the following acknowledgement:
                     17: .\"    This product includes software developed by the University of
                     18: .\"    California, Berkeley and its contributors.
                     19: .\" 4. Neither the name of the University nor the names of its contributors
                     20: .\"    may be used to endorse or promote products derived from this software
                     21: .\"    without specific prior written permission.
                     22: .\"
                     23: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     24: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     25: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     26: .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     27: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     28: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     29: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     30: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     31: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     32: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     33: .\" SUCH DAMAGE.
                     34: .\"
                     35: .\"     @(#)fmt.1      8.1 (Berkeley) 6/6/93
                     36: .\"
                     37: .Dd June 6, 1993
                     38: .Dt FMT 1
                     39: .Os
                     40: .Sh NAME
                     41: .Nm fmt
                     42: .Nd simple text formatter
                     43: .Sh SYNOPSIS
                     44: .Nm fmt
1.3     ! millert    45: .Fl c
1.1       deraadt    46: .Oo
                     47: .Ar goal
                     48: .Op Ar maximum
                     49: .Oc
                     50: .Op name ...
                     51: .Sh DESCRIPTION
                     52: .Nm Fmt
                     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
                     58: as possible without exceeding the maximum.  The
                     59: .Ar goal
                     60: length defaults
                     61: to 65 and the maximum to 75.  The spacing at the beginning of the
                     62: input lines is preserved in the output, as are blank lines and
                     63: interword spacing.
1.3     ! millert    64: .Pp
        !            65: .Fl c
        !            66: instructs
        !            67: .Nm fmt
        !            68: to center the text.
1.1       deraadt    69: .Pp
                     70: .Nm Fmt
                     71: is meant to format mail messages prior to sending, but may also be useful
                     72: for other simple tasks.
                     73: For instance,
                     74: within visual mode of the
                     75: .Xr ex 1
                     76: editor (e.g.
                     77: .Xr vi 1 )
                     78: the command
                     79: .Pp
                     80: .Dl \&!}fmt
                     81: .Pp
                     82: will reformat a paragraph,
                     83: evening the lines.
                     84: .Sh SEE ALSO
                     85: .Xr nroff 1 ,
                     86: .Xr mail 1
                     87: .Sh HISTORY
                     88: The
                     89: .Nm fmt
                     90: command appeared in
                     91: .Bx 3 .
                     92: .\" .Sh AUTHOR
                     93: .\" Kurt Shoens
                     94: .\" .br
                     95: .\" Liz Allen (added goal length concept)
                     96: .Sh BUGS
                     97: The program was designed to be simple and fast \- for more complex
                     98: operations, the standard text processors are likely to be more appropriate.