doc/enchant.1

   1 .PU
   2 .TH ENCHANT 1 "July 2006" enchant "Enchant Mini Help File"
   3 .SH NAME
   4 Enchant \- a spellchecker
   5 .SH SYNOPSIS
   6 .ll +8
   7 .B enchant
   8 [\fB\-a\fR] [\fB\-l\fR] [\fB\-L\fR] [\fB\-v\fR]
   9 .ll -8
  10 .br
  11 .SH DESCRIPTION
  12 .B Enchant
  13 is an ispell-compatible spellchecker.
  14 .SS OPTIONS
  15 .TP
  16 .B "\-a"
  17 List alternatives.
  18 .TP
  19 .B "\-l"
  20 List only the misspellings.
  21 .TP
  22 .B "\-L"
  23 Include the line number in the output.
  24 .TP
  25 .B "\-v"
  26 Prints the program's version.
  27 .SH ENCHANT ORDERING FILE
  28 Enchant has a global and a per-user ordering file named \fIenchant.ordering\fR.
  29 It lets the user specify which spelling backend to use for individual
  30 languages in the case when you care which backend gets used. The global
  31 file is located in \fI$(datadir)/enchant\fR and the per-user file is
  32 located in \fI~/.enchant\fR.
  33 The per-user file takes precedence, if found.
  34 .PP
  35 The ordering file takes the form language_tag:<comma-separated list of spelling
  36 backends>. I am currently aware of the following backends: aspell, myspell, ispell, uspell, hspell, voikko, and zemberek. '*' is
  37 used to mean "use this ordering for all languages, unless instructed otherwise." For example:
  38 .PP
  39 *:aspell,myspell,ispell
  40 .br
  41 en:aspell,myspell,ispell
  42 .br
  43 en_UK:myspell,aspell,ispell
  44 .br
  45 fr:myspell,ispell:aspell
  46 .SH DIRECTORIES IMPORTANT TO ENCHANT
  47 Unless configured otherwise, Enchant's Myspell, Ispell, and Uspell
  48 backends will look for dictionaries in directories specific to Enchant,
  49 and will not use your system-wide installed dictionaries. This is for
  50 pragmatic reasons since many distributions install these dictionaries
  51 into different locations.
  52 .PP
  53 Like the \fIenchant.ordering\fR file described above, Enchant looks in
  54 the global directory for these dictionaries and a per-user directory.
  55 The per-user directory takes precedence if it is found.
  56 Enchant looks for Myspell dictionaries in \fI$(datadir)/enchant/myspell\fR and \fI~/.enchant/myspell\fR.
  57 Enchant looks for Ispell dictionaries in \fI$(datadir)/enchant/ispell\fR and \fI~/.enchant/ispell\fR.
  58 Enchant looks for Uspell dictionaries in \fI$(datadir)/enchant/uspell\fR and \fI~/.enchant/uspell\fR.
  59 .PP
  60 Packagers and users may wish to make symbolic links to the system-wide dictionary directories. Or, preferably, use the --with-myspell-dir, --with-ispell-dir, and --with-uspell-dir 'configure' arguments.
  61 .SH MORE INFORMATION
  62 http://www.abisource.com/enchant/
  63 .SH "SEE ALSO"
  64 .BR aspell(1),
  65 .BR ispell(1),
  66 .SH "AUTHOR"
  67  Dom Lachowicz
  68  WEB: http://www.abisource.com/enchant/
  69  MAIL: domlachowicz@gmail.com