home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: Product / Product.zip / ISPELL.ZIP / ISPELL.MAN < prev   
Text File  |  1991-05-24  |  6KB  |  113 lines
  1. ISPELL - Correct spelling for a file
  2.  
  3. SYNOPSIS
  4.  
  5.     ispell [ -x | -d file | -p file | -w chars ] file .....
  6.     ispell [ -d file | -p file | -w chars ] -l
  7.     ispell [ -d file | -p file ] -a
  8.  
  9. DESCRIPTION
  10.  
  11.     Ispell is fashioned after the spell program from ITS (called ispell
  12.     on Twenex systems.)  The most common usage is "ispell filename".  In
  13.     this case, ispell will display each word which does not appear in the
  14.     dictionary, and allow you to change it.  If there are "near misses"
  15.     in the dictionary (words which differ by only a single letter, a
  16.     missing or extra letter, or a pair of transposed letters), then they
  17.     are also displayed.  If you think the word is correct as it stands,
  18.     you can type either "Space" to accept it this one time, or "I" to
  19.     accept it and put it in your private dictionary.  If one of the near
  20.     misses is the word you want, type the corresponding number.  Finally,
  21.     if none of these choices is right, you can type "R" and you will be
  22.     prompted for a replacement word.
  23.  
  24.     When a misspelled word is found, it is printed at the top of the screen.
  25.     Any near misses will be printed on the following lines, and finally, two
  26.     lines containing the word are printed at the bottom of the screen.  If
  27.     your terminal can type in reverse video, the word itself is highlighted.
  28.  
  29.     The -l or "list" option to ispell is used to produce a list of misspelled
  30.     words from the standard input.
  31.  
  32.     The -a is intended to be used from other programs through a pipe.  In
  33.     this mode, ispell expects the standard input to consist of single words.
  34.     Each word is read, and a single line is written to the standard output.
  35.     If the word was found in the main dictionary, or your personal dictionary,
  36.     then the line contains only a '*'.  If the word was found through suffix
  37.     removal, then the line contains a '+', a space, and the root word.  If
  38.     the word is not in the dictionary, but there are near misses, then the
  39.     line contains an '&', a space, and a list of the near misses separated by
  40.     spaces.  Also, each near miss is capitalized the same as the input words.
  41.     Finally, if the word neither appears in the dictionary, and there are no
  42.     near misses, then the line contains only a '#'.  This mode is also
  43.     suitable for interactive use when you want to figure out the spelling of
  44.     a single word.  (These characters are the same as the codes that the real
  45.     spell program uses.)
  46.  
  47.     The -x option causes ispell to remove the .bak file that it normally
  48.     leaves.  The .bak file contains the pre-corrected text.  If there are
  49.     file opening / writing errors, the .bak file may be left for recovery
  50.     purposes even with the -x option.
  51.  
  52.     The -d option is used to specify an alternate hashed dictionary file,
  53.     other than the default.  If the filename does not begin with a "/",
  54.     the library directory for the default dictionary file is prefixed.
  55.     This is useful to allow dictionaries which prefer alternate british
  56.     spellings ("centre", "tyre", etc), or add lists of special-purpose
  57.     jargon and acronyms for subclasses of documents.  There are some
  58.     shortcomings in attempting to provide foreign-language dictionaries,
  59.     but something like "-dfrench" could be made to work somewhat.
  60.  
  61.     The -p option is used to specify an alternate personal dictionary file.
  62.     If the file name does not begin with "/", $HOME is prefixed.  Also, the
  63.     shell variable WORDLIST may be set, which renames the personal dictionary
  64.     in the same manner.  The command line overrides WORDLIST setting.  If
  65.     neither is present "ispell.wrd" is used.
  66.  
  67.     The -w option may be used to specify characters other than alphabetics
  68.     which may also appear in words.  For instance, -w "&" will allow "AT&T"
  69.     to be picked up.  Underscores are useful in many technical documents.
  70.     There is an admittedly crude provision in this option for 8-bit
  71.     international characters.  If "n" appears in the character string, the
  72.     three characters following are a DECIMAL code 0 - 255, for the character.
  73.     There must be three decimal characters in all cases, so you have to prepend
  74.     with 0's, for instance, to include bells and formfeeds in your words (an
  75.     admittedly silly thing to do, but aren't most pedagogical examples):
  76.  
  77.             n007n012
  78.  
  79.     Numeric digits other than the three following "n" are simply numeric
  80.     characters.  Use of "n" does not conflict with anything because actual
  81.     alphabetics have no meaning - alphabetics are already accepted.
  82.     Ispell will typically be used with input from a file, meaning that
  83.     preserving parity for possible 8 bit characters from the input text is
  84.     OK.  If you specify the -l option, and actually type text from the
  85.     terminal, this may create problems if your stty settings preserve parity.
  86.  
  87.     It is possible to install ispell in such a way as to only support ASCII
  88.     range text if desired.
  89.  
  90. DEFAULT FILES
  91.  
  92.     ispell.hsh
  93.     ispell.wrd
  94.  
  95. BUGS
  96.  
  97.     Perhaps more than ten choices should be allowed for near misses.
  98.  
  99.     The hash table is stored as a quarter-megabyte array, so a PDP-11
  100.     version does not seem likely.
  101.  
  102.     Ispell should understand more troff syntax, and deal more
  103.     intelligently with contractions.
  104.  
  105.     While alternate dictionaries for foreign languages could be defined,
  106.     and the international characters included in words, rules concerning
  107.     word endings / pluralization accommodate english only.
  108.  
  109. AUTHOR
  110.  
  111.     Pace Willisson (pace@mit-vax)
  112.     Paul Coppinger (602/967-2563) (OS/2 & MSDOS port)
  113.