home *** CD-ROM | disk | FTP | other *** search
/ MacGames Sampler / PHT MacGames Bundle.iso / MacSource Folder / Samples from the CD / Editors / emacs / Emacs-1.14b1-sources / sources / utility-src / ispell / install < prev    next >
Encoding:
Text File  |  1993-12-04  |  7.0 KB  |  177 lines  |  [TEXT/EMAC]
  1. This is GNU ISPELL V3, an interactive spelling corrector based on ITS SPELL.
  2.  
  3.  
  4. DOCUMENTATION:
  5.  
  6. See the man page 'ispell.1' and the file 'ispell.texinfo'.
  7.  
  8.  
  9. INSTALLATION:
  10.  
  11. 1.  Configure Ispell for your system.  In the directory that this file
  12. is in, type `./configure'.  If you're using `csh' on an old version of
  13. System V, you might need to type `sh configure' instead to prevent
  14. `csh' from trying to execute `configure' itself.
  15.  
  16. The `configure' shell script attempts to guess correct values for
  17. various system-dependent variables used during compilation, and
  18. creates the Makefile(s) (one in each subdirectory of the source
  19. directory).  In some packages it creates a C header file containing
  20. system-dependent definitions.  It also creates a file `config.status'
  21. that you can run in the future to recreate the current configuration.
  22.  
  23. Running `configure' takes a minute or two.  While it is running, it
  24. prints some messages that tell what it is doing.  If you don't want to
  25. see the messages, run `configure' with its standard output redirected
  26. to `/dev/null'; for example, `./configure >/dev/null'.
  27.  
  28. To compile the package in a different directory from the one
  29. containing the source code, you must use a version of `make' that
  30. supports the VPATH variable, such as GNU `make'.  `cd' to the
  31. directory where you want the object files and executables to go and
  32. run `configure'.  `configure' automatically checks for the source code
  33. in the directory that `configure' is in and in `..'.  If for some
  34. reason `configure' is not in the source code directory that you are
  35. configuring, then it will report that it can't find the source code.
  36. In that case, run `configure' with the option `--srcdir=DIR', where
  37. DIR is the directory that contains the source code.
  38.  
  39. By default, `make install' will install the Ispell files in
  40. /usr/local/bin, /usr/local/lib, /usr/local/man, etc.  You can specify
  41. an installation prefix other than /usr/local by giving `configure' the
  42. option `--prefix=PATH'.  Alternately, you can do so by giving a value
  43. for the `prefix' variable when you run `make', e.g.,
  44.     make prefix=/usr/gnu
  45.  
  46. You can specify separate installation prefixes for
  47. architecture-specific files and architecture-independent files.  If
  48. you give `configure' the option `--exec-prefix=PATH' or set the `make'
  49. variable `exec_prefix' to PATH, the package will use PATH as the
  50. prefix for installing programs and libraries.  Data files and
  51. documentation will still use the regular prefix.  Normally, all files
  52. are installed using the regular prefix.
  53.  
  54. Another `configure' option is useful mainly in `Makefile' rules for
  55. updating `config.status' and `Makefile'.  The `--no-create' option
  56. figures out the configuration for your system and records it in
  57. `config.status', without actually configuring the package (creating
  58. `Makefile').  Later, you can run `./config.status' to actually
  59. configure the package.  You can also give `config.status' the
  60. `--recheck' option, which makes it re-run `configure' with the same
  61. arguments you used before.  This option is useful if you change
  62. `configure'.
  63.  
  64. `configure' ignores any other arguments that you give it.
  65.  
  66. If your system requires unusual options for compilation or linking
  67. that `configure' doesn't know about, you can give `configure' initial
  68. values for some variables by setting them in the environment.  In
  69. Bourne-compatible shells, you can do that on the command line like
  70. this:
  71.     CC='gcc -traditional' DEFS=-D_POSIX_SOURCE ./configure
  72.  
  73. The `make' variables that you might want to override with environment
  74. variables when running `configure' are:
  75.  
  76. (For these variables, any value given in the environment overrides the
  77. value that `configure' would choose:)
  78. CC        C compiler program.
  79.         Default is `cc', or `gcc' if `gcc' is in your PATH.
  80. INSTALL        Program to use to install files.
  81.         Default is `install' if you have it, `cp' otherwise.
  82.  
  83. (For these variables, any value given in the environment is added to
  84. the value that `configure' chooses:)
  85. DEFS        Configuration options, in the form `-Dfoo -Dbar ...'
  86. LIBS        Libraries to link with, in the form `-lfoo -lbar ...'
  87.  
  88. If you need to do unusual things to compile the package, we encourage
  89. you to figure out how `configure' could check whether to do them, and
  90. mail diffs or instructions to the address given in the README so we
  91. can include them in the next release.
  92.  
  93. 2.  Type `make' to compile the package.  If you want, you can override
  94. the `make' variables CFLAGS and LDFLAGS like this:
  95.  
  96.     make CFLAGS=-O2 LDFLAGS=-s
  97.  
  98. 3.  Type `make install' to install programs, data files, and
  99. documentation.
  100.  
  101. The files that get installed are (directories vary):
  102.  
  103.     /usr/local/lib/ispell/ispell.dict
  104.     /usr/local/lib/ispell/ispell.words
  105.     /usr/local/bin/ispell
  106.     /usr/local/bin/look
  107.     /usr/local/lib/elisp/ispell.el
  108.     /usr/local/lib/elisp/ispell.elc
  109.     /usr/local/lib/emacs/info/ispell
  110.     /usr/local/man/man1/ispell.1
  111.  
  112.  
  113. 4.  You can remove the program binaries and object files from the
  114. source directory by typing `make clean'.  To also remove the
  115. Makefile(s), the header file containing system-dependent definitions
  116. (if the package uses one), and `config.status' (all the files that
  117. `configure' created), type `make distclean'.
  118.  
  119. The file `configure.in' is used as a template to create `configure' by
  120. a program called `autoconf'.  You will only need it if you want to
  121. regenerate `configure' using a newer version of `autoconf'.
  122.  
  123.  
  124. ADDING WORDS TO THE DICTIONARY:
  125.  
  126. You must remove unwanted punctuation from the word list before 
  127. using it with ispell.  It is ok to leave in apostrophes, but
  128. other non-alphabetic characters are not desirable.  Anything
  129. that you do leave in will be used in near miss generation, and
  130. in the parser.  For example, if the word list contains a hyphen
  131. in any entry, then the parser will always consider hyphen a 
  132. part of a word, and strings like 'two-character' will get looked
  133. up as one word.
  134.  
  135. However, since the character set is determined by scanning the
  136. word list, it automatically handles single byte international
  137. characters.  If you use or extend these new parts of ispell,
  138. please let us know.
  139.  
  140. The flags in the dictionary must be set up by the program itself.
  141. See the node "Dictionary flags" in the info file for details.
  142.  
  143. The way to do this is:
  144.  
  145.     cat dictionary files ... > dict0
  146.     freq < dict0 > freqtbl
  147.     build -a -r -f freqtbl -o dict dict0
  148.     build -b -f freqtbl -o ispell.dict dict
  149.  
  150. The input files may have flags, but do not have to, and they do not
  151. need to be sorted.  The '-r' (reap) flag to build means to try to
  152. replace entries with flags on other entries.  The '-a' flag means to
  153. write the output in ascii.  After the first build run, the file 'dict'
  154. contains all of the input words, but with the flags correctly set.
  155. The second one is the same as the one in the makefile.
  156.  
  157. The hash table used by build and ispell cannot contain more than about
  158. 64K root words at one time.  You can have many more words in the dictionary
  159. because of the flags; however, you have to bootstrap a random word list
  160. in smaller chunks:
  161.  
  162.     freq < wordlist > freqtbl
  163.     split -60000 wordlist
  164.     cp /dev/null d0
  165.     for i in x??
  166.     do
  167.         build -a -r -f freqtbl -o tmp $i
  168.         cat tmp >> d0
  169.     done
  170.     build -a -r -f freqtbl -o dict d0
  171.     build -b -f freqtbl -o ispell.dict dict
  172.  
  173.  
  174.  
  175.  
  176.  
  177.