-->

Previous | Table of Contents | Next

Page 277

dangerous, since short misspellings may be missed. If you use this option a lot, you should probably make a last pass without it before you publish your document, to protect yourself against errors.

The _T option is used to specify a default formatter type for use in generating string characters. This switch overrides the default type determined from the filename. The type argument may be either one of the unique names defined in the language affix file (such as nroff) or a file suffix including the dot (for example, .tex). If no _T option appears and no type can be determined from the filename, the default string character type declared in the language affix file will be used.

The _l or list option to ispell is used to produce a list of misspelled words from the standard input.

The _a option is intended to be used from other programs through a pipe. In this mode, ispell prints a one-line version identification message, and then begins reading lines of input. For each input line, a single line is written to the standard output for each word checked for spelling on the line. If the word was found in the main dictionary, or your personal dictionary, then the line contains only a *. If the word was found through affix removal, then the line contains a +, a space, and the root word. If the word was found through compound formation (concatenation of two words, controlled by the _C option), then the line contains only a _.

If the word is not in the dictionary, but there are near misses, then the line contains an &, a space, the misspelled word, a space, the number of near misses, the number of characters between the beginning of the line and the beginning of the misspelled word, a colon, another space, and a list of the near misses separated by commas and spaces. Following the near misses (and identified only by the count of near misses), if the word could be formed by adding (illegal) affixes to a known root, is a list of suggested derivations, again separated by commas and spaces. If there are no near misses at all, the line format is the same, except that the & is replaced by ? (and the near-miss count is always zero). The suggested derivations following the near misses are in the form:


[prefix+] root [-prefix] [-suffix] [+suffix]

(for example, "re+fry-y+ies" to get "refries") where each optional pfx and sfx is a string. Also, each near miss or guess is capitalized the same as the input word unless such capitalization is illegal; in the latter case each near miss is capitalized correctly according to the dictionary.

Finally, if the word does not appear in the dictionary, and there are no near misses, then the line contains a #, a space, the misspelled word, a space, and the character offset from the beginning of the line. Each sentence of text input is terminated with an additional blank line, indicating that ispell has completed processing the input line.

These output lines can be summarized as follows:

OK: *
Root: + <root>
Compound: _
Miss: & <original><count><offset>: <miss>, <miss>, ..., <guess>, ...
Guess: ? <original> 0 <offset>: <guess>, <guess>, ...
None: # <original> <offset>

For example, a dummy dictionary containing the words fray, Frey, fry, and refried might produce the following response to the command echo `frqy refries | ispell -a -m -d ./test.hash:


(#) International Ispell Version 3.0.05 (beta), 08/10/91

& frqy 3 0: fray, Frey, fry

& refries 1 5: refried, re+fry-y+ies

This mode is also suitable for interactive use when you want to figure out the spelling of a single word.

The _A option works just like _a, except that if a line begins with the string "&Include File&", the rest of the line is taken as the name of a file to read for further words. Input returns to the original file when the include file is exhausted. Inclusion may be nested up to five deep. The key string may be changed with the ENVIRONMENT variable INCLUDE_STRING (the ampersands, if any, must be included).

Previous | Table of Contents | Next