aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/help.txt
blob: 31b1a6ee9e4bda45f53456198bd286d6f48cd169 (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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
*help.txt*	Nvim

==============================================================================
Nvim documentation

If you are new to Nvim, see |nvim-intro|. (To go to a help link, move the
cursor to it and hit CTRL-], or right-click with mouse. Try it here: |bars|.)

This documentation is available online:
- HTML: https://neovim.io/doc/user/
- PDF: https://neovim.io/doc/user/nvim-help.pdf

------------------------------------------------------------------------------
About Nvim						*reference_toc* *Q_ct*

- |news|		News since the previous release
- |nvim|		Getting started with Nvim
- |tutor|		30-minute interactive course for beginners
- |vim-differences|	Nvim compared to Vim
- |faq|			Frequently Asked Questions
- |tips|		Various tips
- |bugs|		Where to send bug reports
- |support|		Supported platforms
- |copying|		About copyrights

------------------------------------------------------------------------------
Usage

- |helphelp|		Using the `:help` files
- |intro|		Introduction to Vim
- |quickref|		Overview of common commands
- |index|		Index of all commands
- |user-manual|		User manual: How to accomplish editing tasks.
- |message.txt|		(Error) messages and explanations
- |Kuwasha|		Helping poor children in Uganda

------------------------------------------------------------------------------
Basic editing

- |starting|		Starting Vim, Vim command arguments, initialisation
- |edit-files|		Editing and writing files
- |motion.txt|		Commands for moving around
- |scrolling|		Scrolling the text in the window
- |insert.txt|		Insert and Replace mode
- |change.txt|		Deleting and replacing text
- |undo-redo|		Undo and Redo
- |repeat.txt|		Repeating commands, Vim scripts and debugging
- |visual-mode|		Using Visual mode (selecting text)
- |various|		Various other commands
- |crash-recovery|	Recovering from a crash

------------------------------------------------------------------------------
Advanced editing

- |cmdline|		Command-line editing
- |options|		Description of all options
- |pattern-searches|	Vim regexp patterns and search commands
- |key-mapping|		Key mapping (shortcuts), abbreviations
- |tags|		Tags and special searches
- |windows|		Commands for using windows and buffers
- |tabpage|		Commands for using tabpages
- |spell|		Spell checking
- |diff|		Comparing files
- |folding|		Hide (fold) ranges of lines
- |terminal|		Embedded terminal emulator

------------------------------------------------------------------------------
API (extensibility/scripting/plugins)

- |api|			Nvim API via RPC, Lua and Vimscript
- |ui|			Nvim UI protocol
- |lua-guide|		Nvim Lua guide
- |lua|			Lua API
- |luaref|		Lua reference manual
- |luvref|		Luv (|vim.uv|) reference manual
- |autocmd|		Event handlers
- |job-control|		Spawn and control multiple processes
- |channel|		Nvim asynchronous IO
- |vimscript|		Vimscript reference
- |vimscript-functions|	Vimscript functions
- |remote-plugin|	Nvim remote plugins
- |health|		Health checking

------------------------------------------------------------------------------
Programming language support

- |diagnostic-api|	Diagnostic framework
- |filetype|		Settings for specific types of files
- |indent.txt|		automatic indenting for C and other languages
- |lsp|			Language Server Protocol (LSP)
- |quickfix|		Commands for a quick edit-compile-fix cycle
- |syntax|		syntax highlighting
- |treesitter|		Incremental syntax parsing
- |vim.pack|		Plugin manager

------------------------------------------------------------------------------
UI

- |tui|			Builtin UI
- |gui|			External (graphical) UIs
- |signs|		Signs displayed as window decorations (the "gutter")

------------------------------------------------------------------------------
Multilingual support

- |digraph|		List of available digraphs
- |mbyte.txt|		Multibyte text support
- |mlang.txt|		Non-English language support
- |rileft.txt|		Right-to-left editing mode
- |l10n-arabic.txt|	Arabic language support and editing
- |l10n-hebrew.txt|	Hebrew language support and editing
- |l10n-russian.txt|	Russian language support and editing
- |l10n-vietnamese.txt|	Vietnamese language support and editing

------------------------------------------------------------------------------
Interop

- |provider|		Builtin remote plugin hosts
- |if_perl|		Perl interface
- |if_pyth|		Python interface
- |if_ruby|		Ruby interface

------------------------------------------------------------------------------
Versions

- |deprecated|		Deprecated features that will be removed
- |vi-differences|	Differences between Vim and Vi

------------------------------------------------------------------------------
Developing nvim

- |dev|			Development of Nvim
- |dev-arch|		Internal architecture, modules, data structures
- |dev-style|		Development style guidelines
- |dev-test|		Writing and running tests
- |dev-theme|		Design guidelines (colorschemes etc.)
- |dev-tools|		Tools and techniques for developing Nvim
- |dev-vimpatch|	Merging patches from Vim

Standard plugins ~

See |standard-plugin-list|.

Local additions ~
							     *local-additions*

------------------------------------------------------------------------------
Bars example								*bars*

Now that you've jumped here with CTRL-] or a double mouse click, you can use
CTRL-T, CTRL-O, g<RightMouse>, or <C-RightMouse> to go back to where you were.

Note that tags are within | characters, but when highlighting is enabled these
characters are hidden (for aesthetics).

You can use CTRL-] on any word (even if it is not within "|") and Nvim will
try to find help for it.  Especially for options in single quotes, e.g.
'hlsearch'.


 vim:tw=78:isk=!-~,^*,^\|,^\":ts=8:noet:ft=help:norl: