Annotation of src/usr.bin/fmt/fmt.1, Revision 1.1.1.1
1.1 deraadt 1: .\" $NetBSD: fmt.1,v 1.3 1995/09/01 01:29:40 jtc 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. All advertising materials mentioning features or use of this software
15: .\" must display the following acknowledgement:
16: .\" This product includes software developed by the University of
17: .\" California, Berkeley and its contributors.
18: .\" 4. Neither the name of the University nor the names of its contributors
19: .\" may be used to endorse or promote products derived from this software
20: .\" without specific prior written permission.
21: .\"
22: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32: .\" SUCH DAMAGE.
33: .\"
34: .\" @(#)fmt.1 8.1 (Berkeley) 6/6/93
35: .\"
36: .Dd June 6, 1993
37: .Dt FMT 1
38: .Os
39: .Sh NAME
40: .Nm fmt
41: .Nd simple text formatter
42: .Sh SYNOPSIS
43: .Nm fmt
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: .Nm Fmt
64: is meant to format mail messages prior to sending, but may also be useful
65: for other simple tasks.
66: For instance,
67: within visual mode of the
68: .Xr ex 1
69: editor (e.g.
70: .Xr vi 1 )
71: the command
72: .Pp
73: .Dl \&!}fmt
74: .Pp
75: will reformat a paragraph,
76: evening the lines.
77: .Sh SEE ALSO
78: .Xr nroff 1 ,
79: .Xr mail 1
80: .Sh HISTORY
81: The
82: .Nm fmt
83: command appeared in
84: .Bx 3 .
85: .\" .Sh AUTHOR
86: .\" Kurt Shoens
87: .\" .br
88: .\" Liz Allen (added goal length concept)
89: .Sh BUGS
90: The program was designed to be simple and fast \- for more complex
91: operations, the standard text processors are likely to be more appropriate.