From 44a9d7b04f9fb752c67a084ebdfa8c97b65a9894 Mon Sep 17 00:00:00 2001 From: Florian Fischer Date: Mon, 28 Jan 2019 05:06:05 +0100 Subject: Update Readme --- Readme.md | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) (limited to 'Readme.md') diff --git a/Readme.md b/Readme.md index fc02303..d0d1029 100644 --- a/Readme.md +++ b/Readme.md @@ -9,20 +9,30 @@ A spellchecking lua plugin for the [vis editor](https://github.com/martanne/vis) ## usage -+ To correct the whole file press `` in normal mode. -+ To correct the word under the curser press `` in normal mode. ++ To enable highlighting of misspelled words press `e` in normal mode. ++ To disable highlighting press `d` in normal mode. ++ To correct the word under the cursor press `w` in normal mode. ++ To ignore the word under the cursor press `i` in normal mode. ## configuration -The module table returned from `require(...)` has two configuration fields -`lang` and `cmd`. `lang` is inserted in the `cmd` string at `%s`. -The defaults are `enchant -d %s` and `$LANG` or `en_US`. +The module table returned from `require(...)` has three configuration options: - spell = require(...) - spell.cmd = "aspell -l %s -a" - spell.lang = "en_US" +* `cmd`: cmd that is passed to popen() and must return word corrections in Ispell format. + * default: `enchant -d %s` +* `list_cmd`: cmd that is passed to popen() and must output a list of misspelled words. + * default: `enchant -l -d %s` +* `lang`: The name of the used dictionary. `lang` is inserted in the cmd-strings at `%s`. + * default: `$LANG` or `en_US` -During runtime: +A possible configuration could look like this: + + spellcheck = require(...) + spellcheck.cmd = "aspell -l %s -a" + spellcheck.list_cmd = "aspell list -l %s -a" + spellcheck.lang = "de_DE" + +Changing language during runtime: :set spelllang en_US -- cgit v1.2.3