From 729aa35aa10c62cba2813f26e2818fd1dffd5fb8 Mon Sep 17 00:00:00 2001
From: Simon Ruderich <simon@ruderich.org>
Date: Fri, 13 Apr 2012 22:24:02 +0200
Subject: vim-mode: Document screen/tmux esc timeout issues and fix.

---
 vim-mode/vim_mode.pl | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

(limited to 'vim-mode')

diff --git a/vim-mode/vim_mode.pl b/vim-mode/vim_mode.pl
index aa4ebec..7158873 100644
--- a/vim-mode/vim_mode.pl
+++ b/vim-mode/vim_mode.pl
@@ -457,6 +457,21 @@ Examples:
    :set debug=on    # enable debug
    :set debug=off   # disable debug
 
+=head1 KNOWN ISSUES
+
+If you use tmux and want to use <esc> to exit insert mode you might want to
+reduce the escape-time for a better experience (500 is the default value):
+
+    set -s escape-time 100
+
+A similar problem exist in GNU screen, the following settings in ~/.screenrc
+fix it (thanks to jsbronder for reporting the screen issue and fix):
+
+    maptimeout 0
+    defc1 off
+
+defc1 might not be necessary.
+
 =head1 SUPPORT
 
 Any behavior different from Vim (unless explicitly documented) should be
-- 
cgit v1.2.3