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

.\" Copyright (c) 1990 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms are permitted provided
.\" that: (1) source distributions retain this entire copyright notice and
.\" comment, and (2) distributions including binaries display the following
.\" acknowledgement:  ``This product includes software developed by the
.\" University of California, Berkeley and its contributors'' in the
.\" documentation or other materials provided with the distribution and in
.\" all advertising materials mentioning features or use of this software.
.\" 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 ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
.\"
.\"     @(#)style.1     6.2 (Berkeley) 6/24/90
.\"
.TH STYLE 1 "%Q"
.AT 3
.SH NAME
style  \-  analyze surface characteristics of a document
.SH SYNOPSIS
.B style
[
.B \-ml
] [
.B \-mm
] [
.B \-a
] [
.B \-e
] [
.B \-l
num ] [
.B \-r
num ] [
.B \-p
] [
.B \-P
]
file ...
.LP
.SH DESCRIPTION
.I 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
.I style
runs
.I deroff
before looking at the text, formatting
header files should be included as part of the input.
The default macro package
.B \-ms
may be overridden with the flag
.B \-mm.
The flag
.BR \-ml ,
which causes
.B deroff
to skip lists, should be used if the document contains many lists of
non-sentences.
The other options are used to locate sentences with certain characteristics.
.TP
.B \-a
print all sentences with their length and readability index.
.TP
.B \-e
print all sentences that begin with an expletive.
.TP
.B \-p
print all sentences that contain a passive verb.
.TP
.BI \-l num
print all sentences longer than
.IR num .
.TP
.BI \-r num
print all sentences whose readability index is greater than
.IR num .
.TP
.B \-P
print parts of speech of the words in the document.
.SH "SEE ALSO"
deroff(1), diction(1)
.SH BUGS
Use of non-standard formatting macros may cause
incorrect sentence breaks.