xref: /original-bsd/usr.bin/diction/style/style.1 (revision ec35a16d)
1.\" Copyright (c) 1990, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" %sccs.include.redist.man%
5.\"
6.\"     @(#)style.1	8.1 (Berkeley) 06/06/93
7.\"
8.Dd
9.Dt STYLE 1
10.Os BSD 4
11.Sh NAME
12.Nm style
13.Nd analyze surface characteristics of a document
14.Sh SYNOPSIS
15.Nm style
16.Op Fl ml
17.Op Fl mm
18.Op Fl a
19.Op Fl e
20.Op Fl l Ns Ar num
21.Op Fl r Ns Ar num
22.Op Fl p
23.Op Fl P
24.Ar file ...
25.Sh DESCRIPTION
26.Nm Style
27analyzes the surface characteristics of the writing style
28of a document.
29It reports on readability, sentence length and
30structure, word length and usage, verb type, and sentence openers.
31Because
32.Nm style
33runs
34.Xr deroff
35before looking at the text, formatting
36header files should be included as part of the input.
37.Pp
38Options available:
39.Bl -tag -width 8n
40.It Fl a
41print all sentences with their length and readability index.
42.It Fl e
43print all sentences that begin with an expletive.
44.It Fl p
45print all sentences that contain a passive verb.
46.It Fl l Ar num
47print all sentences longer than
48.Ar num .
49.It Fl ml
50The flag
51.Fl ml ,
52which causes
53.Xr deroff
54to skip lists, should be used if the document contains many lists of
55non-sentences.
56.It Fl mm
57The default macro package
58.Fl ms
59may be overridden with the flag
60.Fl mm .
61.It Fl r Ar num
62print all sentences whose readability index is greater than
63.Ar num .
64.It Fl P
65print parts of speech of the words in the document.
66.Sh SEE ALSO
67.Xr deroff 1 ,
68.Xr diction 1
69.Sh BUGS
70Use of non-standard formatting macros may cause
71incorrect sentence breaks.
72.Sh HISTORY
73The
74.Nm
75command appeared in
76.Bx 4 .
77