1hunspell(1) General Commands Manual hunspell(1)
2
6 hunspell - spell checker, stemmer and morphological analyzer
7
9 hunspell [-1 -a -G -h -H -l -L -m -n -t] [-d dic] [-p ] [files(s)]
10
12 Hunspell is fashioned after the Ispell program. The most common usage
13 is "hunspell filename". In this case, hunspell will display each word
14 which does not appear in the dictionary at the top of the screen and
15 allow you to change it. If there are "near misses" in the dictionary
16 (words which differ by only a single letter, a missing or extra letter,
17 a pair of transposed letters, a missing space or hyphen, or a special
18 string pair), then they are also displayed on following lines. As well
19 as "near misses", ispell may display other guesses at ways to make the
20 word from a known root, with each guess preceded by question marks.
21 Finally, the line containing the word and the previous line are printed
22 at the bottom of the screen. If your terminal can display in reverse
23 video, the word itself is highlighted. You have the option of
24 replacing the word completely, or choosing one of the suggested words.
25 Commands are single characters as follows (case is ignored):
26 R Replace the misspelled word completely.
28 Space Accept the word this time only.
30 A Accept the word for the rest of this hunspell session.
32 I Accept the word, capitalized as it is in the file, and
34 update private dictionary.
35 U Accept the word, and add an uncapitalized (actually, all
37 lower-case) version to the private dictionary.
38 0-n Replace with one of the suggested words.
40 L Look up words in system dictionary (controlled by the
42 WORDS compilation option).
43 X Write the rest of this file, ignoring misspellings, and
45 start next file.
46 Q Exit immediately and leave the file unchanged.
48 ! Shell escape (not implemented).
50 ^L Redraw screen.
52 ^Z Suspend ispell.
54 ? Give help screen.
56
58 -t The input file is in TeX or LaTeX format.
59 -n The input file is in nroff/troff format.
61 -H The input file is in SGML/HTML format.
63 The -l or "list" option to hunspell is used to produce a list of
66 misspelled words from the standard input.
67 The -a option is intended to be used from other programs through a
69 pipe. In this mode, hunspell prints a one-line version identification
70 message, and then begins reading lines of input. For each input line,
71 a single line is written to the standard output for each word checked
72 for spelling on the line. If the word was found in the main
73 dictionary, or your personal dictionary, then the line contains only a
74 '*'. If the word was found through affix removal, then the line
75 contains a '+', a space, and the root word. If the word was found
76 through compound formation (concatenation of two words, then the line
77 contains only a '-'.
78 If the word is not in the dictionary, but there are near misses, then
80 the line contains an '&', a space, the misspelled word, a space, the
81 number of near misses, the number of characters between the beginning
82 of the line and the beginning of the misspelled word, a colon, another
83 space, and a list of the near misses separated by commas and spaces.
84 Following the near misses (and identified only by the count of near
85 misses), if the word could be formed by adding (illegal) affixes to a
86 known root, is a list of suggested derivations, again separated by
87 commas and spaces.
88 Also, each near miss or guess is capitalized the same as the input word
90 unless such capitalization is illegal; in the latter case each near
91 miss is capitalized correctly according to the dictionary.
92 Finally, if the word does not appear in the dictionary, and there are
94 no near misses, then the line contains a '#', a space, the misspelled
95 word, a space, and the character offset from the beginning of the line.
96 Each sentence of text input is terminated with an additional blank
97 line, indicating that hunspell has completed processing the input line.
98 These output lines can be summarized as follows:
100 OK: *
102 Root: + <root>
104 Compound:
106 -
107 Miss: & <original> <count> <offset>: <miss>, <miss>, ...,
109 <guess>, ...
110 Guess: ? <original> 0 <offset>: <guess>, <guess>, ...
112 None: # <original> <offset>
114 For example, a dummy dictionary containing the words "fray", "Frey",
116 "fry", and "refried" might produce the following response to the
117 command "echo 'frqy refries | hunspell -a -m -d ./test.hash":
118 (#) Hunspell 0.4.1 (beta), 2005-05-26
119 & frqy 3 0: fray, Frey, fry
120 & refries 1 5: refried, re+fry-y+ies
121 This mode is also suitable for interactive use when you want to figure
123 out the spelling of a single word.
124 When in the -a mode, hunspell will also accept lines of single words
126 prefixed with any of '*', '&', '@', '+', '-', '~', '#', '!', '%', '`',
127 or '^'. A line starting with '*' tells hunspell to insert the word
128 into the user's dictionary (similar to the I command). A line starting
129 with '&' tells hunspell to insert an all-lowercase version of the word
130 into the user's dictionary (similar to the U command). A line starting
131 with '@' causes hunspell to accept this word in the future (similar to
132 the A command). A line starting with '+', followed immediately by tex
133 or nroff will cause hunspell to parse future input according the syntax
134 of that formatter. A line consisting solely of a '+' will place
135 hunspell in TeX/LaTeX mode (similar to the -t option) and '-' returns
136 hunspell to nroff/troff mode (but these commands are obsolete).
137 However, the string character type is not changed; the '~' command must
138 be used to do this. A line starting with '~' causes hunspell to set
139 internal parameters (in particular, the default string character type)
140 based on the filename given in the rest of the line. (A file suffix is
141 sufficient, but the period must be included. Instead of a file name or
142 suffix, a unique name, as listed in the language affix file, may be
143 specified.) However, the formatter parsing is not changed; the '+'
144 command must be used to change the formatter. A line prefixed with '#'
145 will cause the personal dictionary to be saved. A line prefixed with
146 '!' will turn on terse mode (see below), and a line prefixed with '%'
147 will return hunspell to normal (non-terse) mode. A line prefixed with
148 '`' will turn on verbose-correction mode (see below); this mode can
149 only be disabled by turning on terse mode with '%'.
150 Any input following the prefix characters '+', '-', '#', '!', '%', or
152 '`' is ignored, as is any input following the filename on a '~' line.
153 To allow spell-checking of lines beginning with these characters, a
154 line starting with '^' has that character removed before it is passed
155 to the spell-checking code. It is recommended that programmatic
156 interfaces prefix every data line with an uparrow to protect themselves
157 against future changes in hunspell.
158 To summarize these:
160 * Add to personal dictionary
162 @ Accept word, but leave out of dictionary
164 # Save current personal dictionary
166 ~ Set parameters based on filename
168 + Enter TeX mode
170 - Exit TeX mode
172 ! Enter terse mode
174 % Exit terse mode
176 ` Enter verbose-correction mode
178 ^ Spell-check rest of line
180 In terse mode, hunspell will not print lines beginning with '*', '+',
182 or '-', all of which indicate correct words. This significantly
183 improves running speed when the driving program is going to ignore
184 correct words anyway.
185 In verbose-correction mode, hunspell includes the original word
187 immediately after the indicator character in output lines beginning
188 with '*', '+', and '-', which simplifies interaction for some programs.
189 -d dic
192 Path of affix and dic files, without file extension.
193 -G
195 -h, --help
197 Short help.
198 -p custom_dictionary
200 Set path of custom dictionary. Default is
201 $HOME/.hunspell_default. Setting -d or the DICTIONARY
202 environmental variable, custom dictionary will be
203 $HOME/.hunspell_szótárnév
204 -u Print typical mistakes with suggestions.
206 -u2 List typical mistakes with suggestions to a sed files. Using of
208 this file:
209 sed -f correct.sed original.txt >corrected.txt
211
214 hunspell -d en_US english.html
215 hunspell -d /opt/OpenOffice.org1.0.1/share/dict/ooo/de_DE
217 hunspell *.html
219 hunspell -l text.html
221 hunspell -r *.html
223
225 DICTIONARY
226 Similar to -d.
227 WORDLIST
229 Equivalent to -p.
230
232 /usr/share/myspell/default.aff Path of default affix file. See
233 hunspell(4).
234 /usr/share/myspell/default.dic Path of default dictiorary file. See
236 hunspell(4). $HOME/.hunspell_default.Seehunspell(1).
237
239 hunspell (4), Magyar Ispell dokumentáció (Hungarian).
240
242 Hunspell based on Ispell's algorithms and OpenOffice.org's Myspell
243 source code.
244 Author of International Ispell is Geoff Kuenning.
246 Author of MySpell is Kevin Hendricks.
248 Author of Hunspell is László Németh.
250 This manual based on Ispell's manual (See ispell(1)).
252
254 Unicode tokenization haven't implemented yet.
255 Tokenize e-mail address, URL-s, paths. Put these character strings into
257 var element in HTML, and \url{pathl} in LaTeX.
258 2005-07-15 hunspell(1)