aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Genco <alexgenco@gmail.com>2017-06-17 08:56:17 -0700
committerAlex Genco <alexgenco@gmail.com>2017-06-17 09:07:29 -0700
commit9b98b959d1600f7120e4b4e307a6637415a7f24b (patch)
treec509b4c653a51a54165b5f782c3a8a796fb570c8
parentf400c6f05fb2adbc1cf47be761c3dbea3419806f (diff)
downloadrneovim-9b98b959d1600f7120e4b4e307a6637415a7f24b.tar.gz
rneovim-9b98b959d1600f7120e4b4e307a6637415a7f24b.tar.bz2
rneovim-9b98b959d1600f7120e4b4e307a6637415a7f24b.zip
runtime: Add docs for g:ruby_host_prog
-rw-r--r--runtime/doc/provider.txt13
1 files changed, 13 insertions, 0 deletions
diff --git a/runtime/doc/provider.txt b/runtime/doc/provider.txt
index 8d1dd0a6cd..435646bd1c 100644
--- a/runtime/doc/provider.txt
+++ b/runtime/doc/provider.txt
@@ -99,6 +99,19 @@ RUBY PROVIDER CONFIGURATION ~
*g:loaded_ruby_provider*
To disable Ruby support: >
let g:loaded_ruby_provider = 1
+<
+ *g:ruby_host_prog*
+Command to start the Ruby host. By default this is `neovim-ruby-host`. For users
+who use per-project Ruby versions with tools like RVM or rbenv, setting this can
+prevent 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'
+<
==============================================================================
Clipboard integration *provider-clipboard* *clipboard*