summaryrefslogtreecommitdiff
path: root/runtime/doc/spell.txt
diff options
context:
space:
mode:
authorBram Moolenaar <Bram@vim.org>2006-02-01 21:56:25 +0000
committerBram Moolenaar <Bram@vim.org>2006-02-01 21:56:25 +0000
commit1ef15e30a0479b4c4f7da7142b6f6a441e295f1e (patch)
tree12b2dac135759a6a69706acef869b9db6a390c5e /runtime/doc/spell.txt
parentafeb4fa8a7ffc357cea70668b9ad3c66edfc8ce0 (diff)
downloadvim-git-1ef15e30a0479b4c4f7da7142b6f6a441e295f1e.tar.gz
updated for version 7.0191v7.0191
Diffstat (limited to 'runtime/doc/spell.txt')
-rw-r--r--runtime/doc/spell.txt48
1 files changed, 47 insertions, 1 deletions
diff --git a/runtime/doc/spell.txt b/runtime/doc/spell.txt
index f9559c825..43d6fe39a 100644
--- a/runtime/doc/spell.txt
+++ b/runtime/doc/spell.txt
@@ -1,4 +1,4 @@
-*spell.txt* For Vim version 7.0aa. Last change: 2006 Jan 25
+*spell.txt* For Vim version 7.0aa. Last change: 2006 Feb 01
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -261,6 +261,10 @@ Only the first file is loaded, the one that is first in 'runtimepath'. If
this succeeds then additionally files with the name LL.EEE.add.spl are loaded.
All the ones that are found are used.
+If no spell file is found the |SpellFileMissing| autocommand event is
+triggered. This may trigger the |spellfile.vim| plugin to offer you
+downloading the spell file.
+
Additionally, the files related to the names in 'spellfile' are loaded. These
are the files that |zg| and |zw| add good and wrong words to.
@@ -560,6 +564,48 @@ for the current region are included and no "/regions" line is generated.
Comment lines with the name of the .spl file are used as a header above the
words that were generated from that .spl file.
+
+SPELL FILE MISSING *spell-SpellFileMissing* *spellfile.vim*
+
+If the spell file for the language you are using is not available, you will
+get an error message. But if the "spellfile.vim" plugin is active it will
+offer you to download the spell file. Just follow the instructions, it will
+ask you where to write the file.
+
+The plugin has a default place where to look for spell files, on the Vim ftp
+server. If you want to use another location or another protocol, set the
+g:spellfile_URL variable to the directory that holds the spell files. The
+|netrw| plugin is used for getting the file, look there for the speficic
+syntax of the URL. Example: >
+ let g:spellfile_URL = 'http://ftp.vim.org/vim/runtime/spell'
+You may need to escape special characters.
+
+The plugin will only ask about downloading a language once. If you want to
+try again anyway restart Vim, or set g:spellfile_URL to another value (e.g.,
+prepend a space).
+
+To avoid using the "spellfile.vim" plugin do this in your vimrc file: >
+
+ let loaded_spellfile_plugin = 1
+
+Instead of using the plugin you can define a |SpellFileMissing| autocommand to
+handle the missing file yourself. You can use it like this: >
+
+ :au SpellFileMissing * call Download_spell_file(expand('<amatch>'))
+
+Thus the <amatch> item contains the name of the language. Another important
+value is 'encoding', since every encoding has its own spell file. With two
+exceptions:
+- For ISO-8859-15 (latin9) the name "latin1" is used (the encodings only
+ differ in characters not used in dictionary words).
+- The name "ascii" may also be used for some languages where the words use
+ only ASCII letters for most of the words.
+
+The default "spellfile.vim" plugin uses this autocommand, if you define your
+autocommand afterwars you may want to use ":au! SpellFileMissing" to overrule
+it. If you define your autocommand before the plugin is loaded it will notice
+this and not do anything.
+
==============================================================================
4. Spell file format *spell-file-format*