aspell: Through A Pipe

1 
1 6.2 Through A Pipe
1 ==================
1 
1 When given the `pipe' or `-a' command, Aspell goes into a pipe mode
1 that is compatible with `ispell -a'.  Aspell also defines its own set
1 of extensions to Ispell pipe mode.
1 
1 6.2.1 Format of the Data Stream
1 -------------------------------
1 
1 In this mode, Aspell prints a one-line version identification message,
1 and then begins reading lines of input.  For each input line, a single
1 line is written to the standard output for each word checked for
1 spelling on the line.  If the word was found in the main dictionary, or
1 your personal dictionary, then the line contains only a `*'.
1 
1    If the word is not in the dictionary, but there are suggestions, then
1 the line contains an `&', a space, the misspelled word, a space, the
1 number of near misses, the number of characters between the beginning
1 of the line and the beginning of the misspelled word, a colon, another
1 space, and a list of the suggestions separated by commas and spaces.
1 
1    If you set the option `run-together' and Aspell thinks this word is
1 a combination of two words in the dictionary, then it prints a single
1 `-' in one line.
1 
1    Finally, if the word does not appear in the dictionary, and there are
1 no suggestions, then the line contains a `#', a space, the misspelled
1 word, a space, and the character offset from the beginning of the line.
1 Each sentence of text input is terminated with an additional blank
1 line, indicating that Aspell has completed processing the input line.
1 
1    These output lines can be summarized as follows:
1 
1      *OK*: *
1      *Suggestions*: & original count offset: miss, miss, ...
1      *None*: # original offset
1 
1    When in the `-a' mode, Aspell will also accept lines of single words
1 prefixed with any of `*', `&', `@', `+', `-', `~', `#', `!', `%', or
1 `^'.  A line starting with `*' tells Aspell to insert the word into the
1 user's dictionary.  A line starting with `&' tells Aspell to insert an
1 all-lowercase version of the word into the user's dictionary.  A line
1 starting with `@' causes Aspell to accept this word in the future.  A
1 line starting with `+', followed immediately by a valid mode will cause
1 Aspell to parse future input according the syntax of that formatter.  A
1 line consisting solely of a `+' will place Aspell in TeX/LaTeX mode
1 (similar to the `-t' option) and `-' returns Aspell to its default mode
1 (which is Nroff unless otherwise specified).  (but these commands are
1 obsolete).  A line `~', is ignored for Ispell compatibility.  A line
1 prefixed with `#' will cause the personal dictionaries to be saved.  A
1 line prefixed with `!' will turn on terse mode (see below), and a line
1 prefixed with `%' will return Aspell to normal (non-terse) mode.  Any
1 input following the prefix characters `+', `-', `#', `!', `~', or `%'
1 is ignored, as is any input following.  To allow spell-checking of
1 lines beginning with these characters, a line starting with `^' has
1 that character removed before it is passed to the spell-checking code.
1 It is recommended that programmatic interfaces prefix every data line
1 with an uparrow to protect themselves against future changes in Aspell.
1 
1    To summarize these:
1 
1 `*WORD' Add a word to the personal dictionary
1 `&WORD' Insert the all-lowercase version of the word in the personal
1         dictionary
1 `@WORD' Accept the word, but leave it out of the dictionary
1 `#'     Save the current personal dictionary
1 `~'     Ignored for Ispell compatibility.
1 `+'     Enter TeX mode.
1 `+MODE' Enter the mode specified by MODE.
1 `-'     Enter the default mode.
1 `!'     Enter terse mode
1 `%'     Exit terse mode
1 `^'     Spell-check the rest of the line
1 
1    In terse mode, Aspell will not print lines beginning with `*', which
1 indicate correct words.  This significantly improves running speed when
1 the driving program is going to ignore correct words anyway.
1 
1    In addition to the above commands which are designed for Ispell
1 compatibility Aspell also supports its own extensions.  All Aspell
1 extensions follow the following format.
1 
1      $$COMMAND [DATA]
1 
1    Where DATA may or may not be required depending on the particular
1 command.  Aspell currently supports the following commands:
1 
1 `cs OPTION,VALUE'        Change a configuration option.
1 `cr OPTION'              Prints the value of a configuration option.
1 `pp'                     Returns a list of all words in the current
1                          personal wordlist.
1 `ps'                     Returns a list of all words in the current
1                          session dictionary.
1 `l'                      Returns the current language name.
1 `ra MIS,COR'             Add the word pair to the  replacement
1                          dictionary for later use. Returns nothing.
1 
1    Anything returned is returned on its own line.  All lists returned
1 have the following format
1 
1      num of items: item1, item2, etc
1 
1    _(Part of the preceding section was directly copied out of the
1 Ispell manual)_
1