Node: The Options, Next: Dumping Configuration Values, Previous: Specifying Options, Up: Customizing Aspell
The following is a list of available options broken down by category. Each entry has the following format:
- option[,single-letter-abbreviation]
- (type) description
Where single letter options are specified as they would appear at the command line, ie with the preceding dash. Boolean single letter options are specified in the following format:
-<abbreviation to enable>|-<abbreviation to disable>
option is one of the following: boolean, string, file, dir, integer, or list.
String, file, dir, and integer types are all value options which can only take a specific type of value.
The following options may be used to control which dictionaries to use and how they behave (for more information see How Aspell Selects an Appropriate Dictionary):
LANG
environment variable on most systems. It consists of the two letter
ISO 639 language code and an optional two letter
ISO 3166 country code after a dash or underscore. The
default value is based on the value of the LC_MESSAGES
locale.
from
to
. Will override any system dictionaries that are present.
These options control the encoding the document is expected to be in and how it is displayed.
iso-8859-*
, utf-8
, ucs-2
,
ucs-4
. When using the Aspell utility the default encoding is
based on the current locale. Thus if your locale currently uses the
utf-8
encoding than everything will be in UTF-8. The
ucs-2
and ucs-4
encodings are intended to be used by other
programs using the Aspell library and is not supported by the Aspell
utility.
OE
(U+152)
into O
and E
(when the combined letter is not available),
and mappings which will remove accents. Disabled by default except when
creating dictionaries.
none
, nfd
for fully decomposition
(Normalization Form D), nfc
for Normalization Form C, or
comp
for fully composed. comp
is like nfc
except
that full composition is used rather than canonical
composition. The normalize
option must be enabled for this
option to be used.
These options control the behavior of Aspell when checking documents.
ultra
| fast
| normal
| slow
|
bad-spellers
(see Notes on the Different Suggestion Modes)
These options modify the behavior of the Aspell filter interface in general (for more information see see Notes on Various Filters and Filter Modes).
none
, url
, email
, sgml
, or tex
. (The
shortcut options -e
may be used for email, -H
for
HTML, or -t
for TeX).
These options belong to filters packaged along with Aspell standard
distribution. These options may be prefixed by the keyword
f-
in order to explicitly indicate that they are options
recognized by a filter and not by Aspell itself.
This filter hides quoting characters and email preamble and other parts of an email which need not to be spell checked.
This filter converts an HTML source file into a format which eases spell checking of HTML texts by Aspell.
This filter is identical to the HTML filter except that it options has different default values which are currently the empty list.
This filter hides all LaTeX commands and corresponding parameters not being readable text in LaTeX output from Aspell.
This filter hides all Texinfo command from Aspell. It can also hide Texinfo paramaters and envirments not corresponding to readable text.
This filter can be used to spell check source codes, HTML sources and other texts which consist of different contexts. These contexts must be separated by pairs of unique delimiters. The different contexts may not be dependent upon each other except for initial context which is assumed if not any other context applies.
\
if
they should appear literally. The two delimiting chars belonging to
one pair have to be separated by a space character. If multiple pairs
are specified by one add|rem-context-delimiters
call the
different pairs have to be separated by a literal comma. Per default
the delimiters are set to C/C++ comment and string constant
delimiters. If the end of line delimits a context than this has to be
indicated by the literal \0
string.
These may be used to control the behavior of run-together words (for more information see Controlling the Behavior of Run-together Words):
Miscellaneous other options that don't fall under any other category
data-dir
. It defaults to the same directory
the actual main word list is in (which is not necessarily
dict-dir
).
--enable-win32-relocatable
)
.bak
to the file name. (Only
applies when the command is check
).
pipe
mode.
pipe
mode.
pipe
mode.
aspell
for the default mapping
or ispell
to use the same mapping that the Ispell utility
uses.
pipe
mode.
pipe
mode. If false Aspell
will simply report the misspelling and make no attempt at suggestions
or possible corrections.