home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 1 / GoldFishApril1994_CD1.img / d1xx / d101 / microspell / spell.mss < prev    next >
Text File  |  1987-09-05  |  4KB  |  98 lines
  1. @center[@b(Using MicroSPELL 1.0)]
  2. @center(Author:  Brian Straight)
  3.  
  4.  
  5. @u<Introduction>
  6.  
  7. MicroSPELL 1.0 is a compact, efficient, fast spelling checker for use
  8. both as a stand alone program, and with MicroEMACS v3.9 and above on
  9. many different computers.  This document briefly describes how to use
  10. MicroSPELL. 
  11.  
  12. @b<Command Syntax>
  13.  
  14. spell {<options>} <file> {<file>.........<file>}
  15.  
  16. The currently available options are:
  17. @begin(verbatim)
  18.  
  19. -d        debugging mode
  20. -e        use MicroEMACS to scan errors
  21. -u <fname>    use a user word list 
  22. -w        output a word list instead of a location list
  23. @end(verbatim)
  24.  
  25. @b<Example>
  26.  
  27.     Let's assume that you want to spell check a text file called
  28. text.txt which is on the @b{B} drive of your machine.  To invoke spell
  29. type:
  30.  
  31. @b[spell -e b:text.txt]
  32.  
  33.     Be patient.  It will take SPELL a short while to complete its
  34. setup procedure.  If would like to know more about what SPELL is doing
  35. at this point, you can set the debugging switch (@b[-d]} when you first
  36. invoke the program.  SPELL will then give you detailed information about
  37. what it is doing.
  38.  
  39.     When SPELL has finished checking your file against its internal
  40. dictionary, it will give you a brief report of how many suspect words
  41. it found, and then, since we used the @b(-e) switch, it will invoke
  42. MicroEMACS in order to scan through the suspect words.  Notice that the
  43. screen is very like the standard MicroEMACS screen, except that the
  44. function key window (if it is normally there) is now replaced by the
  45. SPELL functions and status window. 
  46.  
  47.     There are a number of elements in this function window that you
  48. need to be aware of.  On the top line, the "File" field lists which file
  49. the scan is currently on.  This is useful when many different files are
  50. spell checked together in one run (many file names can be put on the
  51. command line at once).  The first number is the current file, and the
  52. second number is the total number of files.
  53.  
  54.     The second field on the top line is the "Word" filed. This
  55. describes the current suspect word and the total number of suspect words
  56. in the current file.  This will give you an idea of how far throughout the
  57. file you have progressed during the scan.
  58.  
  59.     One at a time, each suspect word in the file is presented to you
  60. for you to decide on its disposition.  The suspect word is displayed,
  61. and the question "Option:" appears in the Dialog Window.  The options
  62. you have include:
  63.  
  64. @begin(verbatim)
  65. (S)kip        Skip this word, leaving it alone, and go on to the next.
  66.  
  67. (I)gnore    Ignore this word and all other occurences of this word
  68.         during this scan.
  69.  
  70. (C)hange    Change this word.  You will be asked to type a
  71.         replacement word.  This word will replace the original
  72.         and MicroEMACS will remember the replacement.
  73.  
  74. (D)efault    If you have already replaced an identical occurance
  75.    replace    of this suspect word, MicroEMACS will present the last
  76.         replacement as a "Default Replacement".  Picking this
  77.         option automatically replaces the suspect word with
  78.         this default word.
  79.  
  80. (G)lobal    When you first encounter a suspect word, if you wish
  81.     change    it to be replaced in the entire document, use this
  82.         option. You will be prompted for the replacement word.
  83.  
  84. (A)dd word    To a user dictionary.  This word will then be remembered
  85.         for the remander of the current scan, and also for all
  86.         future scans when that user dictionary is invoked.
  87.  
  88. (U)pper case    Add a word to a user dictionary in its current case.
  89.         This is good for names, proper nouns and acronyms.
  90.  
  91. (Q)uit        Finish the current scan, saving the file with the
  92.         already completed changes.
  93. @end(verbatim)
  94.  
  95. @i(Note: Scanning document files will be availible on the IBM 370 series
  96. under the CMS operating system in September 1987 using an XEDIT script). 
  97.  
  98.