home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / isp31b3.zip / ispell / 00readme.os2 next >
Lisp/Scheme  |  1995-07-10  |  7KB  |  180 lines
  1. ispell 3.1.18 to os/2 port  using emx09 (fix3)
  2.  
  3. This ispell-port intends to be as similar as possible to the
  4. unix-ispell - Thus you'll need long filename support and all the gnu
  5. unix-utilities. Furthermore, you'll need the emx runtime package 
  6. (see the emx-directory). 
  7. If you're not used to unix, you might look for Rick-Papos ispell-port which
  8. is more the os2-way. It comes as dll and with an API !!
  9. (rpapo@conch.aa.msen.com)
  10.  
  11. This ispell comes with German/English dictionarys. Before deleting one
  12. of those sub-dirs, check your existing affix-files (see below) !!!  If you
  13. don't intend to recompile ispell yourself, you may also delete the
  14. sources-dir.
  15. Please read the the file README and the additional docs within the
  16. subdirs.
  17.  
  18. The docs are provided in man-page and texinfo format.
  19.  
  20.  
  21. INSTALLATION 
  22.  
  23. ispell assumes that you have set the environment-variables HOME,TMP and
  24. TERM. If you don't have so, and you don't know how to do so,please wait
  25. for the next beta relaese which will include a description how to do it.
  26.  
  27. If you intend, to run ispell without emacs, that is from the
  28. commandline, you'll need the file termcap.dat.
  29. For an example how to run ispell from the command-line, see the provided
  30. examples ispellg.cmd (german dictionarys and umlauts) and ispelle.cmd
  31. (english spelling). Ispell won't run with the DataLogic shell!!!
  32.  
  33. Ok, here we go:
  34. backup your existing ispell installation !!!!!
  35.  
  36. Set the env-variable DICTDIR like DICTDIR=d:/dicts -- please no
  37. quotes! A T T E N T I O N : This variable has changed since beta2 !! 
  38. Ispell will exit with a return-code of 10 if you haven't set DICTDIR !!
  39. mv your dictionarys and personal wordlist into this directory. 
  40. If you previously have used ispell3.009, you need to rebuild your
  41. hash-files!
  42. The affix-files from 3.009 are no longer valid please use
  43. the affix-files for 3.1. E.g.:
  44.  
  45.     buildhash your-dictfile new-aff-file hash-file
  46.  
  47. The resulting hash-files need to have the extension xxxx.hash
  48. in order to run with this ispell-version --> edit your emacs-ispell-
  49. section in .emacs or site-start.el accordingly.
  50.  
  51. If you'r updating from beta2, no changes are needed.
  52.  
  53. Add in your .emacs or site-start.el file the following line to your
  54. existing ispell-init-code:
  55.  
  56. (defvar ispell-personal-dictionary "d:/usr/ispell/pers.dict") 
  57.  
  58. This should be your default personal-dict (e.g. english) __not__ the
  59. one which is called by some language-hook. Language specific dicts
  60. should instead be set by buffer-local variables. As for example:
  61.  
  62. (TeX-add-style-hook "german"
  63.  (function (lambda ()
  64.    (setq ispell-local-pdict "d:/usr/ispell/german.wrd")
  65.    (ispell-change-dictionary "german")
  66.    (run-hooks 'TeX-language-de-hook))))
  67.  
  68. This can be done conveniently by the language specific hooks of
  69. auctex, or manually at the end of the buffer (see ispell.el for
  70. details).
  71. Specifying the local-dict by ispell-dictionary-alist will not work!
  72.  
  73. If you're using emacs with code-page 850, you need to modify
  74. ispell-dictionary-alist.
  75.  
  76. To use code page 850 instead, create a file `myloadup.el' in
  77. \emacs\19.29\lisp:
  78.  
  79. ----------------------------- cut here
  80. ; myloadup.el
  81. (setq ispell-dictionary-alist
  82.   '((nil                ; default (english.aff)
  83.      "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil)
  84.     ("english"                ; make english explicitly
  85. selectable
  86.      "[A-Za-z]" "[^A-Za-z]" "[']" nil ("-B") nil)
  87.     ("deutsch"                ; deutsch.aff
  88.      "[a-zA-Z\"]" "[^a-zA-Z\"]" "[']" t ("-C") "~tex")
  89.     ("deutsch8"
  90.      "[a-zA-Z\204\224\201\216\231\232\341]"
  91.      "[^a-zA-Z\204\224\201\216\231\232\341]"
  92.      "[']" t ("-C" "-d" "deutsch") "~pc")
  93. ))
  94.  
  95. (load "loadup")
  96. ----------------------------- cut here
  97.  
  98. and replace `loadup' in \emacs\19.29\bin\dump.cmd with `myloadup'.
  99. Then, re-dump Emacs.
  100.  
  101. If your personal.dict contains character-codes > 127 ispell will complain.
  102. Just retry and they will be converted automatically. Other than this, ispell
  103. works fine with german umlauts. 
  104.  
  105. From time to time it might be handy to simplify your personal
  106. dictionary (especially with all these german-compound words). This can
  107. be accomplished with the munchlist script. You will need the bash
  108. shell, some cmd-files & REXX support (they are in the munchlist
  109. directory) and the gnu file & text utilities.
  110.  
  111. Install the cmd-file somewhere in your path, create a directory with
  112. the name /usr/tmp and try within your ispell-dir
  113.  
  114.     munchlist.sh -l affix-file personal-dict > munched-dict
  115.  
  116. Depending on the size of your file this step may take several hours.
  117. /usr/tmp/ should have a lot of empty space (at least 10 times the size
  118. of your personal-dict). Right now there are two different bash-shell
  119. ports around. If you have any troubles, try the other one.
  120.  
  121. If you need to recompile it yourself, go into the sources-dir, cp
  122. the file local.os2 to source/local.h (maybe you want to edit this file at the
  123. very end), copy the makefile to /source/makefile
  124. get the latest data-logic shell (the emx-version won't work!), apply
  125. the the file patch.os2 and type make programs. The process
  126. will fail if you try to build the dicts.  This is due to my lack of
  127. understanding shell-scripts and due to apparent limitations of the
  128. existing sh, ksh and bash ports for os2.
  129.  
  130. Building the munchlist script:
  131.  
  132.     make munchlist
  133.  
  134. mv munchlist munchlist.sh. Exchange all /bin/rm statements with rm and
  135. edit the first line to use bash.exe instead of sh.exe.
  136.  
  137. Please mail bugs not to ispell-bug, instead mail 'em to me!
  138.  
  139. Have fun
  140.  
  141. Uli
  142.  
  143.     uli@homer.geol.tu-muenchen.de
  144.  
  145.  
  146. PROBLEMS:
  147.  
  148. The variable ispell-local-pdict (like "d:/usr/ispell/german.wrd") is
  149. not reset when one changes into a buffer written in the default language.
  150.  
  151. Setting  ispell-local-pdict in a non-default-language buffer does not
  152. update ispell-pdict-keyword, this has to be done explicitly by
  153. ispell-change-dictionary.
  154.  
  155. BUGS:
  156.     Lookup Command needs still the compile-time information where to
  157.     find the system-dictionary
  158.  
  159.     A shell-escape command without arguments gives a core-dump
  160.  
  161. TODO:
  162.     A DOS-Version
  163.     Better readme ;-)
  164.     Convert the man-page docs to ascii.txt
  165.  
  166. HISTORY:
  167.  
  168. 19.5.95 alpha release
  169.  
  170. 23.5.95 added sources, german and english dicts, recompiled with -O3 and using 
  171.     8Bit, added a modified munchlist and the needed cmd-files.
  172.  
  173. 32.5.95 beta2, added support for systems with multiple partitions,
  174.     needs now the env-var DICTLIB
  175.  
  176. 10.7.95 beta3, ispell can now be used from the command-line. Ispell will
  177.     now find it's dictionarys independent from compile-time options.
  178.  
  179.     The environment variable DICTLIB has changed to DICTDIR.
  180.