diff options
Diffstat (limited to 'runtime/doc/provider.txt')
| -rw-r--r-- | runtime/doc/provider.txt | 83 |
1 files changed, 41 insertions, 42 deletions
diff --git a/runtime/doc/provider.txt b/runtime/doc/provider.txt index 8b5798a5a5..0e26dc4515 100644 --- a/runtime/doc/provider.txt +++ b/runtime/doc/provider.txt @@ -13,44 +13,44 @@ Nvim delegates some features to dynamic "providers". ============================================================================== Python integration *provider-python* -Nvim supports Python |remote-plugin|s and the Vim legacy |python-vim| and +Nvim supports Python |remote-plugin|s and the Vim legacy |python2| and |python3| interfaces (which are implemented as remote-plugins). Note: Only the Vim 7.3 API is supported; bindeval (Vim 7.4) is not. PYTHON QUICKSTART ~ -If you used a package manager to install Nvim, you might already have the -required "neovim" Python package. Run |:checkhealth| to verify. +Install the "neovim" Python package: -To install the package with "pip": +- Run |:checkhealth| to see if you already have the package (some package + managers install the "neovim" Python package with Nvim itself). - For Python 2 plugins, make sure Python 2.7 is available in your $PATH, then - install the "neovim" Python package systemwide: > + install the package systemwide: > sudo pip2 install --upgrade neovim -< - or for the current user: > +< or for the current user: > pip2 install --user --upgrade neovim -< +< If "pip2" is missing, try "pip". + - For Python 3 plugins, make sure Python 3.4+ is available in your $PATH, then - install the "neovim" Python package systemwide: > + install the package systemwide: > sudo pip3 install --upgrade neovim -< - or for the current user: > +< or for the current user: > pip3 install --user --upgrade neovim -< -Note: "pip" may refer to Python 2 or Python 3, so the steps above mention -"pip2" and "pip3" explicitly. If one is missing, try "pip". +< If "pip3" is missing, try "pip". -Note: The `--upgrade` flag ensures you have the latest version even if -a previous version was already installed. +- The `--upgrade` flag ensures you have the latest version even if a previous + version was already installed. PYTHON PROVIDER CONFIGURATION ~ *g:python_host_prog* +Path to Python 2 interpreter. Setting this makes startup faster. Also useful +for working with virtualenvs. > + let g:python_host_prog = '/path/to/python' " Python 2 +< *g:python3_host_prog* -Program to use for evaluating Python code. Setting this makes startup faster. -Also useful for working with virtualenvs. > - let g:python_host_prog = '/path/to/python' - let g:python3_host_prog = '/path/to/python3' +Path to Python 3 interpreter. Setting this makes startup faster. Also useful +for working with virtualenvs. > + let g:python3_host_prog = '/path/to/python3' " Python 3 < *g:loaded_python_provider* To disable Python 2 support: > @@ -62,21 +62,21 @@ To disable Python 3 support: > PYTHON VIRTUALENVS ~ -If you plan to use per-project virtualenvs often, you should assign -a virtualenv for Neovim and hard-code the interpreter path via -|g:python_host_prog| (or |g:python3_host_prog|) so that the "neovim" python -package is not required for each Environment. Example using pyenv: > +If you plan to use per-project virtualenvs often, you should assign one +virtualenv for Neovim and hard-code the interpreter path via +|g:python3_host_prog| (or |g:python_host_prog|) so that the "neovim" package +is not required for each virtualenv. + +Example using pyenv: > pyenv install 3.4.4 - pyenv virtualenv 3.4.4 py3neovim - pyenv activate py3neovim + pyenv virtualenv 3.4.4 py3nvim + pyenv activate py3nvim pip install neovim pyenv which python # Note the path +The last command reports the interpreter path, add it to your init.vim: > + let g:python3_host_prog = '/path/to/py3nvim/bin/python' -The last command reports the interpreter path. Add it to your init.vim: > - let g:python3_host_prog = '/full/path/to/py3neovim/bin/python' - -More information: -https://github.com/zchee/deoplete-jedi/wiki/Setting-up-Python-for-Neovim +See also: https://github.com/zchee/deoplete-jedi/wiki/Setting-up-Python-for-Neovim ============================================================================== Ruby integration *provider-ruby* @@ -84,13 +84,13 @@ Ruby integration *provider-ruby* Nvim supports Ruby |remote-plugin|s and the Vim legacy |ruby-vim| interface (which is itself implemented as a Nvim remote-plugin). -Run |:checkhealth| to see if your system is up-to-date. - RUBY QUICKSTART ~ To use Ruby plugins with Nvim, install the latest "neovim" RubyGem: > gem install neovim +Run |:checkhealth| to see if your system is up-to-date. + RUBY PROVIDER CONFIGURATION ~ *g:loaded_ruby_provider* To disable Ruby support: > @@ -103,11 +103,10 @@ avoid the need to install the "neovim" gem in every project. To use an absolute path (e.g. to an rbenv installation): > let g:ruby_host_prog = '~/.rbenv/versions/2.4.1/bin/neovim-ruby-host' -< To use the RVM "system" Ruby installation: > let g:ruby_host_prog = 'rvm system do neovim-ruby-host' -< + ============================================================================== Node.js integration *provider-nodejs* @@ -130,7 +129,7 @@ To disable Node.js support: > Command to start the Node.js host. Setting this makes startup faster. By default, Nvim searches for "neovim-node-host" using "npm root -g", which -can be slow. To avoid this, set g:node_host_prog to an absolute path: > +can be slow. To avoid this, set g:node_host_prog to the host path: > let g:node_host_prog = '/usr/local/bin/neovim-node-host' < ============================================================================== @@ -187,15 +186,15 @@ The contents of selections are held by the originating application (e.g., upon a copy), and only passed to another application when that other application requests them (e.g., upon a paste). - *quoteplus* *quote+* + *primary-selection* *quotestar* *quoteplus* *quote+* -There are three documented X11 selections: `PRIMARY`, `SECONDARY`, and `CLIPBOARD`. -`CLIPBOARD` is typically used in X11 applications for copy/paste operations -(`Ctrl-c`/`v`), while `PRIMARY` is used for the last selected text, which is +There are three documented X11 selections: PRIMARY, SECONDARY, and CLIPBOARD. +CLIPBOARD is typically used in X11 applications for copy/paste operations +(CTRL-c/CTRL-v), while PRIMARY is used for the last selected text, which is generally inserted with the middle mouse button. -Nvim's X11 clipboard providers only utilize the `PRIMARY` and `CLIPBOARD` -selections, used for the '*' and '+' registers, respectively. +Nvim's X11 clipboard providers only use the PRIMARY and CLIPBOARD selections, +for the "*" and "+" registers, respectively. ============================================================================== vim:tw=78:ts=8:noet:ft=help:norl: |