home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD1.bin / gnu / info / ispell.info (.txt) < prev    next >
GNU Info File  |  1994-12-22  |  26KB  |  489 lines
  1. This is Info file ispell.info, produced by Makeinfo-1.55 from the input
  2. file ispell.texi.
  3.    This file documents GNU ISPELL, an interactive spelling corrector.
  4.    Copyright (C) 1990 Free Software Foundation, Inc.
  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. File: ispell.info,  Node: Top,  Next: License,  Prev: (dir),  Up: (dir)
  17.    `Ispell' is a program that helps you to correct typos in a file, and
  18. to find the correct spelling of words.  When presented with a word that
  19. is not in the dictionary, `ispell' attempts to find "near misses" that
  20. might include the word you meant.
  21.    This manual describes how to use ispell, as well as a little about
  22. its implementation.
  23. * Menu:
  24. * License::        Licensing information.
  25. * Emacs::        Using ispell from emacs
  26. * Standalone::        Using ispell by itself
  27. * Ask::            Using ispell to look up individual words
  28. * Private::        Your private dictionary
  29. * Compatibility::    Compatibility with the traditional spell program
  30. * Command summary::    All commands in emacs and standalone modes
  31. Implementation details:
  32. * Near misses::        Definition of a near miss
  33. * Arguments::        Flags to the ispell command
  34. * Interface::        How other programs can use ispell
  35. * Dictionary flags::    How the suffix stripper works
  36. * History::        Where it came from; authors
  37. File: ispell.info,  Node: License,  Next: Emacs,  Prev: Top,  Up: Top
  38. Licensing Information
  39. *********************
  40.    Ispell is "free"; this means that everyone is free to use it and
  41. free to redistribute it on a free basis.  Ispell is not in the public
  42. domain; it is copyrighted and there are restrictions on its
  43. distribution, but these restrictions are designed to permit everything
  44. that a good cooperating citizen would want to do.  What is not allowed
  45. is to try to prevent others from further sharing any version of ispell
  46. that they might get from you.
  47.    Specifically, we want to make sure that you have the right to give
  48. away copies of ispell, that you receive source code or else can get it
  49. if you want it, that you can change ispell or use pieces of it in new
  50. free programs, and that you know you can do these things.
  51.    To make sure that everyone has such rights, we have to forbid you to
  52. deprive anyone else of these rights.  For example, if you distribute
  53. copies of ispell, you must give the recipients all the rights that you
  54. have.  You must make sure that they, too, receive or can get the source
  55. code.  And you must tell them their rights.
  56.    Also, for our own protection, we must make certain that everyone
  57. finds out that there is no warranty for ispell.  If these programs are
  58. modified by someone else and passed on, we want their recipients to know
  59. that what they have is not what we distributed, so that any problems
  60. introduced by others will not reflect on our reputation.
  61.    The precise conditions of the licenses for ispell are found in the
  62. General Public Licenses.  The programs that are part of GNU Emacs are
  63. covered by the GNU Emacs copying terms (*note License:
  64. (emacs)License.), and other programs are covered by licenses that are
  65. contained in their source files.
  66. File: ispell.info,  Node: Emacs,  Next: Standalone,  Prev: License,  Up: Top
  67. Using ispell from emacs
  68. =======================
  69. * Menu:
  70. * Word::    Checking a single word
  71. * Buffer::    Checking a whole buffer
  72. * Region::    Checking a region
  73. * Old Emacs::    Using ispell with older versions of emacs
  74.         Look here if M-$ calls the old spell program in your emacs.
  75. File: ispell.info,  Node: Word,  Next: Buffer,  Prev: Emacs,  Up: Emacs
  76. Checking a single word
  77. ----------------------
  78.    The simplest emacs command for calling ispell is 'M-$' (meta-dollar.
  79. On some terminals, you must type ESC-$.) This checks the spelling of
  80. the word under the cursor.  If the word is found in the dictionary,
  81. then a message is printed in the echo area.  Otherwise, ISPELL attempts
  82. to generate near misses.
  83.    If any near misses are found, they are displayed in a separate
  84. window, each preceded by a digit.  If one of these is the word you
  85. wanted, just type its digit, and it will replace the original word in
  86. your buffer.
  87.    If no near miss is right, or if none are displayed, you have four
  88. choices:
  89.      Insert the word in your private dictionary.  Use this if you know
  90.      that the word is spelled correctly.
  91.      Accept the word for the duration of this editing session, but do
  92.      not put it in your private dictionary.  Use this if you are not
  93.      sure about the spelling of the word, but you do not want to look
  94.      it up immediately.  The next time you start ispell, it will have
  95.      forgotten any accepted words.  You can make it forget accepted
  96.      words at any time by typing `M-x reload-ispell'.
  97. `SPC'
  98.      Leave the word alone, and consider it misspelled if it is checked
  99.      again.
  100.      Replace the word.  This command prompts you for a string in the
  101.      minibuffer.  You may type more than one word, and each word you
  102.      type is checked again, possibly finding other near misses.  This
  103.      command provides a handy way to close in on a word that you have
  104.      no idea how to spell.  You can keep trying different spellings
  105.      until you find one that is close enough to get a near miss.
  106.      Lookup.  Display words from the dictionary that contain a
  107.      specified substring.  The substring is a regular expression, which
  108.      means it can contain special characters to be more selective about
  109.      which words get displayed.  *Note Regexps: (emacs)Regexps.
  110.      If the only special character in the regular express is a leading
  111.      `^', then a very fast binary search will be used, instead of
  112.      scanning the whole file.
  113.      Only a few matching words can be displayed in the ISPELL window.
  114.      If you want to see more, use the `look' program directly from the
  115.      shell.
  116.    Of course, you can also type
  117. G to stop the command without changing
  118. anything.
  119.    If you make a change that you don't like, just use emacs' normal undo
  120. feature *Note undo: (emacs)undo.
  121. File: ispell.info,  Node: Buffer,  Next: Region,  Prev: Word,  Up: Emacs
  122. Checking a whole buffer
  123. -----------------------
  124.    If you want to check the spelling of all the words in a buffer, type
  125. the command `M-x ispell'.  This command scans the file, and makes a
  126. list of all the misspelled words.  When it is done, it moves the cursor
  127. to the first word on the list, and acts like you just typed M-$ *Note
  128. Word::.
  129.    When you finish with one word, the cursor is automatically moved to
  130. the next.  If you want to stop in the middle of the list type `Q' or
  131. G'.  Later, you can pick up where you left off by typing `C-X $'.
  132. File: ispell.info,  Node: Region,  Next: Old Emacs,  Prev: Buffer,  Up: Emacs
  133. Checking a region
  134. -----------------
  135.    You may check the words in the region with the command M-x
  136. ispell-region.  See *Note mark: (emacs)mark.
  137.    The commands available are the same as for checking a whole buffer.
  138. File: ispell.info,  Node: Old Emacs,  Prev: Region,  Up: Emacs
  139. Old Emacs
  140. =========
  141.    Until ispell becomes part of the standard emacs distribution, you
  142. will have to explicitly request that it be loaded.  Put the following
  143. lines in your emacs init file *Note init file: (emacs)init file.
  144.      (autoload 'ispell "ispell" "Run ispell over buffer" t)
  145.      (autoload 'ispell-region "ispell" "Run ispell over region" t)
  146.      (autoload 'ispell-word "ispell" "Check word under cursor" t)
  147.      (define-key esc-map "$" 'ispell-word)
  148.    (It will do no harm to have these lines in your init file even after
  149. ispell is installed by default.)
  150. File: ispell.info,  Node: Standalone,  Next: Ask,  Prev: Emacs,  Up: Top
  151. Using ispell by itself
  152. ======================
  153.    To check the words in