File: `ispell.el.html`

INSTRUCTIONS

Use the variable ispell-local-dictionary-alist to specify
your own dictionaries.

Depending on the mail system you use, you may want to include these:
(add-hook 'news-inews-hook #'ispell-message)
(add-hook 'mail-send-hook #'ispell-message)
(add-hook 'mh-before-send-letter-hook #'ispell-message)

Ispell has a TeX parser and a nroff parser (the default).
The parsing is controlled by the variable ispell-parser. Currently it is just a "toggle" between TeX and nroff, but if more parsers are added it will be updated. See the variable description for more info.

TABLE OF CONTENTS

  ispell-word
  ispell-region
  ispell-buffer
  ispell-message
  ispell-comments-and-strings
  ispell-comment-or-string-at-point
  ispell-continue
  ispell-complete-word
  ispell-complete-word-interior-frag
  ispell-change-dictionary
  ispell-kill-ispell
  ispell-pdict-save
  ispell-skip-region-alist

Commands in ispell-region: Character replacement: Replace word with choice. May query-replace.
: Accept word this time.
i: Accept word and insert into personal dictionary. a: Accept word for this session. A: Accept word and place in buffer-local dictionary. r: Replace word with typed-in value. Rechecked. R: Replace word with typed-in value. Query-replaced in buffer. Rechecked.
?: Show these commands
x: Exit spelling buffer. Move cursor to original point. X: Exit spelling buffer. Leaves cursor at the current point, and permits
the check to be completed later.
q: Quit spelling session (Kills ispell process). l: Look up typed-in replacement in alternate dictionary. Wildcards okay. u: Like i, but the word is lower-cased first. m: Place entered value in personal dictionary, then recheck current word. C-l: redraws screen C-r: recursive edit C-z: suspend Emacs or iconify frame

Buffer-Local features: There are a number of buffer-local features that can be used to customize
ispell for the current buffer. This includes language dictionaries,
personal dictionaries, parsing, and local word spellings. Each of these
local customizations are done either through local variables, or by
including the keyword and argument(s) at the end of the buffer (usually
prefixed by the comment characters). See the end of this file for
examples. The local keywords and variables are:

ispell-dictionary-keyword language-dictionary
uses local variable ispell-local-dictionary
ispell-pdict-keyword personal-dictionary
uses local variable ispell-local-pdict
ispell-parsing-keyword mode-arg extended-char-arg
ispell-words-keyword any number of local word spellings

Region skipping:
Place new regular expression definitions of regions you prefer not to
spell check in ispell-skip-region-alist. Mode-dependent features can
be added to latex by modifying ispell-tex-skip-alists.
ispell-message contains some custom skipping code for e-mail messages.

BUGS:
Need a way to select between different character mappings without separate
   dictionary entries.
Multi-byte characters if not defined by current dictionary may result in the
   evil "misalignment error" in some versions of Emacs.
On some versions of Emacs, growing the minibuffer fails.
   see ispell-help-in-bufferp.
Recursive edits (?C-r or ?R) inside a keyboard text replacement check (?r)
   can cause misalignment errors.

Defined variables (89)

`ispell--aspell-found-dictionaries`	An alist of identified aspell dictionaries.
`ispell-alternate-dictionary`	Alternate plain word-list dictionary for spelling help.
`ispell-aspell-data-dir`	Data directory of Aspell.
`ispell-aspell-dict-dir`	Dictionary directory of Aspell.
`ispell-aspell-dictionary-alist`	An alist of parsed Aspell dicts and associated parameters.
`ispell-async-processp`	Non-nil means that the OS supports asynchronous processes.
`ispell-buffer-local-name`	Contains the buffer name if local word definitions were used.
`ispell-buffer-session-localwords`	List of words accepted for session in this buffer.
`ispell-change-dictionary-hook`	Hook run after changing dictionary.
`ispell-check-comments`	Spelling of comments checked when non-nil.
`ispell-check-only`	If non-nil, ‘ispell-word’ does not try to correct the word.
`ispell-checking-message`	Non-nil when we’re checking a mail message.
`ispell-choices-win-default-height`	The default size of the ‘Choices’ window, including the mode line.
`ispell-cmd-args`	Command-line arguments to pass to a synchronous Ispell subprocess.
`ispell-complete-word-dict`	Plain word-list dictionary used for word completion.
`ispell-current-dictionary`	The name of the current dictionary, or nil for the default.
`ispell-current-personal-dictionary`	The name of the current personal dictionary, or nil for the default.
`ispell-dictionary`	Default dictionary to use if ‘ispell-local-dictionary’ is nil.
`ispell-dictionary-alist`	An alist of dictionaries and their associated parameters.
`ispell-dictionary-base-alist`	Base value for ‘ispell-dictionary-alist’.
`ispell-dictionary-keyword`	The keyword for a local dictionary to use.
`ispell-dicts-name2locale-equivs-alist`	Alist with known matching locales for standard dict names.
`ispell-enchant-dictionary-alist`	An alist of parsed Enchant dicts and associated parameters.
`ispell-encoding8-command`	Command line option prefix to select encoding if supported, nil otherwise.
`ispell-extra-args`	If non-nil, a list of extra switches to pass to the Ispell program.
`ispell-filter`	Output filter from piped calls to Ispell.
`ispell-filter-continue`	Control variable for Ispell filter function.
`ispell-following-word`	Non-nil means ‘ispell-word’ checks the word around or after point.
`ispell-format-word`	Formatting function for displaying word being spell checked.
`ispell-format-word-function`	Formatting function for displaying word being spell checked.
`ispell-grep-command`	Name of the grep command for search processes.
`ispell-grep-options`	String of options to use when running the program in ‘ispell-grep-command’.
`ispell-have-new-look`	Non-nil means use the ‘-r’ option (regexp) when running ‘look’.
`ispell-help-in-bufferp`	Non-nil means display interactive keymap help in a buffer.
`ispell-help-timeout`	The number of seconds to display the help text.
`ispell-highlight-face`	Face used for Ispell highlighting.
`ispell-highlight-p`	Highlight spelling errors when non-nil.
`ispell-html-skip-alists`	Lists of start and end keys to skip in HTML buffers.
`ispell-hunspell-dict-paths-alist`	Alist of parsed Hunspell dicts and associated affix files.
`ispell-hunspell-dictionary-alist`	Alist of parsed Hunspell dicts and associated parameters.
`ispell-initialize-spellchecker-hook`	Normal hook run on spellchecker initialization.
`ispell-keep-choices-win`	If non-nil, keep the ‘Choices’ window for the entire spelling session.
`ispell-last-program-name`	Last value of ‘ispell-program-name’. Internal use.
`ispell-lazy-highlight`	Controls the lazy-highlighting of spelling errors.
`ispell-library-directory`	Directory where ispell dictionaries reside.
`ispell-local-dictionary`	If non-nil, the dictionary to be used for Ispell commands in this buffer.
`ispell-local-dictionary-alist`	List of local or customized dictionary definitions.
`ispell-local-dictionary-overridden`	Non-nil means the user has explicitly set this buffer’s Ispell dictionary.
`ispell-local-pdict`	A buffer local variable containing the current personal dictionary.
`ispell-look-command`	Name of the look command for search processes.
`ispell-look-options`	String of command options for ‘ispell-look-command’.
`ispell-look-p`	Non-nil means use ‘look’ rather than ‘grep’.
`ispell-menu-map`	Key map for ispell menu.
`ispell-message-dictionary-alist`	List used by ‘ispell-message’ to select a new dictionary.
`ispell-message-fcc-skip`	Query before saving Fcc message copy if attachment larger than this value.
`ispell-message-text-end`	Text beyond which ‘ispell-message’ will not spell-check.
`ispell-minor-keymap`	Keymap used for Ispell minor mode.
`ispell-minor-mode`	Non-nil if ISpell minor mode is enabled.
`ispell-minor-mode-hook`	Hook run after entering or leaving ‘ispell-minor-mode’.
`ispell-output-buffer`	Buffer used for reading output of a synchronous Ispell subprocess.
`ispell-overlay`	Overlay variable for Ispell highlighting.
`ispell-parser`	Indicates whether ispell should parse the current buffer as TeX Code.
`ispell-parsing-keyword`	The keyword for overriding default Ispell parsing.
`ispell-pdict-keyword`	The keyword for defining buffer local dictionaries.
`ispell-pdict-modified-p`	Non-nil means personal dictionary has modifications to be saved.
`ispell-personal-dictionary`	File name of your personal spelling dictionary, or nil.
`ispell-process`	The process object for Ispell.
`ispell-process-directory`	The directory where ‘ispell-process’ was started.
`ispell-program-name`	Program invoked by M-$ and M-x ispell-region commands.
`ispell-query-replace-choices`	Corrections made throughout region when non-nil.
`ispell-query-replace-marker`	Marker for ‘query-replace’ processing.
`ispell-quietly`	Non-nil means suppress messages in ‘ispell-word’.
`ispell-really-aspell`	Non-nil if we can use Aspell extensions.
`ispell-really-enchant`	Non-nil if we can use Enchant extensions.
`ispell-really-hunspell`	Non-nil if we can use Hunspell extensions.
`ispell-recursive-edit-marker`	Marker for return point from recursive edit.
`ispell-region-end`	Marker that allows spelling continuations.
`ispell-session-buffer`	Buffer used for passing input to a synchronous Ispell subprocess.
`ispell-silently-savep`	When non-nil, save personal dictionary without asking for confirmation.
`ispell-skip-html`	Indicates whether ispell should skip spell checking of SGML markup.
`ispell-skip-region-alist`	Alist expressing beginning and end of regions not to spell check.
`ispell-skip-tib`	Does not spell check ‘tib’ bibliography references when non-nil.
`ispell-tex-skip-alists`	Lists of regions to be skipped in TeX mode.
`ispell-tib-ref-beginning`	Regexp matching the beginning of a Tib reference.
`ispell-tib-ref-end`	Regexp matching the end of a Tib reference.
`ispell-update-post-hook`	A normal hook invoked from the ispell command loop.
`ispell-use-framepop-p`	When non-nil ispell uses framepop to display choices in a dedicated frame.
`ispell-use-ptys-p`	When non-nil, Emacs uses ptys to communicate with Ispell.
`ispell-words-keyword`	The keyword for local oddly-spelled words to accept.

Defined functions (89)

`check-ispell-version`	(&optional INTERACTIVEP)
`ispell`	()
`ispell--\w-filter`	(CHAR)
`ispell--call-enchant-lsmod`	(&rest ARGS)
`ispell--get-extra-word-characters`	(&optional LANG)
`ispell--make-\w-expression`	(CHARS)
`ispell--make-filename-or-URL-re`	()
`ispell--run-on-word`	(WORD)
`ispell-accept-buffer-local-defs`	()
`ispell-accept-output`	(&optional TIMEOUT-SECS TIMEOUT-MSECS)
`ispell-add-per-file-word-list`	(WORD)
`ispell-aspell-add-aliases`	(ALIST)
`ispell-aspell-find-dictionary`	(DICT-NAME)
`ispell-begin-skip-region`	(SKIP-ALIST)
`ispell-begin-skip-region-regexp`	()
`ispell-begin-tex-skip-regexp`	()
`ispell-buffer`	()
`ispell-buffer-local-dict`	(&optional NO-RELOAD)
`ispell-buffer-local-parsing`	()
`ispell-buffer-local-words`	()
`ispell-buffer-with-debug`	(&optional APPEND)
`ispell-call-process`	(&rest ARGS)
`ispell-call-process-region`	(&rest ARGS)
`ispell-change-dictionary`	(DICT &optional ARG)
`ispell-check-version`	(&optional INTERACTIVEP)
`ispell-command-loop`	(MISS GUESS WORD START END)
`ispell-comment-or-string-at-point`	()
`ispell-comments-and-strings`	(&optional START END)
`ispell-complete-word`	(&optional INTERIOR-FRAG)
`ispell-complete-word-interior-frag`	()
`ispell-completion-at-point`	()
`ispell-continue`	()
`ispell-correct-p`	(&optional FOLLOWING)
`ispell-create-debug-buffer`	(&optional APPEND)
`ispell-display-buffer`	(BUFFER)
`ispell-error-checking-word`	(WORD)
`ispell-filter`	(PROCESS OUTPUT)
`ispell-find-aspell-dictionaries`	()
`ispell-find-enchant-dictionaries`	()
`ispell-find-hunspell-dictionaries`	(&optional DICTIONARY)
`ispell-get-aspell-config-value`	(KEY)
`ispell-get-casechars`	()
`ispell-get-coding-system`	()
`ispell-get-decoded-string`	(N)
`ispell-get-extended-character-mode`	()
`ispell-get-ispell-args`	()
`ispell-get-line`	(START END IN-COMMENT)
`ispell-get-many-otherchars-p`	()
`ispell-get-not-casechars`	()
`ispell-get-otherchars`	()
`ispell-get-word`	(FOLLOWING &optional EXTRA-OTHERCHARS)
`ispell-help`	()
`ispell-highlight-spelling-error`	(START END &optional HIGHLIGHT REFRESH)
`ispell-highlight-spelling-error-generic`	(START END &optional HIGHLIGHT REFRESH)
`ispell-highlight-spelling-error-overlay`	(START END &optional HIGHLIGHT)
`ispell-horiz-scroll`	()
`ispell-hunspell-add-multi-dic`	(DICT)
`ispell-hunspell-fill-dictionary-entry`	(DICT)
`ispell-ignore-fcc`	(START END)
`ispell-init-process`	()
`ispell-internal-change-dictionary`	()
`ispell-kill-ispell`	(&optional NO-ERROR CLEAR)
`ispell-looking-at`	(STRING)
`ispell-lookup-words`	(WORD &optional LOOKUP-DICT)
`ispell-message`	()
`ispell-mime-multipartp`	(&optional LIMIT)
`ispell-mime-skip-part`	(BOUNDARY)
`ispell-minor-check`	()
`ispell-minor-mode`	(&optional ARG)
`ispell-non-empty-string`	(STRING)
`ispell-parse-hunspell-affix-file`	(DICT-KEY)
`ispell-parse-output`	(OUTPUT &optional ACCEPT-LIST SHIFT)
`ispell-pdict-save`	(&optional NO-QUERY FORCE-SAVE)
`ispell-print-if-debug`	(FORMAT &rest ARGS)
`ispell-process-line`	(STRING SHIFT)
`ispell-process-status`	()
`ispell-region`	(REG-START REG-END &optional RECHECKP SHIFT)
`ispell-send-replacement`	(MISSPELLED REPLACEMENT)
`ispell-send-string`	(STRING)
`ispell-set-spellchecker-params`	()
`ispell-show-choices`	()
`ispell-skip-region`	(KEY)
`ispell-skip-region-list`	()
`ispell-start-process`	()
`ispell-tex-arg-end`	(&optional ARG)
`ispell-valid-dictionary-list`	()
`ispell-with-safe-default-directory`	(&rest BODY)
`ispell-word`	(&optional FOLLOWING QUIETLY CONTINUE REGION)
`lookup-words`	(WORD &optional LOOKUP-DICT)

File: ispell.el.html

Defined variables (89)

Defined functions (89)

Defined faces (0)

File: `ispell.el.html`