Penguin
Annotated edit history of aspell(1) version 4, including all changes. View license author blame.
Rev Author # Line
1 perry 1 ASPELL
2 !!!ASPELL
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 OPTIONS
7 CONFIGURATION
8 SEE ALSO
9 AUTHOR
10 ----
11 !!NAME
12
13
14 aspell - An interactive spell checker
15 !!SYNOPSIS
16
17
18 __aspell__ ''[[options] ''
19 !!DESCRIPTION
20
21
22 This manual page documents briefly the __aspell__
23 interactive spell checker. This manual page was written for
24 the Debian GNU/Linux distribution because the original
25 program does not have a manual page. Instead, it has
26 documentation in HTML and text formats; see
27 below.
28
29
30 __aspell__ is a utility that can function as a 'ispell
31 -a' replacement, as an independent spell checker, as a test
32 utility to test out Aspell features and as a utility for
33 managing dictionaries.
34 !!OPTIONS
35
36
37
38
39 __check __
40
41
42 to check a file
43
44
45 __pipe__
46
47
48 'ispell -a' compatible mode
49
50
51 __config__
52
53
54 dump the current configuration to stdout
55
56
57 __filter__
58
59
60 passes standard input through the same set of filters that
61 would be used to spell check a document
62
63
64 __help__
65
66
67 print online help
68
69
70 __version__
71
72
73 print version number and exit
74
75
76 __dump|create|merge master|personal|repl [[word
77 list]__
78
79
80 dump, creates or merges a master, personal or replacement
81 word list
82
83
84 [[options] is one of:
85
86
87 __--conf=__
88
89
90 main configuration file
91
92
93 __--conf-dir=__
94
95
96 directory containing the main configuration
97 file
98
99
100 __--data-dir=__
101
102
103 directory containing the language data files
104
105
106 __--dict-dir=__
107
108
109 directory containing the main word list
110
111
112 __--add|rem-filter=__
113
114
115 add or remove a filter
116
117
118 __--home-dir=__
119
120
121 directory containing personal configuration
122 files
123
124
125 __-W,--ignore=__
126
127
128 where n is an integer. Ignore words less than or equal to n
129 characters
130
131
132 __--[[dont-]ignore-case__
133
134
135 ignore case when checking words
136
137
138 __--[[dont-]ignore-repl__
139
140
141 ignore commands to store replacement pairs
142
143
144 __--lang=__
145
146
147 default language to use
148
149
150 __-d, --master=__
151
152
153 main word list base name
154
155
156 __--mode=__
157
158
159 set filter mode to str. Where str is one of - none, url,
160 email, sgml, tex
161
162
163 __-e, --mode=email__
164
165
166 enter email mode
167
168
169 __-H, --mode=sgml__
170
171
172 enter html/sgml mode
173
174
175 __-t, --mode=tex__
176
177
178 enter TEX mode
179
180
181 __--per-conf=__
182
183
184 personal configuration file
185
186
187 __--personal=__
188
189
190 personal word list file
191
192
193 __--repl=__
194
195
196 replacements list file name
197
198
199 __--sug-mode=__
200
201
202 suggestion mode. Where mode is one of - fast, normal,
203 bad-spellers
204
205
206 Plus options to modify the behavior of the various
207 filter:
208
209
210 __--add|rem-email-quote=__
211
212
213 email quote characters
214
215
216 __--email-margin=__
217
218
219 number of characters that can appear before the quote
220 character
221
222
223 __--add|rem-sgml-check=__
224
225
226 add or remove SGML tags to always check
227
228
229 __--add|rem-sgml-extension=__
230
231
232 add or remove SGML file extensions
233
234
235 __--add|rem-tex-command=__
236
237
238 add or remove TEX commands
239
240
241 __--add|rem-tex-check-comments=__
242
243
244 check TEX comments
245
246
247 In addition, there are some aspell utility specific
248 options:
249
250
251 __-b,--backup__
252
253
254 create a backup file by appending .bak to the file name.
255 (Only applies when the command is check)
256
257
258 __-x, --dont-backup__
259
260
261 dont create backup file
262
263
264 __--[[dont-]time__
265
266
267 [[dont] time load time and suggest time in pipe
268 mode
269
270
271 __--[[dont-]reverse__
272
273
274 [[dont] reverse the order of the suggestions
275 list
276
277
278 In addition aspell will try to make sense out of ispell's
279 command line options so that it can function as a drop in
280 replacement for ispell. If aspell is run without any command
281 line options it will display a brief help screen and
282 quit.
283 !!CONFIGURATION
284
285
286 aspell can also make use of a global or user configuration
287 file. Each line of the configuration file has the
288 format:
289
290
291 ____
292
293
294 where
295
296
297 __lang german__
298
299
300 Anything after a '#' on a line is ignored. Use 'aspell dump
301 config' to find out how your installation of aspell is
302 configured. The environment variable ASPELL_CONF may also be
303 used and it overrides any option set in the config file. The
304 format of the string is exactly the same as the
305 configuration file except that semicolons (';') are used as
306 delimiters instead if newlines.
307
308
309 The global configuration file for aspell is
310 ''/etc/aspell.conf'' and the per user configuration file
311 is ''~/.aspell.conf''
312 !!SEE ALSO
313
314
4 perry 315 run-with-aspell(1),
316 word-list-compress(1).
1 perry 317
318
319 aspell is fully documented in the aspell-doc package.
320 Install that package and see
321 ''/usr/share/doc/aspell-doc/man-html'' and
322 ''/usr/share/doc/aspell-doc/man-text''.
323 !!AUTHOR
324
325
326 This manual page was written by Sudhakar Chandrasekharan
327 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.