https://github.com/tmux-plugins/vim-tmux-focus-events

Make terminal vim and tmux work better together.
https://github.com/tmux-plugins/vim-tmux-focus-events

Last synced: 2 months ago
JSON representation

Make terminal vim and tmux work better together.

• Host: GitHub
• URL: https://github.com/tmux-plugins/vim-tmux-focus-events
• Owner: tmux-plugins
• License: mit
• Created: 2015-03-21T20:46:35.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-03-23T08:51:52.000Z (10 months ago)
• Last Synced: 2024-08-03T01:39:46.115Z (6 months ago)
• Language: Vim script
• Homepage:
• Size: 48.8 KB
• Stars: 346
• Watchers: 12
• Forks: 23
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# tmux-focus-events.vim

**Update:** this plugin is now obsolete and no longer needed as both neovim and

vim (since version `8.2.2345`) have native support for this functionality.

`FocusGained` and `FocusLost` autocommand events are not working

in terminal vim. This plugin restores them when using vim inside Tmux.

Here's where that matters:

- [vim-fugitive](https://github.com/tpope/vim-fugitive) plugin uses

  `FocusGained` for refreshing git branch in status line

- [vim-gitgutter](https://github.com/airblade/vim-gitgutter) uses `FocusGained`

  for refreshing ... (wait for it) git gutter

- [vim-tmux-clipboard](https://github.com/roxma/vim-tmux-clipboard) uses

    `FocusGained` and `FocusLost` for refreshing clipboard.

- (get in touch if you know other popular plugins that get improved)

Also, `vim-tmux-focus-events` makes the

[autoread](http://vimdoc.sourceforge.net/htmldoc/options.html#'autoread')

option work properly for terminal vim. So far, this was only working in a GUI

version.

The `autoread` feature comes handy when files are changed outside vim, for

example when resolving merge conflicts. When you come back to vim and try saving

a changed file you'll likely be interrupted with

[E813](http://vimdoc.sourceforge.net/htmldoc/editing.html#E813):

![vim E813](/vim_e813.png)

Improved `autoread` prevents this by automatically reading a file from disk

if it was changed. Works only if `autoread` option is set (enable it with

`set autoread` in `.vimrc`).

### Installation & Configuration

#### Vim plugin installation

* Vundle


`Plugin 'tmux-plugins/vim-tmux-focus-events'`

* vim-plug


`Plug 'tmux-plugins/vim-tmux-focus-events'`

* Pathogen


`git clone git://github.com/tmux-plugins/vim-tmux-focus-events.git ~/.vim/bundle/vim-tmux-focus-events`

#### Tmux configuration

In order for Tmux to do its magic `focus-events` option has to be set to `on`.

Enable that by installing

[tmux-sensible](https://github.com/tmux-plugins/tmux-sensible) plugin, or

by setting this line in `tmux.conf`:

    set -g focus-events on

### Testing

Tested and working on:

- OS X

  - Terminal.app

  - iTerm2

- Linux

  - GNOME Terminal

  - Terminator

  - XTerm

  - Konsole

  - st

### Usage

Once installed, the plugin should "just work".

It will have no effect when running GUI vim or inside plain terminal

(without Tmux).

### Other goodies

- [vim-tmux](https://github.com/tmux-plugins/vim-tmux) - vim plugin for

  `tmux.conf`

- [tmux-resurrect](https://github.com/tmux-plugins/tmux-resurrect) - restore

  tmux environment after system restart

### Credits

Big chunk of code was taken and adapted from

[vitality.vim](https://github.com/sjl/vitality.vim).

### Other

In April 2013

[a patch was submitted](https://groups.google.com/forum/#!topic/vim_dev/ASn8QqQqVe0)

to vim_dev mailing list that enables this functionality natively in vim.

Once merged, the functionality from the patch will make this plugin obsolete. I

hope that day comes soon.

### Licence

[MIT](LICENSE.md)