From af6948d271421380e0780fa4351413e62194b2df Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Fri, 10 Sep 2021 21:24:08 +0800 Subject: [PATCH] docs(terminal): clarify CTRL-\ behavior #15171 --- runtime/doc/index.txt | 5 +++-- runtime/doc/intro.txt | 7 ++++--- runtime/doc/nvim_terminal_emulator.txt | 5 +++-- 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/runtime/doc/index.txt b/runtime/doc/index.txt index 9a279ad880..b69b294820 100644 --- a/runtime/doc/index.txt +++ b/runtime/doc/index.txt @@ -1096,8 +1096,9 @@ tag command action in Command-line editing mode ~ ============================================================================== 5. Terminal mode *terminal-mode-index* -In a |terminal| buffer all keys except |CTRL-\_CTRL-N| are forwarded to the -terminal job. Use CTRL-\_CTRL-N to go to Normal mode. +In a |terminal| buffer all keys except CTRL-\ are forwarded to the terminal +job. If CTRL-\ is pressed, the next key is forwarded unless it is CTRL-N. +Use |CTRL-\_CTRL-N| to go to Normal mode. You found it, Arthur! *holy-grail* diff --git a/runtime/doc/intro.txt b/runtime/doc/intro.txt index f739e2e88b..2baf3a247f 100644 --- a/runtime/doc/intro.txt +++ b/runtime/doc/intro.txt @@ -454,9 +454,10 @@ Ex mode Like Command-line mode, but after entering a command command line. |Ex-mode| *Terminal-mode* -Terminal mode In Terminal mode all input (except |c_CTRL-\_CTRL-N|) - is sent to the process running in the current - |terminal| buffer. +Terminal mode In Terminal mode all input (except CTRL-\) is sent to + the process running in the current |terminal| buffer. + If CTRL-\ is pressed, the next key is sent unless it + is CTRL-N (|CTRL-\_CTRL-N|). If the 'showmode' option is on "-- TERMINAL --" is shown at the bottom of the window. diff --git a/runtime/doc/nvim_terminal_emulator.txt b/runtime/doc/nvim_terminal_emulator.txt index 0bf58f85fc..f61d2905be 100644 --- a/runtime/doc/nvim_terminal_emulator.txt +++ b/runtime/doc/nvim_terminal_emulator.txt @@ -47,8 +47,9 @@ Input *terminal-input* To send input, enter |Terminal-mode| using any command that would enter "insert mode" in a normal buffer, such as |i| or |:startinsert|. In this mode all keys -except are sent to the underlying program. Use to return -to normal-mode. |CTRL-\_CTRL-N| +except are sent to the underlying program. If is pressed, the +next key is sent unless it is . Use to return to normal-mode. +|CTRL-\_CTRL-N| Terminal-mode forces these local options: