Commit | Line | Data |
---|---|---|
280efb10 | 1 | @(#)README 4.2 (Berkeley) 82/11/06" |
2958d0fe RH |
2 | |
3 | The writing tools package contains 3 command files, | |
280efb10 | 4 | style, diction, and suggest. |
2958d0fe RH |
5 | ``style'' reads a document and analyzes the surface |
6 | characteristics of the writing style of the document. | |
7 | ``diction'' locates all sentences in a document containing | |
8 | commonly misused or wordy phrases. | |
280efb10 RH |
9 | ``suggest'' is an interactive thesaures for the phrases found by diction. |
10 | suggest was originally named ``explain''. | |
2958d0fe | 11 | |
280efb10 RH |
12 | The manual pages are in files style.1 and diction.1 - see the enclosed |
13 | documentation for more details. | |
2958d0fe RH |
14 | |
15 | ``style'' is a runcom that runs 4 programs, style1, style2, style3, and deroff. | |
2958d0fe | 16 | |
280efb10 RH |
17 | To make style: |
18 | set LIB in Makefile to the directory where the object files | |
19 | are to be stored. (probably /usr/lib/style) | |
20 | set BIN in Makefile to the directory for the shell programs | |
21 | (usually /usr/bin) | |
22 | in the file ``style'' set L to the same directory as LIB above. | |
23 | the same is needed in ``topic'', which is installed | |
24 | when you make style | |
25 | if you wish to collect data on the documents run, also define SCATCH | |
26 | otherwise delete the definition of SCATCH in Makefile | |
27 | if you are collecting data, the file must exist and be writeable | |
28 | by everyone | |
2958d0fe | 29 | then run ``make style'' |
280efb10 RH |
30 | this will compile and install all of the programs in both |
31 | LIB and BIN | |
2958d0fe RH |
32 | |
33 | ``diction'' is a runcom that runs 2 programs, dprog and deroff. | |
2958d0fe RH |
34 | |
35 | To make dprog: | |
36 | set DICT in Makefile to the full path name of diction's data | |
37 | file ``dict.d'' | |
280efb10 | 38 | the file ``diction'' also needs L set to the same directory as LIB |
2958d0fe | 39 | the program ``dprog'' will get put in the same place as |
280efb10 RH |
40 | the object files for style (LIB). |
41 | if you wish to collect data on the documents run, also define CATCH | |
42 | otherwise delete the definition of CATCH in Makefile | |
43 | the collection file must exist and be writeable by everyone | |
2958d0fe | 44 | then run ``make diction'' |
2958d0fe | 45 | |
280efb10 RH |
46 | The file ``suggest'' needs D set to the full path name of the file |
47 | suggest.d | |
2958d0fe RH |
48 | |
49 | Both ``style'' and ``diction'' expect the document to contain formatting | |
50 | commands. A new version of deroff is included that knows about | |
51 | the standard UNIX formatting macro packages. | |
280efb10 RH |
52 | the source for getopt.c is included just in case you don't have it. |
53 | if the loader complains about not finding getopt, compile & load | |
54 | it with deroff.c | |
55 | typing | |
56 | make deroff | |
57 | will compile and install it in /usr/bin | |
2958d0fe | 58 | |
280efb10 | 59 | The default flag passed to deroff (either -ms or -mm) in both |
2958d0fe RH |
60 | style and diction should be set to the proper one for your installation. |
61 | ||
280efb10 RH |
62 | These programs will not compile under UNIX version 6 or PWB 1.2 |
63 | because of size limitations on these systems. | |
64 |