2
0
mirror of https://github.com/mhinz/neovim-remote synced 2024-11-11 13:10:34 +00:00

Remove README.md

This commit is contained in:
Marco Hinz 2016-10-06 17:42:09 +02:00
parent 33eac810cf
commit f47fc111c4
No known key found for this signature in database
GPG Key ID: AC9D48E91BCF448C
2 changed files with 2 additions and 86 deletions

View File

@ -3,11 +3,8 @@ default: install
install:
python3 setup.py install
rst:
cat README.md | pandoc -f markdown -t rst > README.rst
upload: rst
upload:
python3 setup.py sdist bdist_wheel
twine upload dist/*
.PHONY: install rst upload
.PHONY: install upload

View File

@ -1,81 +0,0 @@
![Logo](https://github.com/mhinz/neovim-remote/raw/master/pictures/nvr-logo.png)
- [Intro](#intro)
- [Installation](#installation)
- [FAQ](#faq)
- [How to open directories?](#how-to-open-directories)
- [Examples](#examples)
- [Demos](#demos)
## Intro
**nvr** is a tool that helps controlling nvim processes.
It basically does two things:
1. adds back the `--remote` family of options (see `man vim`)
1. helps controlling the current nvim from within `:terminal`
To target a certain nvim process, you either use the `--servername` option or
set the environment variable `$NVIM_LISTEN_ADDRESS`.
Since `$NVIM_LISTEN_ADDRESS` is implicitely set by each nvim process, you can
call **nvr** from within Neovim (`:terminal`) without specifying `--servername`.
## Installation
```
$ pip3 install neovim-remote
```
Although you can install it via `pip3`, you can't search for it. The [bug
tracker of PyPI](https://bitbucket.org/pypa/pypi/issues?status=new&status=open)
is full of issues about packages not appearing and the developers don't seem to
care much.
## FAQ
#### How to open directories?
`:e /tmp` opens a directory view via netrw. Netrw works by hooking into certain
events, `BufEnter` in this case (see `:au FileExplorer` for all of them).
Unfortunately Neovim's API doesn't trigger any autocmds on its own, so simply
`nvr /tmp` won't work. Meanwhile you can work around it like this:
$ nvr /tmp -c 'doau BufEnter'
## Examples
In one window, create the server process:
```
$ NVIM_LISTEN_ADDRESS=/tmp/nvimsocket nvim
```
In another window do this:
```shell
$ # Spares us from using --servername all the time:
$ export NVIM_LISTEN_ADDRESS=/tmp/nvimsocket
$ # Open 2 files in the server:
$ nvr --remote file1 --remote file2
$ # Send keys to the current buffer of the server:
$ # Enter insert mode, enter 'abc', and go back to normal mode again:
$ nvr --remote-send 'iabc<esc>'
$ # Evaluate any VimL expression.
$ # Get all listed buffers:
$ nvr --remote-expr "join(sort(map(filter(range(bufnr('$')), 'buflisted(v:val)'), 'bufname(v:val)')), "\""\n"\"")"
.config/git/config
vim/vimrc
zsh/.zprofile
```
See `nvr -h` for all options.
## Demos
(Click the GIFs to watch them full-size.)
Using nvr from a different window (another tmux pane in this case):
![Demo 1](https://github.com/mhinz/neovim-remote/raw/master/pictures/demo1.gif)
Using nvr from within Neovim:
![Demo 2](https://github.com/mhinz/neovim-remote/raw/master/pictures/demo2.gif)