aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Walch <florian@fwalch.com>2015-07-21 15:06:17 +0300
committerMichael Reed <m.reed@mykolab.com>2015-08-04 16:46:15 -0400
commit61e66656528e2f38e319addeee8553a2b1010773 (patch)
treeb52d3f88f55605ba7357b2fd1e3ed3d66c80d893
parent5fc4c2d442f01ab53fa95c7732c834950d283190 (diff)
downloadrneovim-61e66656528e2f38e319addeee8553a2b1010773.tar.gz
rneovim-61e66656528e2f38e319addeee8553a2b1010773.tar.bz2
rneovim-61e66656528e2f38e319addeee8553a2b1010773.zip
doc: Add transition instructions to nvim_from_vim.txt
Also move introduction to Nvim and topic overview to nvim.txt. Reviewed-by: Michael Reed <Pyrohh@users.noreply.github.com> Reviewed-by: Justin M. Keyes <justinkz@gmail.com>
-rw-r--r--runtime/doc/nvim.txt24
-rw-r--r--runtime/doc/nvim_from_vim.txt48
-rw-r--r--runtime/doc/nvim_intro.txt26
3 files changed, 72 insertions, 26 deletions
diff --git a/runtime/doc/nvim.txt b/runtime/doc/nvim.txt
new file mode 100644
index 0000000000..a7c512d1dc
--- /dev/null
+++ b/runtime/doc/nvim.txt
@@ -0,0 +1,24 @@
+*nvim.txt* For Nvim. {Nvim}
+
+
+ NVIM REFERENCE MANUAL *nvim*
+
+
+Introduction to Nvim *nvim-intro*
+
+This is an introduction for Vim users who are just getting started with Nvim.
+It is not meant for Vim beginners. For a basic introduction to Vim,
+see |help.txt|.
+
+1. Transitioning from Vim |nvim-from-vim|
+2. Differences from Vim |vim-differences|
+3. Msgpack-RPC |msgpack-rpc|
+4. Job control |job-control|
+5. Python plugins |nvim-python|
+6. Clipboard integration |nvim-clipboard|
+7. Remote plugins |remote-plugin|
+8. Provider infrastructure |nvim-provider|
+9. Integrated terminal emulator |nvim-terminal-emulator|
+
+==============================================================================
+ vim:tw=78:ts=8:noet:ft=help:norl:
diff --git a/runtime/doc/nvim_from_vim.txt b/runtime/doc/nvim_from_vim.txt
new file mode 100644
index 0000000000..788b311f89
--- /dev/null
+++ b/runtime/doc/nvim_from_vim.txt
@@ -0,0 +1,48 @@
+*nvim_from_vim.txt* For Nvim. {Nvim}
+
+
+ NVIM REFERENCE MANUAL
+
+
+Transitioning from Vim *nvim-from-vim*
+
+Nvim is emphatically a fork of Vim, so compatibility to Vim should be pretty
+good.
+
+To start the transition, link your previous configuration so Nvim can use
+it:
+>
+ ln -s ~/.vimrc ~/.nvimrc
+ ln -s ~/.vim ~/.nvim
+<
+See |nvim-intro|, especially |nvim-python| and |nvim-clipboard|, for
+additional software you might need to install to use all of Nvim's features.
+
+Your Vim configuration might not be entirely compatible with Nvim. For a
+full list of differences between Vim and Nvim, see |vim-differences|.
+
+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,
+consider guarding |'ttymouse'| in your configuration like so:
+>
+ if !has('nvim')
+ set ttymouse=xterm2
+ endif
+<
+Conversely, if you have Nvim specific configuration items, you could do
+this:
+>
+ if has('nvim')
+ tnoremap <Esc> <C-\><C-n>
+ endif
+<
+For a more granular approach, use |exists()|:
+>
+ if exists(':tnoremap')
+ tnoremap <Esc> <C-\><C-n>
+ endif
+<
+Now you should be able to explore Nvim more comfortably. Check |nvim| for more
+information.
+==============================================================================
+ vim:tw=78:ts=8:noet:ft=help:norl:
diff --git a/runtime/doc/nvim_intro.txt b/runtime/doc/nvim_intro.txt
deleted file mode 100644
index 40f65620af..0000000000
--- a/runtime/doc/nvim_intro.txt
+++ /dev/null
@@ -1,26 +0,0 @@
-*nvim_intro.txt* For Nvim. {Nvim}
-
-
- NVIM REFERENCE MANUAL by Thiago de Arruda
-
-
-Introduction to Nvim *nvim* *nvim-intro*
-
-This is an introduction for Vim users who are just getting started with Nvim.
-It is not meant for Vim beginners. For a basic introduction to Vim,
-see |help.txt|.
-
-For now, it is just an index with the most relevant topics/features that
-differentiate Nvim from Vim:
-
-1. Differences from Vim |vim-differences|
-2. Msgpack-RPC |msgpack-rpc|
-3. Job control |job-control|
-4. Python plugins |nvim-python|
-5. Clipboard integration |nvim-clipboard|
-6. Remote plugins |remote-plugin|
-7. Provider infrastructure |nvim-provider|
-8. Integrated terminal emulator |nvim-terminal-emulator|
-
-==============================================================================
- vim:tw=78:ts=8:noet:ft=help:norl: