xref: /original-bsd/usr.bin/fmt/fmt.1 (revision c3e32dec)
1.\" Copyright (c) 1980, 1990, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" %sccs.include.redist.man%
5.\"
6.\"     @(#)fmt.1	8.1 (Berkeley) 06/06/93
7.\"
8.Dd
9.Dt FMT 1
10.Os
11.Sh NAME
12.Nm fmt
13.Nd simple text formatter
14.Sh SYNOPSIS
15.Nm fmt
16.Oo
17.Ar goal
18.Op Ar maximum
19.Oc
20.Op name ...
21.Sh DESCRIPTION
22.Nm Fmt
23is a simple text formatter which reads the concatenation of input
24files (or standard input if none are given) and produces on standard
25output a version of its input with lines as close to the
26.Ar goal
27length
28as possible without exceeding the maximum.  The
29.Ar goal
30length defaults
31to 65 and the maximum to 75.  The spacing at the beginning of the
32input lines is preserved in the output, as are blank lines and
33interword spacing.
34.Pp
35.Nm Fmt
36is meant to format mail messages prior to sending, but may also be useful
37for other simple tasks.
38For instance,
39within visual mode of the
40.Xr ex 1
41editor (e.g.
42.Xr vi 1 )
43the command
44.Pp
45.Dl \&!}fmt
46.Pp
47will reformat a paragraph,
48evening the lines.
49.Sh SEE ALSO
50.Xr nroff 1 ,
51.Xr mail 1
52.Sh HISTORY
53The
54.Nm fmt
55command appeared in
56.Bx 3 .
57.\" .Sh AUTHOR
58.\" Kurt Shoens
59.\" .br
60.\" Liz Allen (added goal length concept)
61.Sh BUGS
62The program was designed to be simple and fast \- for more complex
63operations, the standard text processors are likely to be more appropriate.
64