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