xref: /original-bsd/usr.bin/spell/README (revision 80855e64)
1/*-
2 * Copyright (c) 1987 The Regents of the University of California.
3 * All rights reserved.
4 *
5 * %sccs.include.proprietary.c%
6 */
7
8#ifndef lint
9static char sccsid[] = "@(#)README	1.6 (Berkeley) 04/16/91";
10#endif /* not lint */
11
12All files and subdirectories of /usr/share/dict are recommended for
13rdisting except web2 and web2a (because of their size), and some of
14the files  hlist*  depending on needs of your machine (details below).
15Descriptions of most of these files are given under FILES below.
16
17The new subdirectory "special" contains lists of words in specialized
18fields, which may be hashed in with the regular lists on machines having
19many users working in these fields.  As of this writing, there are two
20such specialized wordlists.
21
22It is advised that system managers also create a directory
23/usr/local/dict. This can be used to maintain files of particular
24interest to users of each machine (e.g., surnames of members of the
25department on a departmental machine).
26
27The hashed wordlists hlista and hlistb in this distribution include
28the words in the file special/4bsd, comprising current 4bsd
29commands, system calls, etc. (from "abs" to "zcat").  Machines
30whose primary users are programmers should take these files by
31rdist.  For machines with other user populations, a file "hlist" is
32provided which only contains the contents of /usr/dict/words.  Managers
33of such machines should rdist this file, and use "spellin" to produce
34files hlist{a,b} which contain the words from
35/usr/share/dict/{american,british} respectively, plus any other files
36appropriate to the needs of the majority of their users.  (Some basic
37unix commands and terms that general users are likely to encounter,
38e.g. troff, emacs, tty, have been included in /usr/share/dict/words.
39More may be added as suggestions are received.)  Here, for instance is a
40script that might be used to create the hashlists on a particular
41machine, so as to include the words in /usr/share/dict/special/math, as well
42as two local lists which we will assume are called
43/usr/local/dict/surnames and /usr/local/dict/acronyms.
44
45	#
46	cd /usr/share/dict
47	cat american special/math /usr/local/dict/{surnames,acronyms} | \
48		spellin hlist > hlista
49	cat british  special/math /usr/local/dict/{surnames,acronyms} | \
50		spellin hlist > hlistb
51
52     Hashlists can also be created from scratch using
53/usr/src/usr.bin/spell/Makefile.  This is now written so that if "make"
54is run with no options it will produce the hashed files as presently
55distributed, but so that the extra wordlists used can be controlled with
56variables LOCAL and SPECIAL.  For instance, the results given by the
57above script can be obtained by doing:
58
59	cd /usr/src/usr.bin/spell
60	make LOCAL='/usr/local/dict/surnames /usr/local/dict/acronyms' \
61		SPECIAL=special.math
62	make install
63
64     Returning to the subject of the wordlists in /usr/dict, these are,
65in general, ordered as in  sort -df.  This makes no difference for
66spell's hashing process, but makes a difference for other commands,
67such as "look", that perform binary searches on the unhashed lists.
68
69Complaints, and any additional suggestions for words or wordlists,
70should be sent to me.  I cannot fix bugs involving the code of "spell",
71but I am maintaining a list of these bugs, and of other ideas for
72improvement.
73		George Bergman, gbergman@cartan.Berkeley.Edu
74		18 March, 1987
75
76--------------------------------------------------------------------
77FILES and subdirectories of /usr/share/dict:
78
79    words    -- common words, and important technical terms from all
80	fields, that are spelled the same in British and American usage.
81    american -- spellings preferred in American but not British usage.
82    british  -- spellings preferred in British but not American usage.
83    stop     -- forms that would otherwise be derivable by "spell" from
84	words in one of the above files, but should not be accepted.
85    hlist    -- hashed list, formed from the file "words" only.
86    hlista   -- hashed list, formed from files {words,american,special/4bsd}.
87    hlistb   -- hashed list, formed from files {words,british,special/4bsd}.
88    hstop    -- hashed list, formed from file "stop".
89    web2     -- words from Webster's 2nd International (see WEB below).
90    web2a    -- compounds and phrases from same source.
91    README   -- this file
92    papers/  -- an (out-of-date specialized) bibliographical database,
93	used as the default by the program "refer".
94    special/ -- directory of less common terms from specialized fields.
95	It presently contains:
96
97	special/4bsd -- commands and system calls (from filenames in
98	    /usr/share/man/man[1238n]), and builtin csh commands (named in
99	    /usr/share/man/man1/csh.1) of the current version of 4bsd Unix.
100	    (Supersedes old "/usr/src/usr.bin/spell/local".)
101	special/math -- some mathematical terms not in /usr/share/dict/words.
102
103WEB ---- (introduction provided by jaw@riacs) -------------------------
104
105Welcome to Webster's Second International, all 234,936 words worth.
106The 1934 copyright has elapsed, according to the supplier.  The
107supplemental 'web2a' list contains hyphenated terms as well as assorted
108noun and adverbial phrases.  The wordlist makes a dandy 'grep' victim.
109
110     -- James A. Woods    {ihnp4,hplabs}!ames!jaw    (or jaw@riacs)
111