aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/nvim.txt
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/doc/nvim.txt')
-rw-r--r--runtime/doc/nvim.txt37
1 files changed, 25 insertions, 12 deletions
diff --git a/runtime/doc/nvim.txt b/runtime/doc/nvim.txt
index 904fb3c16c..07eb48aea3 100644
--- a/runtime/doc/nvim.txt
+++ b/runtime/doc/nvim.txt
@@ -1,32 +1,45 @@
-*nvim.txt* {Nvim}
+*nvim.txt* Nvim
NVIM REFERENCE MANUAL
-Nvim *nvim* *nvim-intro*
+Nvim *nvim* *nvim-intro*
-If you are new to Vim (and Nvim) see |help.txt| or type ":Tutor".
-If you already use Vim (but not Nvim) see |nvim-from-vim| for a quickstart.
+Nvim is based on Vim by Bram Moolenaar.
+
+If you are new to Vim, try the 30-minute tutorial: >
+ :Tutor<Enter>
+
+If you already use Vim see |nvim-from-vim| for a quickstart.
Nvim is emphatically a fork of Vim, not a clone: compatibility with Vim is
maintained where possible. See |vim_diff.txt| for the complete reference of
differences from Vim.
+ Type |gO| to see the table of contents.
+
==============================================================================
Transitioning from Vim *nvim-from-vim*
-To start the transition, link your previous configuration so Nvim can use it:
->
- mkdir -p ${XDG_CONFIG_HOME:=$HOME/.config}
- ln -s ~/.vim $XDG_CONFIG_HOME/nvim
- ln -s ~/.vimrc $XDG_CONFIG_HOME/nvim/init.vim
-<
+1. To start the transition, create your |init.vim| (user config) file: >
+
+ :call mkdir(stdpath('config'), 'p')
+ :exe 'edit '.stdpath('config').'/init.vim'
+
+2. Add these contents to the file: >
+
+ set runtimepath^=~/.vim runtimepath+=~/.vim/after
+ let &packpath = &runtimepath
+ source ~/.vimrc
+
+3. Restart Nvim, your existing Vim config will be loaded.
+
See |provider-python| and |provider-clipboard| for additional software you
might need to use some features.
-Your Vim configuration might not be entirely compatible with Nvim. For a
-full list of differences between Vim and Nvim see |vim-differences|.
+Your Vim configuration might not be entirely Nvim-compatible.
+See |vim-differences| for the full list of changes.
The |'ttymouse'| option, for example, was removed from Nvim (mouse support
should work without it). If you use the same |vimrc| for Vim and Nvim,