is a utility program that connects to the Aspell library so that it can
function as an
replacement, as an independent spell checker, as a test utility to test
out Aspell library features, and as a utility for managing dictionaries
used by the library.
The Aspell library contains an interface allowing other programs direct
access to it's functions and therefore reducing the complex task of
spell checking to simple library calls. The default library does not
contain dictionary word lists. To add language dictionaries, please
check your distro first for modified dictionaries, otherwise look here
for base language dictionaries <http://aspell.net>.
The following information describes the commands and options used by the
This manual page is maintained separately from the
official documentation so it may be out of date or incomplete. The
official documentation is maintained as a Texinfo manual. See the
for more complete documentation.
is one of:
Send a brief Aspell Utility usage message to standard output. This is
a short summary listing more common spell-check commands and options.
Send a detailed Aspell Utility help message to standard output. This is
a complete list showing all commands, options, filters and dictionaries.
Print version number of Aspell Library and Utility to standard output.
Spell-check a single file.
Run Aspell in
Produce a list of misspelled words from standard input.
Dump all current configuration options to standard output.
I config <key>
Send the current value of
to standard output.
Output the soundslike equivalent of each word entered.
Generate possible root words and affixes from an input list of words.
Expands the affix flags of each affix compressed word entered.
Cleans an input word list so that every line is a valid word.
munch-list [simple] [single|multi] [keep]
Reduce the size of a word list via affix compression.
dump, create, or merge a master, personal, or replacement word list.
The following options may be used to control which dictionaries to use
and how they behave.
Base name of the dictionary to use. If this option is specified then
Aspell will either use this dictionary or die.
Location of the main dictionary word list.
Language to use. It follows the same format of the LANG environmental
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
The preferred size of the dictionary word list. This consists of a two
char digit code describing the size of the list, with typical values of:
10=tiny, 20=really small, 30=small, 40=med-small, 50=med, 60=med-large,
70=large, 80=huge, 90=insane.
Any extra information to distinguish this variety of dictionary from
other dictionaries which may have the same lang and size.
Please use the variety option since it replaces jargon as a
better choice. jargon will be removed in the future.
--word-list-path=<list of directories>
Search path for word list information files.
Personal word list file name.
Replacements list file name.
Extra dictionaries to use.
This option is not yet implemented.
These options control the behavior of Aspell when checking documents.
These may be used to control the behavior of run-together words.
--run-together, --dont-run-together, -C, -B
Consider run-together words valid.
Maximum number of words that can be strung together.
Minimal length of interior words.
Miscellaneous options that don't fall under any other category.
Main configuration file. This file overrides Aspell's global defaults.
Location of main configuration file.
Location of language data files.
Use this keyboard layout for suggesting possible words. These spelling
errors happen if a user accidently presses a key next to the intended
Alternative location of language data files. This directory is searched
Directory Location for personal wordlist files.
Personal configuration file. This file overrides options found in the
global config file.
ASPELL UTILITY OPTIONS
These options are part of the
Utility and work independently of the library.
--backup, --dont-backup, -b, -x
The aspell utility creates a backup file by making a copy and appending
to file name. This only applies when the command is
and the backup file is only created if any spelling modifications take
Use byte offsets instead of character offsets.
--guess, --dont-guess, -m, -P
Create missing root/affix combinations not in the dictionary in
The keymapping to use, either
for the default mapping or
to use the same mapping that the Ispell utility uses.
Reverse the order of the suggestions list in pipe mode.
Suggest possible replacements in pipe mode. If false, Aspell will simply
report the misspelling and make no attempt at suggestions or possible
Time the load time and suggest a time in pipe mode.
In addition Aspell will try to make sense out of Ispell's command line
options so that it can function as a drop in replacement for Ispell. If
Aspell is run without any command line options it will display a brief
help screen and quit.
Aspell can accept options via global or personal configuration files so
that you do not need to specify them each time at the command line. The
default global configuration file is
or another file specified by option --conf and is checked first.
The default per user configuration file
located in the
directory (or another file specified by option --per-conf) is
checked next and overrides options set in the global config file.
Options specified at either the command line or via an environmental
variable override those specified by either configuration file.
Each line of the configuration file has the format:
is any one of the standard library options above without the leading
dashes. For example the following line will set the default language to
There may be any number of spaces between the option and the value,
however it can only be spaces, i.e. there is no '=' between the option
name and the value. Comments may also be included by preceding them
with a '#' as anything from a '#' to a newline is ignored. Blank lines
are also allowed. The /etc/aspell.conf file is a good example of
how to set these options and the Aspell Manual has more detailed info.
Aspell is fully documented in its Texinfo manual. See the
for more complete documentation.
Support for Aspell can be found on the Aspell mailing lists.
Instructions for joining the various mailing lists (and an archive of
them) can be found off the Aspell home page at <http://aspell.net>.
Bug reports should be submitted via the Sourceforge Tracker rather
than being posted to the mailing lists.
This manual page was written by Brian Nelson <firstname.lastname@example.org> based
on the Aspell User's Manual, Copyright 2002 Kevin Atkinson.
Updated Nov 2006 by Jose Da Silva <email@example.com>, and Dec 2006
by Kevin Atkinson <firstname.lastname@example.org>.