From 10591c8be9cf81a29277e52e994aeeee9dc31c63 Mon Sep 17 00:00:00 2001 From: Tom McDonald Date: Sat, 21 Dec 2013 23:23:06 -0500 Subject: [PATCH] Explain issue #11 caveat and solutions in README --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 9ae2c51..7b2d76e 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,34 @@ To exchange two words, place your cursor on the first word and type `cxiw`. Then move to the second word and type `cxiw` again. Note: the {motion} used in the first and second use of `cx` don't have to be the same. +Caveats +------- + +### Visual mapping causes delay for change operator + +As noted in [Issue #11][iss11], the visual mapping for `cx` can cause a delay +if you want to use `c` from visual mode. This is because Vim is waiting for a +delay (specified by `'timeoutlen'`) before using the `c` command instead of +using `cx`. For more details, see [:help 'timeoutlen'][timeoutlen]. + +There are two potential solutions for this. + +#### Changing timeout length + +Set `'timeoutlen'` to a smaller value so that the delay is less noticeable. + + set timeoutlen=250 + +#### Changing default visual mapping + +Change the default visual mapping to something that doesn't begin with `c` (or +any other existing operator). + + vmap cx Exchange + +[iss11]: https://github.com/tommcdo/vim-exchange/issues/11 +[timeoutlen]: http://vimdoc.sourceforge.net/htmldoc/options.html#'timeoutlen' + Installation ------------