*paste_insert.txt* For Vim version 7.0 Last change: 2019 Jul 11
This plugin implements a method for setting paste mode with the 'paste' option
for only the duration of the next insert operation or normal mode change, to
avoid the hassle of forgetting to unset the option after inserting.
It includes a timeout if the text isn't changed and insert mode isn't entered
within 'updatetime' seconds, or if the user navigates away from the buffer or
window. It can also be cancelled in normal mode with CTRL-C or Escape. These
keys can be changed if they are already mapped or otherwise unsuitable.
This plugin only loads if 'compatible' is not set.
The `<Plug>(PasteInsert)` map in normal mode just does `:PasteInsert`. This
is probably the way you want to use this plugin. To use `<Leader>p`, for
example, you might do this in your |vimrc|:
nmap <Leader>p <Plug>(PasteInsert)
Enter the `:PasteInsert` command just before entering insert mode to set up
the relevant hooks. It takes neither range prefix nor arguments. It's made
available for you if you want it, but most users probably just want the
|<Plug>(PasteInsert)| mapping above.
Set `g:paste_insert_cancel` to a |List| of the special codes for keys you want
to cancel the pending paste in normal mode. `['<C-C>', '<Esc>']` is the
default, for CTRL-C and Escape.
The plugin will complain on starting a paste operation if either of the keys
are already mapped, globally or locally, so pick keys you never remap, or set
this option to a blank |List| `` to disable it.
By design (Vim's), mappings don't work in paste mode. If you break the insert
with CTRL-C, the |InsertLeave| event doesn't fire, and you'll still be in
'paste' mode, just as you would be without this plugin. Leaving the buffer or
window should fix it. Friends don't let friends use CTRL-C to break insert
Written and maintained by Tom Ryder <email@example.com>.
Licensed for distribution under the same terms as Vim itself (see |license|).