mirror of
https://github.com/neovim/neovim.git
synced 2025-02-25 18:55:25 -06:00
doc: consolidate nvim.txt
This commit is contained in:
Justin M. Keyes
parent
2dbf040048
commit
742787fe9e
@ -75,6 +75,8 @@ NVIM IS... WELL DOCUMENTED *design-documented*
|
||||
- Do not prefix doc-tags with "nvim-". Use |vim_diff.txt| to document
|
||||
differences from Vim. The {Nvim} annotation is also available
|
||||
to mark a specific feature. No other distinction is necessary.
|
||||
- If a feature is removed, delete its doc entry and move its tag to
|
||||
|vim_diff.txt|.
|
||||
|
||||
|
||||
NVIM IS... HIGH SPEED AND SMALL IN SIZE *design-speed-size*
|
||||
|
||||
@ -1,23 +1,56 @@
|
||||
*nvim.txt* For Nvim. {Nvim}
|
||||
*nvim.txt* {Nvim}
|
||||
|
||||
|
||||
NVIM REFERENCE MANUAL *nvim*
|
||||
NVIM REFERENCE MANUAL
|
||||
|
||||
|
||||
Introduction to Nvim *nvim-intro*
|
||||
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|.
|
||||
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.
|
||||
|
||||
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 |provider-python|
|
||||
6. Clipboard integration |provider-clipboard|
|
||||
7. Remote plugins |remote-plugin|
|
||||
8. Embedded terminal emulator |terminal-emulator|
|
||||
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.
|
||||
|
||||
==============================================================================
|
||||
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
|
||||
<
|
||||
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|.
|
||||
|
||||
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:
|
||||
|
||||
@ -1,50 +0,0 @@
|
||||
*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:
|
||||
>
|
||||
mkdir -p ${XDG_CONFIG_HOME:=$HOME/.config}
|
||||
ln -s ~/.vim $XDG_CONFIG_HOME/nvim
|
||||
ln -s ~/.vimrc $XDG_CONFIG_HOME/nvim/init.vim
|
||||
<
|
||||
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|.
|
||||
|
||||
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:
|
||||
@ -12,8 +12,8 @@ these differences.
|
||||
|
||||
1. Configuration |nvim-configuration|
|
||||
2. Defaults |nvim-defaults|
|
||||
3. Changed features |nvim-features-changed|
|
||||
4. New features |nvim-features-new|
|
||||
3. New features |nvim-features|
|
||||
4. Changed features |nvim-features-changed|
|
||||
5. Missing legacy features |nvim-features-missing|
|
||||
6. Removed features |nvim-features-removed|
|
||||
|
||||
@ -58,7 +58,58 @@ these differences.
|
||||
- 'wildmenu' is set by default
|
||||
|
||||
==============================================================================
|
||||
3. Changed features *nvim-features-changed*
|
||||
3. New Features *nvim-features*
|
||||
|
||||
|
||||
MAJOR FEATURES ~
|
||||
|
||||
Embedded terminal emulator |terminal-emulator|
|
||||
Shared data |shada|
|
||||
RPC API |RPC|
|
||||
Job control |job-control|
|
||||
Remote plugins |remote-plugin|
|
||||
Python plugins |provider-python|
|
||||
Clipboard integration |provider-clipboard|
|
||||
|
||||
|
||||
OTHER FEATURES ~
|
||||
|
||||
|bracketed-paste-mode| is built-in and enabled by default.
|
||||
|
||||
Meta (alt) chords are recognized (even in the terminal).
|
||||
<M-1>, <M-2>, ...
|
||||
<M-BS>, <M-Del>, <M-Ins>, ...
|
||||
<M-/>, <M-\>, ...
|
||||
<M-Space>, <M-Enter>, <M-=>, <M-->, <M-?>, <M-$>, ...
|
||||
|
||||
Note: Meta chords are case-sensitive (<M-a> is distinguished from <M-A>).
|
||||
|
||||
Some `CTRL-SHIFT-...` key chords are distinguished from `CTRL-...` variants
|
||||
(even in the terminal). Specifically, the following are known to work:
|
||||
<C-Tab>, <C-S-Tab>
|
||||
<C-BS>, <C-S-BS>
|
||||
<C-Enter>, <C-S-Enter>
|
||||
|
||||
Options:
|
||||
'statusline' supports unlimited alignment sections
|
||||
|
||||
Commands:
|
||||
|:CheckHealth|
|
||||
|
||||
Events:
|
||||
|TabNew|
|
||||
|TabNewEntered|
|
||||
|TabClosed|
|
||||
|TermOpen|
|
||||
|TermClose|
|
||||
|
||||
Highlight groups:
|
||||
|hl-EndOfBuffer|
|
||||
|hl-TermCursor|
|
||||
|hl-TermCursorNC|
|
||||
|
||||
==============================================================================
|
||||
4. Changed features *nvim-features-changed*
|
||||
|
||||
Nvim always builds with all features, in contrast to Vim which may have
|
||||
certain features removed/added at compile-time. This is like if Vim's "HUGE"
|
||||
@ -140,45 +191,6 @@ Additional differences:
|
||||
itself.
|
||||
- ShaDa file keeps search direction (|v:searchforward|), viminfo does not.
|
||||
|
||||
==============================================================================
|
||||
4. New Features *nvim-features-new*
|
||||
|
||||
See |nvim-intro| for a list of Nvim's largest new features.
|
||||
|
||||
|bracketed-paste-mode| is built-in and enabled by default.
|
||||
|
||||
Meta (alt) chords are recognized (even in the terminal).
|
||||
<M-1>, <M-2>, ...
|
||||
<M-BS>, <M-Del>, <M-Ins>, ...
|
||||
<M-/>, <M-\>, ...
|
||||
<M-Space>, <M-Enter>, <M-=>, <M-->, <M-?>, <M-$>, ...
|
||||
|
||||
Note: Meta chords are case-sensitive (<M-a> is distinguished from <M-A>).
|
||||
|
||||
Some `CTRL-SHIFT-...` key chords are distinguished from `CTRL-...` variants
|
||||
(even in the terminal). Specifically, the following are known to work:
|
||||
<C-Tab>, <C-S-Tab>
|
||||
<C-BS>, <C-S-BS>
|
||||
<C-Enter>, <C-S-Enter>
|
||||
|
||||
Options:
|
||||
'statusline' supports unlimited alignment sections
|
||||
|
||||
Commands:
|
||||
|:CheckHealth|
|
||||
|
||||
Events:
|
||||
|TabNew|
|
||||
|TabNewEntered|
|
||||
|TabClosed|
|
||||
|TermOpen|
|
||||
|TermClose|
|
||||
|
||||
Highlight groups:
|
||||
|hl-EndOfBuffer|
|
||||
|hl-TermCursor|
|
||||
|hl-TermCursorNC|
|
||||
|
||||
==============================================================================
|
||||
5. Missing legacy features *nvim-features-missing*
|
||||
*if_ruby* *if_lua* *if_perl* *if_mzscheme* *if_tcl*
|
||||
|
||||
@ -1904,21 +1904,15 @@ void intro_message(int colon)
|
||||
N_("by Bram Moolenaar et al."),
|
||||
N_("Vim is open source and freely distributable"),
|
||||
"",
|
||||
N_("First time using a vi-like editor?"),
|
||||
N_("Type :Tutor<Enter> to get started!"),
|
||||
N_("Type \":Tutor\" or \":help nvim\" to get started!"),
|
||||
"",
|
||||
N_("Already know your way around Vim?"),
|
||||
N_("See :help nvim-intro for an introduction to Neovim."),
|
||||
"",
|
||||
N_("Still have questions?"),
|
||||
N_("Reach out to the Neovim community at neovim.io/community."),
|
||||
"",
|
||||
N_("Help poor children in Uganda!"),
|
||||
N_("type :help iccf<Enter> for information "),
|
||||
N_("Still have questions? https://neovim.io/community"),
|
||||
"",
|
||||
N_("type :q<Enter> to exit "),
|
||||
N_("type :help<Enter> or <F1> for on-line help"),
|
||||
N_("type :help nvim<Enter> for Neovim help "),
|
||||
"",
|
||||
N_("Help poor children in Uganda!"),
|
||||
N_("type :help iccf<Enter> for information "),
|
||||
};
|
||||
|
||||
// blanklines = screen height - # message lines
|
||||
|
||||
Loading…
Reference in New Issue
Block a user