aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/nvim.txt
blob: 513d27ccadc59d9b3f9cc5130cc1e9e6b2979ea8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
*nvim.txt*	Nvim


			    NVIM REFERENCE MANUAL


Nvim							   *nvim* *nvim-intro*

Nvim is based on Vim by Bram Moolenaar.

If you already use Vim see |nvim-from-vim| for a quickstart.
If you are new to Vim, try the 30-minute tutorial: >

    :Tutor<Enter>

Nvim is emphatically a fork of Vim, not a clone: compatibility with Vim
(especially editor and VimL features) is maintained where possible. See
|vim-differences| for the complete reference of differences from Vim.

				      Type |gO| to see the table of contents.

==============================================================================
Transitioning from Vim				*nvim-from-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 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,
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-features|
for more information.

==============================================================================
 vim:tw=78:ts=8:noet:ft=help:norl: