diff options
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/mbyte.txt | 3 | ||||
| -rw-r--r-- | runtime/doc/options.txt | 16 | ||||
| -rw-r--r-- | runtime/doc/provider.txt | 50 | ||||
| -rw-r--r-- | runtime/doc/vim_diff.txt | 5 |
4 files changed, 35 insertions, 39 deletions
diff --git a/runtime/doc/mbyte.txt b/runtime/doc/mbyte.txt index 2d4a20ed72..d38c4fd019 100644 --- a/runtime/doc/mbyte.txt +++ b/runtime/doc/mbyte.txt @@ -1059,8 +1059,7 @@ widespread as file format. A composing or combining character is used to change the meaning of the character before it. The combining characters are drawn on top of the preceding character. -Up to two combining characters can be used by default. This can be changed -with the 'maxcombine' option. +Up to six combining characters can be displayed. When editing text a composing character is mostly considered part of the preceding character. For example "x" will delete a character and its following composing characters by default. diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 7ff1281274..f924003e1f 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -2393,6 +2393,7 @@ A jump table for the options with a short description can be found at |Q_op|. fold:c 'ยท' or '-' filling 'foldtext' diff:c '-' deleted lines of the 'diff' option msgsep:c ' ' message separator 'display' + eob:c '~' empty lines at the end of a buffer Any one that is omitted will fall back to the default. For "stl" and "stlnc" the space will be used when there is highlighting, '^' or '=' @@ -2415,6 +2416,7 @@ A jump table for the options with a short description can be found at |Q_op|. vert:c VertSplit |hl-VertSplit| fold:c Folded |hl-Folded| diff:c DiffDelete |hl-DiffDelete| + eob:c EndOfBuffer |hl-EndOfBuffer| *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'* 'fixendofline' 'fixeol' boolean (default on) @@ -3888,16 +3890,10 @@ A jump table for the options with a short description can be found at |Q_op|. set a time. This is to be compatible with Nvi. *'maxcombine'* *'mco'* -'maxcombine' 'mco' number (default 2) - global - {only available when compiled with the |+multi_byte| - feature} - The maximum number of combining characters supported for displaying. - The default is OK for most languages. Hebrew may require 4. - Maximum value is 6. - Even when this option is set to 2 you can still edit text with more - combining characters, you just can't see them. Use |g8| or |ga|. - See |mbyte-combining|. +'maxcombine' 'mco' Removed. |vim-differences| {Nvim} + Nvim always displays up to 6 combining characters. You can still edit + text with more than 6 combining characters, you just can't see them. + Use |g8| or |ga|. See |mbyte-combining|. *'maxfuncdepth'* *'mfd'* 'maxfuncdepth' 'mfd' number (default 100) diff --git a/runtime/doc/provider.txt b/runtime/doc/provider.txt index 153021a616..8b5798a5a5 100644 --- a/runtime/doc/provider.txt +++ b/runtime/doc/provider.txt @@ -13,35 +13,33 @@ Nvim delegates some features to dynamic "providers". ============================================================================== Python integration *provider-python* -Nvim supports the Vim legacy |python-vim| and |python3| interfaces via -external Python interpreters connected via |RPC|. +Nvim supports Python |remote-plugin|s and the Vim legacy |python-vim| 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. +required "neovim" Python package. Run |:checkhealth| to verify. -Following are steps to install the package with Python `pip`. +To install the package with "pip": - - -- For Python 2 plugins, make sure Python 2.7 is available in your `$PATH`, - then install the `neovim` Python package systemwide: > +- For Python 2 plugins, make sure Python 2.7 is available in your $PATH, then + install the "neovim" Python package systemwide: > sudo pip2 install --upgrade neovim < or for the current user: > pip2 install --user --upgrade neovim < -- For Python 3 plugins, make sure Python 3.4+ is available in your `$PATH`, - then install the `neovim` Python package systemwide: > +- For Python 3 plugins, make sure Python 3.4+ is available in your $PATH, then + install the "neovim" Python package systemwide: > sudo pip3 install --upgrade neovim < or for the current user: > pip3 install --user --upgrade neovim < -Note: `pip` may refer to Python 2 or Python 3, so the instructions mention -`pip2` or `pip3` explicitly. If one is missing, try `pip`. +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". Note: The `--upgrade` flag ensures you have the latest version even if a previous version was already installed. @@ -83,14 +81,14 @@ https://github.com/zchee/deoplete-jedi/wiki/Setting-up-Python-for-Neovim ============================================================================== Ruby integration *provider-ruby* -Nvim supports the Vim legacy |ruby-vim| interface via external Ruby -interpreters connected via |RPC|. +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 Vim Ruby plugins with Nvim, just install the latest `neovim` RubyGem: > +To use Ruby plugins with Nvim, install the latest "neovim" RubyGem: > gem install neovim RUBY PROVIDER CONFIGURATION ~ @@ -99,9 +97,9 @@ 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. +Command to start the Ruby host. By default this is "neovim-ruby-host". With +project-local Ruby versions (via tools like RVM or rbenv) setting this can +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' @@ -115,22 +113,23 @@ Node.js integration *provider-nodejs* Nvim supports Node.js |remote-plugin|s. https://github.com/neovim/node-client/ -https://nodejs.org/ NODEJS QUICKSTART~ -To use javascript remote-plugins with Nvim, install the `neovim` npm package: > +To use javascript remote-plugins with Nvim, install the "neovim" npm package: > npm install -g neovim -< + +Run |:checkhealth| to see if your system is up-to-date. + NODEJS PROVIDER CONFIGURATION~ *g:loaded_node_provider* -To disable Node support: > +To disable Node.js support: > :let g:loaded_node_provider = 1 < *g:node_host_prog* -Command to start the Node host. Setting this makes startup faster. +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 +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: > let g:node_host_prog = '/usr/local/bin/neovim-node-host' < @@ -143,9 +142,8 @@ system clipboard or any other clipboard "backend". To ALWAYS use the clipboard for ALL operations (instead of interacting with the '+' and/or '*' registers explicitly): > - set clipboard+=unnamedplus -< + See 'clipboard' for details and options. *clipboard-tool* diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt index 6de295303c..5394414947 100644 --- a/runtime/doc/vim_diff.txt +++ b/runtime/doc/vim_diff.txt @@ -70,6 +70,7 @@ Job control |job-control| Remote plugins |remote-plugin| Providers Clipboard |provider-clipboard| + Node.js plugins |provider-nodejs| Python plugins |provider-python| Ruby plugins |provider-ruby| Shared data |shada| @@ -179,7 +180,8 @@ Options: 'cpoptions' flags: |cpo-_| 'display' flag `msgsep` to minimize scrolling when showing messages 'guicursor' works in the terminal - 'fillchars' flag `msgsep` (see 'display' above) + 'fillchars' flags: `msgsep` (see 'display' above) + and `eob` for |EndOfBuffer| marker 'inccommand' shows interactive results for |:substitute|-like commands 'scrollback' 'statusline' supports unlimited alignment sections @@ -408,6 +410,7 @@ Options: *'macatsui'* 'maxmem' Nvim delegates memory-management to the OS. 'maxmemtot' Nvim delegates memory-management to the OS. + 'maxcombine' (6 is always used) *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'* 'shelltype' *'shortname'* *'sn'* *'noshortname'* *'nosn'* |