[unix-history] / usr / src / usr.bin / diction / README

@(#)README	4.1	(Berkeley)	82/11/06"

The writing tools package contains 3 command files,
	style, diction, and explain.
``style'' reads a document and analyzes the surface
	characteristics of the writing style of the document.
``diction'' locates all sentences in a document containing
	commonly misused or wordy phrases.
``explain'' is an interactive thesaures for the phrases found by diction.

The manual pages are in files style.1 and diction.1 - see the enclosed documentation
	for more details.

``style'' is a runcom that runs 4 programs, style1, style2, style3, and deroff.
	style1, style2, style3 are included on the tape, you should not need to
	make them, but if you do -

To make style1, style2, style3:
	set BIN in Makefile to the directory where the object files
		are to be stored.
	then run ``make style''
	in the file ``style'' set B to the same directory as BIN above.

``diction'' is a runcom that runs 2 programs, dprog and deroff.
	dprog has been included on the tape, but you will need to make it
	to include the full path name of dict.d

To make dprog:
	set DICT in Makefile to the full path name of diction's data
		file ``dict.d''
	the program ``dprog'' will get put in the same place as
		the object files for style (BIN).
	then run ``make diction''
	the file ``diction'' also needs B set to the same directory as BIN
		above

The file ``explain'' needs D set to the full path name of the file
	explain.d

Both ``style'' and ``diction'' expect the document to contain formatting
	commands.  A new version of deroff is included that knows about
	the standard UNIX formatting macro packages.
	the command ``make deroff'' will install deroff in BIN mentioned
	above.  You may wish to install this version of deroff in /usr/bin
	in which case the path names to it in files ``style'' and
	``diction'' should be changed accordingly.

The default flag passed to deroff (either -ms or -ml) in both
	style and diction should be set to the proper one for your installation.

These programs will not compile under UNIX version 6 or PWB 1.2 due
	to size limitations on these systems.
Commit	Line	Data
2958d0fe RH	1	@(#)README 4.1 (Berkeley) 82/11/06"
	2
	3	The writing tools package contains 3 command files,
	4	style, diction, and explain.
	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.
	9	``explain'' is an interactive thesaures for the phrases found by diction.
	10
	11	The manual pages are in files style.1 and diction.1 - see the enclosed documentation
	12	for more details.
	13
	14	``style'' is a runcom that runs 4 programs, style1, style2, style3, and deroff.
	15	style1, style2, style3 are included on the tape, you should not need to
	16	make them, but if you do -
	17
	18	To make style1, style2, style3:
	19	set BIN in Makefile to the directory where the object files
	20	are to be stored.
	21	then run ``make style''
	22	in the file ``style'' set B to the same directory as BIN above.
	23
	24	``diction'' is a runcom that runs 2 programs, dprog and deroff.
	25	dprog has been included on the tape, but you will need to make it
	26	to include the full path name of dict.d
	27
	28	To make dprog:
	29	set DICT in Makefile to the full path name of diction's data
	30	file ``dict.d''
	31	the program ``dprog'' will get put in the same place as
	32	the object files for style (BIN).
	33	then run ``make diction''
	34	the file ``diction'' also needs B set to the same directory as BIN
	35	above
	36
	37	The file ``explain'' needs D set to the full path name of the file
	38	explain.d
	39
	40	Both ``style'' and ``diction'' expect the document to contain formatting
	41	commands. A new version of deroff is included that knows about
	42	the standard UNIX formatting macro packages.
	43	the command ``make deroff'' will install deroff in BIN mentioned
	44	above. You may wish to install this version of deroff in /usr/bin
	45	in which case the path names to it in files ``style'' and
	46	``diction'' should be changed accordingly.
	47
	48	The default flag passed to deroff (either -ms or -ml) in both
	49	style and diction should be set to the proper one for your installation.
	50
	51	These programs will not compile under UNIX version 6 or PWB 1.2 due
	52	to size limitations on these systems.