home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / progs / ispell / readme.os2 < prev    next >
Text File  |  1994-01-31  |  3KB  |  79 lines

  1. This archive contains a port to OS/2 1.x--2.x of GNU ispell 4.0, and
  2. includes extensions from Pavel Ganelin <48ganelin@cua.edu> for
  3. handling TeX files.
  4.  
  5. There are two major "ispell" programs, both derived from work by Pace
  6. Willisson and others. The "Ispell International version" by Goeff
  7. Kuenning may be preferred, especially with the Jan-94 release of
  8. version 3.1. Version 3.0.09 has been ported to OS/2 2.x by Joe Huber
  9. <jbhuber@iastate.edu>, and OS/2 2.x users should get his version from
  10. ftp-os2.cdrom.com.
  11.  
  12. The main reason for this port is to provide a version to be used under
  13. OS/2 1.x. The JED editor includes support for ispell. (JED is
  14. Emacs-like, but can run under OS/2 1.x. The OS/2 version is in beta.)
  15.  
  16.  
  17. Installation
  18. ------------
  19. Copy ispell.exe and look.exe to some directory in your PATH. Copy
  20. ispell.dic and ispell.wor to /gnu/lib/ispell/ (or some other handy
  21. place).  Dictionary files can be specified in the environment
  22. variables ISPELL_DICTIONARY and ISPELL_WORDS. If the corresponding
  23. environment variable is not set, then the search looks for ispell.dic
  24. and ispell.wor in /gnu/lib/ispell/, then the current directory, then
  25. along DPATH, and finally along PATH.
  26.  
  27. A personal dictionary can be created by ispell if the HOME environment
  28. variable is set.
  29.  
  30. Place termcap.dat in, say, /etc/, and set the environment var TERMCAP
  31. to be the full pathname of this file.  Note that a number of Unix-like
  32. programs use termcap.dat, and some ports will not handle the pathname
  33. correctly if it contains a drive letter. Some of these ports (and
  34. ispell) can also find termcap.dat along INIT, PATH, or DPATH.
  35.  
  36. You *must* set the environment variable TERM to one of the choices
  37. in termcap.dat (try "set TERM=ansi"). Case is significant.
  38.  
  39. The main documentation is ispell.info, which is designed to be read
  40. with Emacs, JED, or a stand-alone info reader. It can also be examined
  41. with any file viewer. There is a short man page ispell.1.
  42.  
  43. To use ispell with Emacs, copy the ispell.el file to your "site-lisp"
  44. directory. JED can use ispell without any changes to its macros.
  45.  
  46.  
  47. Notes 
  48. ----- 
  49. 1. ispell can be used on a FAT partition; however, Makefile.os2
  50. assumes HPFS for building ispell.
  51.  
  52. 2. The tex.c changes are from Pavel Ganelin <48ganelin@cua.edu>,
  53. who has ported ispell to DOS (his port is available on oak.oakland.edu).
  54.  
  55. 3. Eliminated fork in dochild. Some functions passed to dochild
  56. were modified so that Ctrl-c is handled properly.
  57.  
  58. 4. The makefile has rules for an emx/gcc version; however, I recommend
  59. Huber's port of the international ispell for OS/2 2.x. 
  60.  
  61. 5. If set, the environment variable SHELL is used for "!" shell commands.
  62.  
  63. 6. The changes were made in anticipation of bound OS/2 and DOS
  64. versions.  Use of the popen routines from the gawk distribution should
  65. make it easy to get bound versions.
  66.  
  67.  
  68. Bugs
  69. ----
  70. 1. The keyboard handler could be more robust.
  71.  
  72. 2. The "look" program defaults to "-df" if there is no file given.
  73. I don't understand why look is written so that "look hello"
  74. fails. The problem is in the handling of dictionary order in a search.
  75.  
  76. --
  77. Darrel Hankerson hankedr@mail.auburn.edu
  78. 30-Jan-1994
  79.