Merge the useful bits of the 4.4BSD src/share/dict/README and

src/usr.bin/spell/README files into something (hopefully) coherent.

1 files changed, 51 insertions, 8 deletions

diff --git a/share/dict/README b/share/dict/README
index e9185e0c95c..9bace2e3d9d 100644
--- a/share/dict/README
+++ b/share/dict/README
@@ -1,13 +1,56 @@
-#	$OpenBSD: README,v 1.2 2001/02/03 08:16:22 niklas Exp $
+#	$OpenBSD: README,v 1.3 2002/03/02 02:07:49 millert Exp $
 
-#	@(#)README	5.1 (Berkeley) 5/7/91
+#	@(#)README	8.1 (Berkeley) 6/6/93
 
-WEB ---- (introduction provided by jaw@riacs) -------------------------
+--------------------------------------------------------------------
+FILES and subdirectories of /usr/share/dict:
 
-Welcome to web2 (Webster's Second International) all 234,936 words worth.
-The 1934 copyright has elapsed, according to the supplier.  The
-supplemental 'web2a' list contains hyphenated terms as well as assorted
-noun and adverbial phrases.  The wordlist makes a dandy 'grep' victim.
+    words    -- common words, and important technical terms from all
+		fields, that are spelled the same in British and American usage.
+    web2     -- Webster's Second International Dictionary, all 234,936 words
+		worth.  The 1934 copyright has elapsed.
+    web2a    -- hyphenated terms as well as assorted noun and adverbial phrases
+		from Webster's Second International Dictionary.
+    propernames -- List of proper names, also from Webster's Second
+		International Dictionary.
+    american -- spellings preferred in American but not British usage.
+    british  -- spellings preferred in British but not American usage.
+    stop     -- forms that would otherwise be derivable by "spell" from
+		words in one of the above files, but should not be accepted.
+    README   -- this file
+    papers/  -- an (out-of-date specialized) bibliographical database,
+		used as the default by the program "refer".
+    special/ -- directory of less common terms from specialized fields.
+	It presently contains:
 
-     -- James A. Woods    {ihnp4,hplabs}!ames!jaw    (or jaw@riacs)
+	special/4bsd -- commands and system calls (from filenames in
+	    /usr/share/man/man[1238]), and builtin csh commands (named in
+	    /usr/share/man/man1/csh.1) of the current version of 4bsd Unix.
+	    (Supersedes old "/usr/src/usr.bin/spell/local".)
+	special/math -- some mathematical terms not in /usr/share/dict/words.
 
+--------------------------------------------------------------------
+
+The subdirectory "special" contains lists of words in specialized fields,
+which may be hashed in with the regular lists on machines having many users
+working in these fields.  As of this writing, there are two such specialized
+word lists, 4bsd and math (described briefly above).
+
+It is advised that system managers create a directory /usr/local/share/dict.
+This can be used to maintain files of particular interest to users of each
+machine (e.g., surnames of members of the department on a departmental
+machine).  These files, potentially along with files in /usr/share/dict/special,
+should be placed in /usr/local/share/dict/words, which will be used by
+the spell program.  The following example creates a local words list
+consisting of 4BSD commands and terms as well as local surnames and
+acronyms:
+
+	# sort -df /usr/share/dict/special/4bsd \
+		/usr/local/share/dict/surnames \
+		/usr/local/share/dict/acronyms > /usr/local/share/dict/words
+
+Note that word lists must be sorted in dictionary order and with case folded.
+In general this means they should be passed through "sort -df".
+Word lists that are not sorted in this way will not work properly
+with the spell and look commands since these perform binary searches
+on the word lists.