[net.sources] Manual page for format.c

dhb (04/21/83)

.TH FORMAT LOCAL "SSD-SGF UNIX Manual"
.UC
.SH NAME
format \- format nroff text files with/without tables and equations
.SH SYNOPSIS
.nf
format [--] [-v] [-c] [files]
format [--] [-v] [-c] -
.fi
.SH DESCRIPTION
Format is an attempt to automate the various pre-processors,
post-processors, and macro packages used with UNIX text processing
to one simple command.
.PP
The format program will scan the input file(s) for signs of
"tbl(1)" or "neqn(1)", and run the file thru the appropriate
filters.  It will also scan the file or files to determine the
macro package in use within the file.  Format currently knows
about "ms", "me", "mm", and "man" type macros.
.PP
In the event that the "-v" flag is used, the output will be filtered
through the "more" program.  This is intended for use on CRT terminals.
.PP
The "-c" option specifies that the "col" filter should be used on the
output, as is appropriate for hard copy printers that are not capable
of half-line or reverse line motion, (such as a line printer).
.PP
The "--" option specifies that "format" should scan all input files
for any possible macro references and reports the result of the scan.
It DOES NOT format the files.  It is mainly useful for verifying that
a file, or more aptly a set of files, only uses one macro package.
.PP
If "format" is to accept files from standard input, a "-" option must
be used as a file name.  All other options will be passed to "nroff".
See "nroff(1)" for further details.
.SH FILES
/tmp/FORMAT$$  temporary file
.SH "SEE ALSO"
nroff(1), mm(LOCAL), tbl(1), neqn(1), col(1), more(1)
.SH "BUGS"
.I Format
will not read ".so" files more than 12 deep.
.br
.I Format
has trouble recognizing "man" macros unless one (or more) of the
following macros is used: .BI, .BR, .DT, .HP, .IB, .IR, .PD, .RB, .RI.
.SH "AUTHOR"
D. H. Brierley
.DT