aspell: The Options

1 
1 4.2 The Options
1 ===============
1 
1 The following is a list of available options broken down by category.
1 Each entry has the following format:
1 
1     OPTION[,SINGLE-LETTER-ABBREVIATION]
1           (TYPE) DESCRIPTION
1 
1    Where single letter options are specified as they would appear at the
1 command line, ie with the preceding dash.  Boolean single letter
1 options are specified in the following format:
1 
1      -<abbreviation to enable>|-<abbreviation to disable>
1 
1    OPTION is one of the following: _boolean_, _string_, _file_, _dir_,
1 _integer_, or _list_.
1 
1    _String_, _file_, _dir_, and _integer_ types are all value options
1 which can only take a specific type of value.
1 
1 4.2.1 Dictionary Options
1 ------------------------
1 
1 The following options may be used to control which dictionaries to use
1 an Appropriate Dictionary::):
1 
1 master,-d
1      (string) Base name of the dictionary to use.  If this option is
1      specified then Aspell will either use this dictionary or die.
1 
1 dict-dir
1      (dir) Location of the main word list.
1 
1 lang
1      (string) Language to use.  It follows the same format of the `LANG'
1      environment variable on most systems.  It consists of the two
1      letter ISO 639 language code and an optional two letter ISO 3166
1      country code after a dash or underscore.  The default value is
1      based on the value of the `LC_MESSAGES' locale.
1 
1 size
1      (string) The preferred size of the word list.  This consists of a
1      two char digit code describing the size of the list, with typical
1      values of: 10=tiny, 20=really small, 30=small, 40=med-small,
1      50=med, 60=med-large, 70=large, 80=huge, 90=insane.
1 
1 variety
1      (list) Any extra information to distinguish two different words
1      lists that have the same lang and size.
1 
1 word-list-path
1      (list) Search path for word list information files.
1 
1 personal,-p
1      (file) Personal word list file name.
1 
1 repl
1      (file) Replacements list file name.
1 
1 extra-dicts
1      (list) Extra dictionaries to use.
1 
1 dict-alias
1      (list) create dictionary aliases.  Each entry has the form `FROM
1      TO'.  Will override any system dictionaries that are present.
1 
1 
1 4.2.2 Encoding Options
1 ----------------------
1 
1 These options control the encoding the document is expected to be in and
1 how it is displayed.
1 
1 encoding
1      (string) The encoding the input text is in.  Valid values include,
1      but not limited to, `iso-8859-*', `utf-8', `ucs-2', `ucs-4'.  When
1      using the Aspell utility the default encoding is based on the
1      current locale.  Thus if your locale currently uses the `utf-8'
1      encoding than everything will be in UTF-8.  The `ucs-2' and
1      `ucs-4' encodings are intended to be used by other programs using
1      the Aspell library and is not supported by the Aspell utility.
1 
1 normalize
1      (boolean) Perform Unicode normalization.  Enabled by default.
1 
1 norm-strict
1      (boolean) Avoid lossy conversions when normalizing.  Lossy
1      conversions includes compatibility mappings such as splitting the
1      letter `OE' (U+152) into `O' and `E' (when the combined letter is
1      not available), and mappings which will remove accents.  Disabled
1      by default except when creating dictionaries.
1 
1 norm-form
1      (string) The normalization form the output should be in.  This
1      option primarily effects the normalization form of the suggestions
1      as when spell checkering as the actual text is unchanged unless
1      there is an error.  Valid values are `none', `nfd' for fully
1      decomposition (Normalization Form D), `nfc' for Normalization Form
1      C, or `comp' for fully composed.  `comp' is like `nfc' except that
1      _full_ composition is used rather than _canonical_ composition.
1      The `normalize' option must be enabled for this option to be used.
1 
1 norm-required
1      (boolean) Set to true when the current language requires Unicode
1      normalization.  This is generally the case when private use
1      characters are used internally by Aspell or when Normalization
1      Form C is not the same as full composition.
1 
1 
1 4.2.3 Checker Options
1 ---------------------
1 
1 These options control the behavior of Aspell when checking documents.
1 
1 ignore,-W
1      (integer) Ignore words with N characters or less
1 
1 ignore-repl
1      (boolean) Ignore commands to store replacement pairs.
1 
1 save-repl
1      (boolean) Save the replacement word list on save all.
1 
1 keyboard
1      Notes on Typo-Analysis::)
1 
1 sug-mode
1      (mode) Suggestion mode = `ultra' | `fast' | `normal' | `slow' |
1      `bad-spellers' (⇒Notes on the Different Suggestion Modes)
1 
1 ignore-case
1      (boolean) Ignore case when checking words.
1 
1 ignore-accents
1      (boolean) Ignore accents when checking words - _currently ignored_.
1 
1 
1 4.2.4 Filter Options
1 --------------------
1 
1 These options modify the behavior of the Aspell filter interface in
11 general (for more information see ⇒Notes on Various Filters and
 Filter Modes).
1 
1 filter
1      (list) filters to use
1 
1 filter-path
1      (list) Where to look when loading filter and filter modes.
1 
1 mode
1      (string) Sets the filter mode.  Possible values include, but not
1      limited to, `none', `url', `email', `sgml', or `tex'.  (The
1      shortcut options `-e' may be used for email, `-H' for HTML, or
1      `-t' for TeX).
1 
1 
1    These options belong to filters packaged along with Aspell standard
1 distribution.  These options may be prefixed by the keyword `f-' in
1 order to explicitly indicate that they are options recognized by a
1 filter and not by Aspell itself.
1 
1 4.2.4.1 email
1 .............
1 
1 This filter hides quoting characters and email preamble and other parts
1 of an email which need not to be spell checked.
1 
1 email-quote
1      (list) Email quote characters.
1 
1 email-margin
1      (integer) The number of characters that can appear before the
1      quote character
1 
1 4.2.4.2 html
1 ............
1 
1 This filter converts an HTML source file into a format which eases
1 spell checking of HTML texts by Aspell.
1 
1 html-check
1      (list) HTML attributes to always check, such as alt= (alternate
1      text).
1 
1 html-skip
1      (list) HTML tags to always skip the contents of, such as <script>.
1 
1 4.2.4.3 sgml
1 ............
1 
1 This filter is identical to the HTML filter except that its options has
1 different default values which are currently the empty list.
1 
1 4.2.4.4 tex/latex
1 .................
1 
1 This filter hides all LaTeX commands and corresponding parameters not
1 being readable text in LaTeX output from Aspell.
1 
1 tex-command
1      (list) TeX commands
1 
1 tex-check-comments
1      (boolean) check TeX comments
1 
1 
1 4.2.4.5 texinfo
1 ...............
1 
1 This filter hides all Texinfo commands from Aspell.  It can also hide
1 Texinfo parameters and environments not corresponding to readable text.
1 
1 texinfo-ignore
1      (list) Texinfo command to ignore the parameters of.
1 
1 texinfo-ignore-env
1      (list) Texinfo environments to ignore.
1 
1 
1 4.2.4.6 context
1 ...............
1 
1 This filter can be used to spell check source codes, HTML sources and
1 other texts which consist of different contexts.  These contexts must
1 be separated by pairs of unique delimiters.  The different contexts may
1 not be dependent upon each other except for initial context which is
1 assumed if not any other context applies.
1 
1 context-visible-first
1      (boolean) Switches the context which should be visible to Aspell.
1      Per default the initial context is assumed to be invisible as one
1      would expect when spell checking source files of programs where
1      relevant parts are contained in string constants and comments but
1      not in the remaining code.  If set to true the initial context is
1      visible while the delimited ones are hidden.
1 
1 add|rem-context-delimiters
1      (list) Add or remove pairs of delimiters.  This allows you to
1      specify the character, or sequences of characters, which should be
1      used to switch contexts and therefore have to be escaped by `\' if
1      they should appear literally.  The two delimiting chars belonging
1      to one pair have to be separated by a space character.  If
1      multiple pairs are specified by one `add|rem-context-delimiters'
1      call the different pairs have to be separated by a literal comma.
1      Per default the delimiters are set to C/C++ comment and string
1      constant delimiters.  If the end of line delimits a context than
1      this has to be indicated by the literal `\0' string.
1 
1 4.2.5 Run-together Word Options
1 -------------------------------
1 
1 These may be used to control the behavior of run-together words (for
1 Words::):
1 run-together,-C|-B
1      (boolean) consider run-together words valid
1 
1 run-together-limit
1      (integer) maximum number of words that can be strung together
1 
1 run-together-min
1      (integer) minimal length of interior words
1 
1 4.2.6 Miscellaneous Options
1 ---------------------------
1 
1 Miscellaneous other options that don't fall under any other category
1 conf
1      (file) Main configuration file.  This file overrides Aspell's
1      global defaults.
1 
1 conf-dir
1      (dir) location of main configuration file
1 
1 data-dir
1      (dir) location of language data files
1 
1 local-data-dir
1      (dir) alternative location of language data files.  This directory
1      is searched before `data-dir'.  It defaults to the same directory
1      the actual main word list is in (which is not necessarily
1      `dict-dir')
1 
1 home-dir
1      (dir) location for personal files
1 
1 per-conf
1      (file) personal configuration file.  This file overrides options
1      found in the global `conf' file
1 
1 keyboard
1      (file) use this keyboard layout for suggesting possible words.
1      These spelling errors happen if a user accidently presses a key
1      next to the intended correct key.  The default is keyboard
1      standard.  If you are creating documents, you may want to set it
1      according to your particular type of keyboard.  If spellchecking
1      documents created elsewhere, you might want to set this to the
1      keyboard type for that locale.  If you are not sure, just leave
1      this as standard
1 
1 prefix
1      (dir) prefix directory
1 
1 set-prefix
1      (boolean) set the prefix based on executable location (only works
1      on WIN32 and when compiled with `--enable-win32-relocatable')
1 
1 4.2.7 Aspell Utility Options
1 ----------------------------
1 
1 backup,-b|-x
1      (boolean) Create a backup file by appending `.bak' to the file
1      name.  This applies when the command is `check' and the backup
1      file is only created if any spelling modifications take place.
1 
1 time
1      (boolean) Time load time and suggest time in `pipe' mode.
1 
1 byte-offsets
1      (boolean) Use byte offsets instead of character offsets in `pipe'
1      mode.
1 
1 reverse
1      (boolean) Reverse the order of the suggestions list in `pipe' mode.
1 
1 keymapping
1      (string) the keymapping to use.  Either `aspell' for the default
1      mapping or `ispell' to use the same mapping that the Ispell utility
1      uses.
1 
1 guess
1      (boolean) make possible root/affix combinations not in the
1      dictionary in `pipe' mode.
1 
1 suggest
1      (boolean) Suggest possible replacements in `pipe' mode.  If false
1      Aspell will simply report the misspelling and make no attempt at
1      suggestions or possible corrections.
1