4.4BSD/usr/src/usr.bin/diction/style/style.1

.\" Copyright (c) 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)style.1	8.1 (Berkeley) 6/6/93
.\"
.Dd June 6, 1993
.Dt STYLE 1
.Os BSD 4
.Sh NAME
.Nm style
.Nd analyze surface characteristics of a document
.Sh SYNOPSIS
.Nm style
.Op Fl ml
.Op Fl mm
.Op Fl a
.Op Fl e
.Op Fl l Ns Ar num
.Op Fl r Ns Ar num
.Op Fl p
.Op Fl P
.Ar file ...
.Sh DESCRIPTION
.Nm Style
analyzes the surface characteristics of the writing style
of a document.
It reports on readability, sentence length and
structure, word length and usage, verb type, and sentence openers.
Because
.Nm style
runs
.Xr deroff
before looking at the text, formatting
header files should be included as part of the input.
.Pp
Options available:
.Bl -tag -width 8n
.It Fl a
print all sentences with their length and readability index.
.It Fl e
print all sentences that begin with an expletive.
.It Fl p
print all sentences that contain a passive verb.
.It Fl l Ar num
print all sentences longer than
.Ar num .
.It Fl ml
The flag
.Fl ml ,
which causes 
.Xr deroff
to skip lists, should be used if the document contains many lists of
non-sentences.
.It Fl mm
The default macro package
.Fl ms
may be overridden with the flag
.Fl mm .
.It Fl r Ar num
print all sentences whose readability index is greater than
.Ar num .
.It Fl P
print parts of speech of the words in the document.
.Sh SEE ALSO
.Xr deroff 1 ,
.Xr diction 1
.Sh BUGS
Use of non-standard formatting macros may cause
incorrect sentence breaks.
.Sh HISTORY
The
.Nm
command appeared in
.Bx 4 .