vim-mouse/README.md

   1 ---
   2 title: vim-mouse
   3 homepage: https://webinstall.dev/vim-mouse
   4 tagline: |
   5   vim mouse is Vim's built-in mouse support
   6 ---
   7
   8 To update (replacing the current version) run `webi vim-mouse`.
   9
  10 ## Cheat Sheet
  11
  12 Vim has built-in mouse support.
  13
  14 It is turned off by default and when turned on may not behave exactly as
  15 expected.
  16
  17 This vim-mouse plugin turns on mouse support with insert mode on click,
  18 select-to-copy clipboard, and other GUI options.
  19
  20 ### How to configure manually
  21
  22 Create the file `~/.vim/plugins/mouse.vim`. Add the same contents as
  23 <https://github.com/webinstall/webi-installers/blob/master/vim-mouse/mouse.vim>.
  24
  25 That will look something like this:
  26
  27 ```vim
  28 " turn on mouse support
  29 set mouse=a
  30
  31 " keep copy-on-select and other GUI options
  32 set clipboard+=autoselect guioptions+=a
  33
  34 " enter insert mode on left-click
  35 nnoremap <LeftMouse> <LeftMouse>i
  36 ```
  37
  38 You'll then need to update `~/.vimrc` to source that plugin:
  39
  40 ```vim
  41 " Mouse Support: reasonable defaults from webinstall.dev/vim-mouse
  42 source ~/.vim/plugins/mouse.vim
  43 ```