Annotation of src/usr.bin/fmt/fmt.1, Revision 1.2
1.2 ! deraadt 1: .\" $OpenBSD: fmt.1,v 1.3 1995/09/01 01:29:40 jtc 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
45: .Oo
46: .Ar goal
47: .Op Ar maximum
48: .Oc
49: .Op name ...
50: .Sh DESCRIPTION
51: .Nm Fmt
52: is a simple text formatter which reads the concatenation of input
53: files (or standard input if none are given) and produces on standard
54: output a version of its input with lines as close to the
55: .Ar goal
56: length
57: as possible without exceeding the maximum. The
58: .Ar goal
59: length defaults
60: to 65 and the maximum to 75. The spacing at the beginning of the
61: input lines is preserved in the output, as are blank lines and
62: interword spacing.
63: .Pp
64: .Nm Fmt
65: is meant to format mail messages prior to sending, but may also be useful
66: for other simple tasks.
67: For instance,
68: within visual mode of the
69: .Xr ex 1
70: editor (e.g.
71: .Xr vi 1 )
72: the command
73: .Pp
74: .Dl \&!}fmt
75: .Pp
76: will reformat a paragraph,
77: evening the lines.
78: .Sh SEE ALSO
79: .Xr nroff 1 ,
80: .Xr mail 1
81: .Sh HISTORY
82: The
83: .Nm fmt
84: command appeared in
85: .Bx 3 .
86: .\" .Sh AUTHOR
87: .\" Kurt Shoens
88: .\" .br
89: .\" Liz Allen (added goal length concept)
90: .Sh BUGS
91: The program was designed to be simple and fast \- for more complex
92: operations, the standard text processors are likely to be more appropriate.