manual/aspell.1

   1 .TH ASPELL 1 "2006-12-10" "GNU" "Aspell Abbreviated User's Manual"
   2 .SH NAME
   3 aspell \- interactive spell checker
   4 .SH SYNOPSIS
   5 .B aspell
   6 .I "[options] <command>"
   7 .br
   8 .SH "DESCRIPTION"
   9 .B aspell
  10 is a utility program that connects to the Aspell library so that it can
  11 function as an
  12 .B "ispell -a"
  13 replacement, as an independent spell checker, as a test utility to test
  14 out Aspell library features, and as a utility for managing dictionaries
  15 used by the library.
  16 .PP
  17 The Aspell library contains an interface allowing other programs direct
  18 access to its functions and therefore reducing the complex task of
  19 spell checking to simple library calls.  The default library does not
  20 contain dictionary word lists.  To add language dictionaries, please
  21 check your distro first for modified dictionaries, otherwise look here
  22 for base language dictionaries <http://aspell.net>.
  23 .PP
  24 The following information describes the commands and options used by the
  25 Aspell Utility.
  26 .PP
  27 This manual page is maintained separately from the
  28 official documentation so it may be out of date or incomplete.  The
  29 official documentation is maintained as a Texinfo manual.  See the
  30 .RB "`\|" aspell "\|'"
  31 entry in
  32 .B info
  33 for more complete documentation.
  34 .SH COMMANDS
  35 .I "<command>"
  36 is one of:
  37 .TP
  38 \fBusage\fR, \fB\-?\fR
  39 Send a brief Aspell Utility usage message to standard output.  This is
  40 a short summary listing more common spell\-check commands and options.
  41 .TP
  42 .B help
  43 Send a detailed Aspell Utility help message to standard output.  This is
  44 a complete list showing all commands, options, filters and dictionaries.
  45 .TP
  46 \fBversion\fR, \fB\-v\fR
  47 Print version number of Aspell Library and Utility to standard output.
  48 .TP
  49 \fBcheck\fR \fI<file>\fR, \fB\-c\fR \fI<file>\fR
  50 Spell\-check a single file.
  51 .TP
  52 \fBpipe\fR, \fB\-a\fR
  53 Run Aspell in
  54 .I "ispell -a"
  55 compatibility mode.
  56 .TP
  57 .B list
  58 Produce a list of misspelled words from standard input.
  59 .TP
  60 [\fBdump\fR] \fBconfig\fR
  61 Dump all current configuration options to standard output.
  62 .TP
  63 .BI "config " <key>
  64 Send the current value of
  65 .I <key>
  66 to standard output.
  67 .TP
  68 .B soundslike
  69 Output the soundslike equivalent of each word entered.
  70 .TP
  71 .B munch
  72 Generate possible root words and affixes from an input list of words.
  73 .TP
  74 \fBexpand\fR [\fB1\-4\fR]
  75 Expands the affix flags of each affix compressed word entered.
  76 .TP
  77 \fBclean\fR [\fBstrict\fR]
  78 Cleans an input word list so that every line is a valid word.
  79 .TP
  80 \fBmunch\-list\fR [\fBsimple\fR] [\fBsingle\fR|\fBmulti\fR] [\fBkeep\fR]
  81 Reduce the size of a word list via affix compression.
  82 .TP
  83 \fBconv\fR \fI<from> <to>\fR [\fI<norm-form>\fR]
  84 Converts
  85 .I <from>
  86 one encoding
  87 .I <to>
  88 another.
  89 .TP
  90 \fBnorm\fR (\fI<norm\-map>\fR|\fI<from> <norm\-map> <to>\fR) [\fI<norm-form>\fR]
  91 Perform Unicode normalization.
  92 .TP
  93 [\fBdump\fR] \fBdicts\fR|\fBfilters\fR|\fBmodes\fR
  94 Lists available dictionaries, filters, or modes.
  95 .TP
  96 \fBdump\fR|\fBcreate\fR|\fBmerge master\fR|\fBpersonal\fR|\fBrepl\fR \fI<wordlist>\fR
  97 dump, create, or merge a master, personal, or replacement word list.
  98 .SH DICTIONARY OPTIONS
  99 The following options may be used to control which dictionaries to use
 100 and how they behave.
 101 .TP
 102 \fB\-\-master=\fR\fI<name>\fR, \fB\-d\fR \fI<name>\fR
 103 Base name of the dictionary to use.  If this option is specified then
 104 Aspell will either use this dictionary or die.
 105 .TP
 106 \fB\-\-dict\-dir=\fR\fI<directory>\fR
 107 Location of the main dictionary word list.
 108 .TP
 109 \fB\-\-lang=\fR\fI<string>\fR, \fB\-l\fR \fI<string>\fR
 110 Language to use.  It follows the same format of the LANG environmental
 111 variable on most systems. It consists of the two letter ISO 639 language
 112 code and an optional two letter ISO 3166 country code after a dash or
 113 underscore. The default value is based on the value of the LC_MESSAGES
 114 locale.
 115 .TP
 116 \fB\-\-size=\fR\fI<string>\fR
 117 The preferred size of the dictionary word list.  This consists of a two
 118 char digit code describing the size of the list, with typical values of:
 119 10=tiny, 20=really small, 30=small, 40=med-small, 50=med, 60=med-large,
 120 70=large, 80=huge, 90=insane.
 121 .TP
 122 \fB\-\-variety=\fR\fI<string>\fR
 123 Any extra information to distinguish this variety of dictionary from
 124 other dictionaries which may have the same \fIlang\fR and \fIsize\fR.
 125 .TP
 126 \fB\-\-jargon=\fR\fI<string>\fR
 127 Please use the \fIvariety\fR option since it replaces \fIjargon\fR as a
 128 better choice.  \fIjargon\fR will be removed in the future.
 129 .TP
 130 \fB\-\-word\-list\-path=\fR\fI<list of directories>\fR
 131 Search path for word list information files.
 132 .TP
 133 \fB\-\-personal=\fR\fI<file>\fR, \fB\-p\fR \fI<file>\fR
 134 Personal word list file name.
 135 .TP
 136 \fB\-\-repl=\fR\fI<file>\fR
 137 Replacements list file name.
 138 .TP
 139 \fB\-\-extra\-dicts=\fR\fI<list>\fR
 140 Extra dictionaries to use.
 141 .TP
 142 \fB\-\-ignore\-accents\fR
 143 This option is not yet implemented.
 144 .SH CHECKER OPTIONS
 145 These options control the behavior of Aspell when checking documents.
 146 .TP
 147 \fB\-\-ignore=\fR\fI<integer>\fR, \fB\-W\fR \fI<integer>\fR
 148 Ignore words <=
 149 .I <integer>
 150 characters in length.
 151 .TP
 152 \fB\-\-ignore\-case\fR, \fB\-\-dont\-ignore\-case\fR
 153 Ignore case when checking words.
 154 .TP
 155 \fB\-\-ignore\-repl\fR, \fB\-\-dont\-ignore\-repl\fR
 156 Ignore commands to store replacement pairs.
 157 .TP
 158 \fB\-\-save\-repl\fR, \fB\-\-dont\-save\-repl\fR
 159 Save the replacement word list on save all.
 160 .TP
 161 \fB\-\-sug\-mode=\fR\fI<mode>\fR
 162 Suggestion
 163 .I <mode>
 164 \= \fBultra\fR|\fBfast\fR|\fBnormal\fR|\fBbad-spellers\fR
 165 .SH FILTER OPTIONS
 166 These options modify the behavior of the various filters.
 167 .TP
 168 \fB\-\-add\-filter=\fR\fI<list>\fR, \fB\-\-rem\-filter=\fR\fI<list>\fR
 169 Add or remove a filter.
 170 .TP
 171 \fB\-\-add\-filter\-path=\fR\fI<paths>\fR, \fB\-\-rem\-filter\-path=\fR\fI<paths>\fR
 172 Add or remove paths searched for filters.
 173 .TP
 174 \fB\-\-mode=\fR\fI<string>\fR, \fB\-e\fR, \fB\-H\fR, \fB\-t\fR, \fB\-n\fR
 175 Sets the filter mode.  \fIMode\fR is one of none, url, email, html, tex
 176 or nroff.  The alternative shortcut options are '-e' for email, '-H'
 177 for Html/Sgml, '-t' for Tex or '-n' for Nroff.
 178 .TP
 179 \fB\-\-encoding=\fR\fI<string>\fR
 180 encoding the document is expected to be in.  The default depends on the
 181 current locale.
 182 .TP
 183 \fB\-\-add-email\-quote=\fR\fI<list>\fR, \fB\-\-rem-email\-quote=\fR\fI<list>\fR
 184 Add or Remove a list of email quote characters.
 185 .TP
 186 \fB\-\-email\-margin=\fR\fI<integer>\fR
 187 Number of chars that can appear before the quote char.
 188 .TP
 189 \fB\-\-add\-html\-check=\fR\fI<list>\fR, \fB\-\-rem\-html\-check=\fR\fI<list>\fR
 190 Add or remove a list of HTML attributes to always check.  For example,
 191 look inside alt= tags.
 192 .TP
 193 \fB\-\-add\-html\-skip=\fR\fI<list>\fR, \fB\-\-rem\-html\-skip=\fR\fI<list>\fR
 194 Add or remove a list of HTML attributes to always skip while spell
 195 checking.
 196 .TP
 197 \fB\-\-add\-sgml\-check=\fR\fI<list>\fR, \fB\-\-rem\-sgml\-check=\fR\fI<list>\fR
 198 Add or remove a list of SGML attributes to always check for spelling.
 199 .TP
 200 \fB\-\-add\-sgml\-skip=\fR\fI<list>\fR, \fB\-\-rem\-sgml\-skip=\fR\fI<list>\fR
 201 Add or remove a list of SGML attributes to always skip while spell
 202 checking.
 203 .TP
 204 \fB\-\-sgml\-extension=\fR\fI<list>\fR
 205 SGML file extensions.
 206 .TP
 207 \fB\-\-tex\-check\-comments\fR, \fB\-\-dont\-tex\-check\-comments\fR
 208 Check TeX comments.
 209 .TP
 210 \fB\-\-add\-tex\-command=\fR\fI<list>\fR, \fB\-\-rem\-tex\-command=\fR\fI<list>\fR
 211 Add or Remove a list of TeX commands.
 212 .SH RUN\-TOGETHER WORD OPTIONS
 213 These may be used to control the behavior of run\-together words.
 214 .TP
 215 \fB\-\-run\-together\fR, \fB\-\-dont\-run\-together\fR, \fB\-C\fR, \fB\-B\fR
 216 Consider run\-together words valid.
 217 .TP
 218 \fB\-\-run\-together\-limit=\fR\fI<integer>\fR
 219 Maximum number of words that can be strung together.
 220 .TP
 221 \fB\-\-run\-together\-min=\fR\fI<integer>\fR
 222 Minimal length of interior words.
 223 .SH MISC OPTIONS
 224 Miscellaneous options that don't fall under any other category.
 225 .TP
 226 \fB\-\-conf=\fR\fI<file name>\fR
 227 Main configuration file.  This file overrides Aspell's global defaults.
 228 .TP
 229 \fB\-\-conf\-dir=\fR\fI<directory>\fR
 230 Location of main configuration file.
 231 .TP
 232 \fB\-\-data\-dir=\fR\fI<directory>\fR
 233 Location of language data files.
 234 .TP
 235 \fB\-\-keyboard=\fR\fI<keyboard>\fR
 236 Use this keyboard layout for suggesting possible words.  These spelling
 237 errors happen if a user accidently presses a key next to the intended
 238 correct key.
 239 .TP
 240 \fB\-\-local\-data\-dir=\fR\fI<directory>\fR
 241 Alternative location of language data files.  This directory is searched
 242 before data\-dir.
 243 .TP
 244 \fB\-\-home\-dir=\fR\fI<directory>\fR
 245 Directory Location for personal wordlist files.
 246 .TP
 247 \fB\-\-per\-conf=\fR\fI<file name>\fR
 248 Personal configuration file.  This file overrides options found in the
 249 global config file.
 250 .SH ASPELL UTILITY OPTIONS
 251 These options are part of the
 252 .I aspell
 253 Utility and work independently of the library.
 254 .TP
 255 \fB--backup\fR, \fB\-\-dont\-backup\fR, \fB\-b\fR, \fB\-x\fR
 256 The aspell utility creates a backup file by making a copy and appending
 257 .I .bak
 258 to file name.  This only applies when the command is
 259 .I check <file>
 260 and the backup file is only created if any spelling modifications take
 261 place.
 262 .TP
 263 \fB\-\-byte\-offsets\fR, \fB\-\-dont\-byte\-offsets\fR
 264 Use byte offsets instead of character offsets.
 265 .TP
 266 \fB\-\-guess\fR, \fB\-\-dont\-guess\fR, \fB\-m\fR, \fB\-P\fR
 267 Create missing root/affix combinations not in the dictionary in
 268 \fBpipe\fR mode.
 269 .TP
 270 \fB\-\-keymapping=aspell\fR, \fB\-\-keymapping=ispell\fR
 271 The keymapping to use, either
 272 .I aspell
 273 for the default mapping or
 274 .I ispell
 275 to use the same mapping that the Ispell utility uses.
 276 .TP
 277 \fB\-\-reverse\fR, \fB\-\-dont\-reverse\fR
 278 Reverse the order of the suggestions list in pipe mode.
 279 .TP
 280 \fB\-\-suggest\fR, \fB\-\-dont\-suggest\fR
 281 Suggest possible replacements in pipe mode. If false, Aspell will simply
 282 report the misspelling and make no attempt at suggestions or possible
 283 corrections.
 284 .TP
 285 \fB\-\-time\fR, \fB\-\-dont\-time\fR
 286 Time the load time and suggest a time in pipe mode.
 287 .PP
 288 In addition Aspell will try to make sense out of Ispell's command line
 289 options so that it can function as a drop in replacement for Ispell.  If
 290 Aspell is run without any command line options it will display a brief
 291 help screen and quit.
 292 .SH CONFIGURATION
 293 Aspell can accept options via global or personal configuration files so
 294 that you do not need to specify them each time at the command line.  The
 295 default global configuration file is
 296 .I "/etc/aspell.conf"
 297 or another file specified by option \fI\-\-conf\fR and is checked first.
 298 The default per user configuration file
 299 .I "~/.aspell.conf"
 300 located in the
 301 .B "$HOME"
 302 directory (or another file specified by option \fI\-\-per\-conf\fR) is
 303 checked next and overrides options set in the global config file.
 304 Options specified at either the command line or via an environmental
 305 variable override those specified by either configuration file.
 306 .PP
 307 Each line of the configuration file has the format:
 308 .PP
 309 .RS
 310 \fBoption\fR \fI[value]\fR
 311 .RE
 312 .PP
 313 where
 314 .B option
 315 is any one of the standard library options above without the leading
 316 dashes.  For example the following line will set the default language to
 317 Swiss German:
 318 .PP
 319 .RS
 320 .B lang de_CH
 321 .RE
 322 .PP
 323 There may be any number of spaces between the option and the value,
 324 however it can only be spaces, i.e. there is no '=' between the option
 325 name and the value.  Comments may also be included by preceding them
 326 with a '#' as anything from a '#' to a newline is ignored.  Blank lines
 327 are also allowed.  The \fI/etc/aspell.conf\fR file is a good example of
 328 how to set these options and the Aspell Manual has more detailed info.
 329 .SH SEE ALSO
 330 .PP
 331 .BR aspell\-import (1),
 332 .BR prezip\-bin (1),
 333 .BR run\-with\-aspell (1),
 334 .BR word\-list\-compress (1)
 335 .PP
 336 Aspell is fully documented in its Texinfo manual.  See the
 337 .RB "`\|" aspell "\|'"
 338 entry in
 339 .B info
 340 for more complete documentation.
 341 .SH SUPPORT
 342 Support for Aspell can be found on the Aspell mailing lists.
 343 Instructions for joining the various mailing lists (and an archive of
 344 them) can be found off the Aspell home page at <http://aspell.net>.
 345 Bug reports should be submitted via GitHub Issues rather than being
 346 posted to the mailing lists.
 347 .SH AUTHOR
 348 This manual page was written by Brian Nelson <pyro@debian.org> based
 349 on the Aspell User's Manual, Copyright \(co 2002 Kevin Atkinson.
 350 Updated Nov 2006 by Jose Da Silva <digital@joescat.com>, and Dec 2006
 351 by Kevin Atkinson <kevina@gnu.org>.
 352