Skip to content

Commit

Permalink
runtime(doc): clarify bracketed paste mode
Browse files Browse the repository at this point in the history
related: #13398

Signed-off-by: Christian Brabandt <cb@256bit.org>
  • Loading branch information
chrisbra committed Oct 25, 2023
1 parent a56f02d commit 5f5131d
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
10 changes: 6 additions & 4 deletions 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
Expand Down Expand Up @@ -1971,6 +1971,8 @@ A jump table for the options with a short description can be found at |Q_op|.
'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
Expand Down Expand Up @@ -3215,9 +3217,9 @@ A jump table for the options with a short description can be found at |Q_op|.
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 "")
Expand Down
10 changes: 9 additions & 1 deletion 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
Expand Down Expand Up @@ -104,6 +104,11 @@ pasted text. This way Vim can separate text that is pasted from characters
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
Expand All @@ -122,6 +127,9 @@ If |t_PS| or |t_PE| is not set, then |t_BE| will not be used. This is to make
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: >
Expand Down

0 comments on commit 5f5131d

Please sign in to comment.