aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/options.txt
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/doc/options.txt')
-rw-r--r--runtime/doc/options.txt14
1 files changed, 10 insertions, 4 deletions
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index bcefa1f56b..a26e8faa2c 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -6170,10 +6170,16 @@ A jump table for the options with a short description can be found at |Q_op|.
'ttimeout' boolean (default on)
global
This option and 'ttimeoutlen' determine the behavior when part of a
- key code sequence has been received by the terminal UI. For example,
- if the \x1b byte is received and 'ttimeout' is set, Nvim will wait
- 'ttimeoutlen' milliseconds for the terminal to complete a byte
- sequence that represents a key that starts with \x1b.
+ key code sequence has been received by the |TUI|.
+
+ For example if <Esc> (the \x1b byte) is received and 'ttimeout' is
+ set, Nvim waits 'ttimeoutlen' milliseconds for the terminal to
+ complete a key code sequence. If no input arrives before the timeout,
+ a single <Esc> is assumed. Many TUI cursor key codes start with <Esc>.
+
+ On very slow systems this may fail, causing cursor keys not to work
+ sometimes. If you discover this problem you can ":set ttimeout=9999".
+ Nvim will wait for the next character to arrive after an <Esc>.
*'timeoutlen'* *'tm'*
'timeoutlen' 'tm' number (default 1000)