xref: /csrg-svn/usr.bin/diction/README (revision 9083)
1*9083Srrh@(#)README	4.2	(Berkeley)	82/11/06"
29078Srrh
39078SrrhThe writing tools package contains 3 command files,
4*9083Srrh	style, diction, and suggest.
59078Srrh``style'' reads a document and analyzes the surface
69078Srrh	characteristics of the writing style of the document.
79078Srrh``diction'' locates all sentences in a document containing
89078Srrh	commonly misused or wordy phrases.
9*9083Srrh``suggest'' is an interactive thesaures for the phrases found by diction.
10*9083Srrh	suggest was originally named ``explain''.
119078Srrh
12*9083SrrhThe manual pages are in files style.1 and diction.1 - see the enclosed
13*9083Srrh	documentation for more details.
149078Srrh
159078Srrh``style'' is a runcom that runs 4 programs, style1, style2, style3, and deroff.
169078Srrh
17*9083SrrhTo make style:
18*9083Srrh	set LIB in Makefile to the directory where the object files
19*9083Srrh		are to be stored. (probably /usr/lib/style)
20*9083Srrh	set BIN in Makefile to the directory for the shell programs
21*9083Srrh		(usually /usr/bin)
22*9083Srrh	in the file ``style'' set L to the same directory as LIB above.
23*9083Srrh		the same is needed in ``topic'', which is installed
24*9083Srrh		when you make style
25*9083Srrh	if you wish to collect data on the documents run, also define SCATCH
26*9083Srrh		otherwise delete the definition of SCATCH in Makefile
27*9083Srrh		if you are collecting data, the file must exist and be writeable
28*9083Srrh		by everyone
299078Srrh	then run ``make style''
30*9083Srrh		this will compile and install all of the programs in both
31*9083Srrh		LIB and BIN
329078Srrh
339078Srrh``diction'' is a runcom that runs 2 programs, dprog and deroff.
349078Srrh
359078SrrhTo make dprog:
369078Srrh	set DICT in Makefile to the full path name of diction's data
379078Srrh		file ``dict.d''
38*9083Srrh	the file ``diction'' also needs L set to the same directory as LIB
399078Srrh	the program ``dprog'' will get put in the same place as
40*9083Srrh		the object files for style (LIB).
41*9083Srrh	if you wish to collect data on the documents run, also define CATCH
42*9083Srrh		otherwise delete the definition of CATCH in Makefile
43*9083Srrh		the collection file must exist and be writeable by everyone
449078Srrh	then run ``make diction''
459078Srrh
46*9083SrrhThe file ``suggest'' needs D set to the full path name of the file
47*9083Srrh	suggest.d
489078Srrh
499078SrrhBoth ``style'' and ``diction'' expect the document to contain formatting
509078Srrh	commands.  A new version of deroff is included that knows about
519078Srrh	the standard UNIX formatting macro packages.
52*9083Srrh	the source for getopt.c is included just in case you don't have it.
53*9083Srrh	if the loader complains about not finding getopt, compile & load
54*9083Srrh		it with deroff.c
55*9083Srrh	typing
56*9083Srrh		make deroff
57*9083Srrh	will compile and install it in /usr/bin
589078Srrh
59*9083SrrhThe default flag passed to deroff (either -ms or -mm) in both
609078Srrh	style and diction should be set to the proper one for your installation.
619078Srrh
62*9083SrrhThese programs will not compile under UNIX version 6 or PWB 1.2
63*9083Srrh	because of size limitations on these systems.
64*9083Srrh
65