Blob Blame History Raw
.TH ENCHANT-2 1
.SH NAME
Enchant \- a spellchecker
.SH SYNOPSIS
.ll +8
.B enchant-2
[\fB\-a\fR] [\fB\-d dict\fR] [\fB\-h\fR] [\fB\-l\fR] [\fB\-L\fR] [\fB\-v\fR]
.ll -8
.br
.SH DESCRIPTION
.B Enchant
is an ispell-compatible spellchecker.
.SS OPTIONS
.TP
.B "\-a"
List suggestions in ispell pipe mode format.
.TP
.B "\-d DICTIONARY"
Use the given dictionary.
.TP
.B "\-h"
Show short help.
.TP
.B "\-l"
List only the misspellings.
.TP
.B "\-L"
Include the line number in the output.
.TP
.B "\-v"
Prints the program's version.
.SH ENCHANT ORDERING FILE
Enchant uses global and per-user ordering files named \fIenchant.ordering\fR
to decide which spelling provider to use for particular languages.
The per-user file takes precedence.
.PP
The ordering file takes the form language_tag:<comma-separated list of spelling
providers>. To see what providers are available, run \fIenchant-lsmod-2\fR. '*' is
used to mean "use this ordering for all languages, unless instructed otherwise." For example:
.PP
*:aspell,hunspell
.br
en:aspell,hunspell
.br
en_GB:hunspell,aspell
.br
fr:hunspell,aspell
.SH FILES AND DIRECTORIES
Enchant looks in the following places for files, in decreasing order of precedence:
.TP
\fIENCHANT_CONFIG_DIR\fR
(If the environment variable is set.)
.TP
\fIXDG_CONFIG_HOME/enchant\fR (non-Windows systems)
Default: \fI~/.config/enchant\fR
.TP
\fICSIDL_LOCAL_APPDATA\\enchant\fR (Windows systems)
Default: \fIC:\\Documents and Settings\\\fRusername\fI\\Local Settings\\Application Data\\enchant
.TP
\fI${prefix}/share/enchant\fR
(Or the equivalent location relative to the enchant library for a relocatable build.)
.PP
Dictionaries are looked for in a subdirectory with the same name as the
provider; for example, \fI${prefix}/share/enchant/hunspell\fR and
\fI~/.config/enchant/hunspell\fR.
.PP
Some providers may also look in a standard system directory for their
dictionaries; the hunspell provider can be configured to do so at build
time.
.SH "SEE ALSO"
.BR aspell (1),
.BR enchant-lsmod-2 (1)
.SH "AUTHOR"
Written by Dom Lachowicz and Reuben Thomas.