runtime(doc): clarify bracketed paste mode
related: #13398
Signed-off-by: Christian Brabandt <cb@256bit.org>
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index a08285e..a11c1f1 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -1,4 +1,4 @@
-*options.txt* For Vim version 9.0. Last change: 2023 Oct 14
+*options.txt* For Vim version 9.0. Last change: 2023 Oct 23
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -1971,6 +1971,8 @@
'delcombine' + off unicode: delete whole char combination
'digraph' + off no digraphs
'esckeys' & off no <Esc>-keys in Insert mode
+ this also disables |modifyOtherKeys|
+ and |xterm-bracketed-paste|
'expandtab' + off tabs not expanded to spaces
'fileformats' & "" no automatic file format detection,
"dos,unix" except for MS-Windows
@@ -3215,9 +3217,9 @@
won't work by default.
NOTE: This option is set to the Vi default value when 'compatible' is
set and to the Vim default value when 'compatible' is reset.
- NOTE: when this option is off then the |modifyOtherKeys| functionality
- is disabled while in Insert mode to avoid ending Insert mode with any
- key that has a modifier.
+ NOTE: when this option is off then the |modifyOtherKeys| and
+ |xterm-bracketed-paste| functionality is disabled while in Insert mode
+ to avoid ending Insert mode with any key that has a modifier.
*'eventignore'* *'ei'*
'eventignore' 'ei' string (default "")
diff --git a/runtime/doc/term.txt b/runtime/doc/term.txt
index cb4c676..72af6d3 100644
--- a/runtime/doc/term.txt
+++ b/runtime/doc/term.txt
@@ -1,4 +1,4 @@
-*term.txt* For Vim version 9.0. Last change: 2023 Jan 15
+*term.txt* For Vim version 9.0. Last change: 2023 Oct 25
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -104,6 +104,11 @@
that are typed. The pasted text is handled like when the middle mouse button
is used, it is inserted literally and not interpreted as commands.
+Please note: while bracketed paste is trying to prevent nasty side-effects
+from pasting (like the CTRL-C or <ESC> key), it's not a guaranteed security
+measure because different terminals may implement this mode slightly
+differently. You should still be careful with what you paste into Vim.
+
When the cursor is in the first column, the pasted text will be inserted
before it. Otherwise the pasted text is appended after the cursor position.
This means one cannot paste after the first column. Unfortunately Vim does
@@ -122,6 +127,9 @@
sure that bracketed paste is not enabled when the escape codes surrounding
pasted text cannot be recognized.
+Note: bracketed paste mode will be disabled, when the 'esckeys' option is not
+set (also when the 'compatible' option is set).
+
If your terminal supports bracketed paste, but the options are not set
automatically, you can try using something like this: >