home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / isp31b3.zip / ispell / ispell.info (.txt) < prev    next >
GNU Info File  |  1995-07-10  |  13KB  |  263 lines
  1. This is Info file ispell.info, produced by Makeinfo-1.55 from the input
  2. file ispell.texinfo.
  3.    This file documents ISPELL, an interactive spelling corrector.
  4.    Copyright 1988, 1990, 1991, 1992, 1993  Free Software Foundation,
  5.    Permission is granted to make and distribute verbatim copies of this
  6. manual provided the copyright notice and this permission notice are
  7. preserved on all copies.
  8.    Permission is granted to copy and distribute modified versions of
  9. this manual under the conditions for verbatim copying, provided that
  10. the entire resulting derived work is distributed under the terms of a
  11. permission notice identical to this one.
  12.    Permission is granted to copy and distribute translations of this
  13. manual into another language, under the above conditions for modified
  14. versions, except that this permission notice may be stated in a
  15. translation approved by the Foundation.
  16. * Menu:
  17. * Emacs::            Using ispell from emacs
  18. * Old Emacs::            Old Emacs
  19. * Private::            Your private dictionary
  20. * Command summary::        All commands in emacs mode
  21. * Near misses::            Definition of a near miss
  22. * History::            Where it came from
  23.  -- The Detailed Node Listing --
  24. Using ispell from emacs
  25. * Word::            Checking a single word
  26. * Buffer::            Checking a whole buffer
  27. * Region::            Checking a region
  28. * Multiple Dictionaries::    Using Multiple Dictionaries
  29. File: ispell,  Node: Top,  Next: Emacs,  Prev: (dir),  Up: (dir)
  30.    `Ispell' is a program that helps you to correct spelling errors in a
  31. file, and to find the correct spelling of words.  When presented with a
  32. word that is not in the dictionary, `ispell' attempts to find "near
  33. misses" that might include the word you meant.
  34.    This manual describes how to use ispell, as well as a little about
  35. its implementation.
  36. * Menu:
  37. * Emacs::            Using ispell from emacs
  38. * Old Emacs::            Old Emacs
  39. * Private::            Your private dictionary
  40. * Command summary::        All commands in emacs mode
  41. * Near misses::            Definition of a near miss
  42. * History::            Where it came from
  43. File: ispell,  Node: Emacs,  Next: Old Emacs,  Prev: Top,  Up: Top
  44. Using ispell from emacs
  45. =======================
  46. * Menu:
  47. * Word::            Checking a single word
  48. * Buffer::            Checking a whole buffer
  49. * Region::            Checking a region
  50. * Multiple Dictionaries::    Using Multiple Dictionaries
  51. File: ispell,  Node: Word,  Next: Buffer,  Prev: Emacs,  Up: Emacs
  52. Checking a single word
  53. ----------------------
  54.    The simplest emacs command for calling ispell is 'M-$' (meta-dollar.
  55. On some terminals, you must type ESC-$.) This checks the spelling of
  56. the word under the cursor.  If the word is found in the dictionary,
  57. then a message is printed in the echo area.  Otherwise, ISPELL attempts
  58. to generate near misses.
  59.    If any near misses are found, they are displayed in a separate
  60. window, each preceded by a digit or character.  If one of these is the
  61. word you wanted, just type its digit or character, and it will replace
  62. the original word in your buffer.
  63.    If no near miss is right, or if none are displayed, you have five
  64. choices:
  65.      Insert the word in your private dictionary.  Use this if you know
  66.      that the word is spelled correctly.
  67.      Accept the word for the duration of this editing session, but do
  68.      not put it in your private dictionary.  Use this if you are not
  69.      sure about the spelling of the word, but you do not want to look
  70.      it up immediately, or for terms that appear in your document but
  71.      are not truly words.  The next time you start ispell, it will have
  72.      forgotten any accepted words.
  73. `SPC'
  74.      Leave the word alone, and consider it misspelled if it is checked
  75.      again.
  76.      Replace the word.  This command prompts you for a string in the
  77.      minibuffer.  You may type more than one word, and each word you
  78.      type is checked again, possibly finding other near misses.  This
  79.      command provides a handy way to close in on a word that you have
  80.      no idea how to spell.  You can keep trying different spellings
  81.      until you find one that is close enough to get a near miss.
  82.      Lookup.  Display words from the dictionary that contain a
  83.      specified substring.  The substring is a regular expression, which
  84.      means it can contain special characters to be more selective about
  85.      which words get displayed.  *Note Regexps: (emacs)Regexps.
  86.      If the only special character in the regular expression is a
  87.      leading `^', then a very fast binary search will be used, instead
  88.      of scanning the whole file.
  89.      Only a few matching words can be displayed in the ISPELL window.
  90.      If you want to see more, use the `look' program directly from the
  91.      shell.
  92.    Of course, you can also type 
  93. G' to stop the command without
  94. changing anything.
  95.    If you make a change that you don't like, just use emacs' normal undo
  96. feature *Note undo: (emacs)undo.
  97. File: ispell,  Node: Buffer,  Next: Region,  Prev: Word,  Up: Emacs
  98. Checking a whole buffer
  99. -----------------------
  100.    If you want to check the spelling of all the words in a buffer, type
  101. the command `M-x ispell-buffer'.  This command scans the file, and makes
  102. a list of all the misspelled words.  When it is done, it moves the
  103. cursor to the first word on the list, and acts like you just typed M-$
  104. *Note Word::.
  105.    When you finish with one word, the cursor is automatically moved to
  106. the next.  If you want to stop in the middle of the list type `X' or
  107. File: ispell,  Node: Region,  Next: Multiple Dictionaries,  Prev: Buffer,  Up: Emacs
  108. Checking a region
  109. -----------------
  110.    You may check the words in the region with the command `M-x
  111. ispell-region'.  See *Note mark: (emacs)mark.
  112.    The commands available are the same as for checking a whole buffer.
  113. File: ispell,  Node: Multiple Dictionaries,  Prev: Region,  Up: Emacs
  114. Using Multiple Dictionaries
  115. ---------------------------
  116.    Your site may have multiple dictionaries installed: a default one
  117. (usually `english.hash'), and several others for different languages
  118. (e.g. `deutsch.hash') or variations on a language (such as British
  119. spelling for English).
  120. `ispell-change-dictionary'
  121.      This is the command to change the dictionary.  It prompts for a new
  122.      dictionary name, with completion on the elements of
  123.      `ispell-dictionary'.
  124.      It changes `ispell-dictionary' and kills the old ispell process, if
  125.      one was running.  A new one will be started as soon as necessary.
  126.      By just answering `RET' you can find out what the current
  127.      dictionary is.
  128. `ispell-dictionary'
  129.      If non-nil, a dictionary to use instead of the default one.  This
  130.      is passed to the ispell process using the `-d' switch and is used
  131.      as key in `ispell-dictionary-alist'.
  132.      You should set this variable before your first call to ispell
  133.      (e.g. in your `.emacs'), or use the `M-x ispell-change-dictionary'
  134.      command to change it, as changing this variable only takes effect
  135.      in a newly started ispell process.
  136. `ispell-dictionary-alist'
  137.      An alist of dictionaries and their associated parameters.
  138.      Each element of this list is also a list:
  139.           (DICTIONARY-NAME
  140.               CASECHARS NOT-CASECHARS OTHERCHARS MANY-OTHERCHARS-P
  141.               ISPELL-ARGS)
  142.      DICTIONARY-NAME is a possible value of variable
  143.      `ispell-dictionary', `nil' means the default dictionary.
  144.      CASECHARS is a regular expression of valid characters that
  145.      comprise a word.
  146.      NOT-CASECHARS is the opposite regexp of CASECHARS.
  147.      OTHERCHARS is a regular expression of other characters that are
  148.      valid in word constructs.  Otherchars cannot be adjacent to each
  149.      other in a word, nor can they begin or end a word.  This implies
  150.      we can't check `Stevens'' as a correct possessive and other correct
  151.      formations.
  152.      Hint: regexp syntax requires the hyphen to be declared first here.
  153.      MANY-OTHERCHARS-P is non-nil if many otherchars are to be allowed
  154.      in a word instead of only one.
  155.      ISPELL-ARGS is a list of additional arguments passed to the ispell
  156.      subprocess.
  157.      Note that the CASECHARS and OTHERCHARS slots of the alist should
  158.      contain the same character set as casechars and otherchars in the
  159.      LANGUAGE`.aff' file (e.g., `english.aff').
  160. File: ispell,  Node: Old Emacs,  Next: Private,  Prev: Emacs,  Up: Top
  161. Old Emacs
  162. =========
  163.    Until ispell becomes part of the standard emacs distribution, you
  164. will have to explicitly request that it be loaded.  Put the following
  165. lines in your emacs init file *Note init file: (emacs)init file.
  166.      (autoload 'ispell-word "ispell" "Check the spelling of word in buffer." t)
  167.      (autoload 'ispell-region "ispell" "Check the spelling of region." t)
  168.      (autoload 'ispell-buffer "ispell" "Check the spelling of buffer." t)
  169.      (global-set-key "\e$" 'ispell-word)
  170.    (It will do no harm to have these lines in your init file even after
  171. ispell is installed by default.)
  172. File: ispell,  Node: Private,  Next: Command summary,  Prev: Old Emacs,  Up: Top
  173. Your private dictionary
  174. =======================
  175.    Whenever ispell is started the file `.ispell_words' is read from
  176. your home directory (if it exists).  This file contains a list of words,
  177. one per line.  The order of the words is not important, but the case is.
  178. Ispell will consider all of the words good, and will use them as
  179. possible near misses.
  180.    The `I' command adds words to `.ispell_words', so normally you don't
  181. have to worry about the file.  You may want to check it from time to
  182. time to make sure you have not accidentally inserted a misspelled word.
  183. File: ispell,  Node: Command summary,  Next: Near misses,  Prev: Private,  Up: Top
  184. All commands in emacs mode
  185. ==========================
  186. `DIGIT'
  187.      Select a near miss
  188.      Insert into private dictionary
  189.      Accept for this session
  190. `SPC'
  191.      Skip this time
  192.      Replace with one or more words
  193.      Lookup: search the dictionary using a regular expression
  194. `M-$'
  195.      Check word
  196. `M-x ispell-buffer'
  197.      Check buffer
  198. `M-x ispell-region'
  199.      Check region
  200. `M-x ispell-change-dictionary'
  201.      Select different dictionary.
  202. File: ispell,  Node: Near misses,  Next: History,  Prev: Command summary,  Up: Top
  203. Definition of a near miss
  204. =========================
  205.    Two words are near each other if they can be made identical with one
  206. of the following changes to one of the words:
  207.      Insert a blank space
  208.      Interchange two adjacent letters.
  209.      Change one letter.
  210.      Delete one letter.
  211.      Add one letter.
  212.    Someday, perhaps ispell will be extended so that words that sound
  213. alike would also be considered near misses.  If you would like to
  214. implement this, see Knuth, Volume 3, page 392 for a description of the
  215. Soundex algorithm which might apply.
  216. File: ispell,  Node: History,  Prev: Near misses,  Up: Top
  217. Where it came from
  218. ==================
  219.    Ispell has a long and convoluted history.  Originally called SPELL,
  220. it was written by Ralph E. Gorin in 1971.  That version was written in
  221. assembly language for the DEC PDP-10 to run under the WAITS operating
  222. system at the Stanford Artificial Intelligence Laboratory.  Subsequent
  223. versions, also in PDP-10 assembly language, were developed for the BBN
  224. TENEX, MIT ITS, and DEC TOPS-10 and TOPS-20 operating systems.  It was
  225. later revised by W. E. Matson (1974), and W. B. Ackerman (1978),
  226. changing its name to ISPELL in the process.
  227.    In 1983, Pace Willisson (pace@ai.mit.edu) converted this version to
  228. the C language and modified it to work under Unix.
  229.    In 1987, Walt Buehring revised and enhanced ispell, and posted it to
  230. the Usenet along with a dictionary.  In addition, Walt wrote the first
  231. version of "ispell.el", the emacs interface.
  232.    Geoff Kuenning (geoff@ITcorp.com, that's me, and by the way I
  233. pronounce it "Kenning") picked up this version, fixed many bugs, and
  234. added further enhancements.  In 1988 I got ambitious and rewrote major
  235. portions of the code, resulting in the table-driven multi-lingual
  236. version.  Ken Stevens (stevens@hplabs.hp.com) made overwhelming
  237. contributions to the elisp support to produce the version you are using
  238.    Due to a misunderstanding involving the Free Software Foundation, it
  239. later became necessary to rename this version to ispell to avoid
  240. confusion on the part of users.
  241.    Many other enhancements and bug fixes were provided by other people.
  242. Although I omit mention here due to space, many of these people have
  243. also made significant contributions to the version of ispell you see
  244. here.  For a full list of people who have contributed to ispell, refer
  245. to the file `Contributors' which is distributed with the ispell sources.
  246. Geoff Kuenning
  247. geoff@ITcorp.com
  248. Tag Table:
  249. Node: Top
  250. Node: Emacs
  251. Node: Word
  252. Node: Buffer
  253. Node: Region
  254. Node: Multiple Dictionaries
  255. Node: Old Emacs
  256. Node: Private
  257. Node: Command summary
  258. Node: Near misses
  259. 10094
  260. Node: History
  261. 10731
  262. End Tag Table
  263.