xref: /vim-8.2.3635/runtime/doc/help.txt (revision 94688b8a) 
1*help.txt*	For Vim version 8.1.  Last change: 2019 Jan 17
2
3			VIM - main help file
4									 k
5      Move around:  Use the cursor keys, or "h" to go left,	       h   l
6		    "j" to go down, "k" to go up, "l" to go right.	 j
7Close this window:  Use ":q<Enter>".
8   Get out of Vim:  Use ":qa!<Enter>" (careful, all changes are lost!).
9
10Jump to a subject:  Position the cursor on a tag (e.g. |bars|) and hit CTRL-].
11   With the mouse:  ":set mouse=a" to enable the mouse (in xterm or GUI).
12		    Double-click the left mouse button on a tag, e.g. |bars|.
13	Jump back:  Type CTRL-O.  Repeat to go further back.
14
15Get specific help:  It is possible to go directly to whatever you want help
16		    on, by giving an argument to the |:help| command.
17		    Prepend something to specify the context:  *help-context*
18
19			  WHAT			PREPEND    EXAMPLE	~
20		      Normal mode command		   :help x
21		      Visual mode command	  v_	   :help v_u
22		      Insert mode command	  i_	   :help i_<Esc>
23		      Command-line command	  :	   :help :quit
24		      Command-line editing	  c_	   :help c_<Del>
25		      Vim command argument	  -	   :help -r
26		      Option			  '	   :help 'textwidth'
27		      Regular expression	  /	   :help /[
28		    See |help-summary| for more contexts and an explanation.
29
30  Search for help:  Type ":help word", then hit CTRL-D to see matching
31		    help entries for "word".
32		    Or use ":helpgrep word". |:helpgrep|
33
34  Getting started:  Do the Vim tutor, a 20 minute interactive training for the
35		    basic commands, see |vimtutor|.
36		    Read the user manual from start to end: |usr_01.txt|
37
38Vim stands for Vi IMproved.  Most of Vim was made by Bram Moolenaar, but only
39through the help of many others.  See |credits|.
40------------------------------------------------------------------------------
41						*doc-file-list* *Q_ct*
42BASIC:
43|quickref|	Overview of the most common commands you will use
44|tutor|		20 minutes training course for beginners
45|copying|	About copyrights
46|iccf|		Helping poor children in Uganda
47|sponsor|	Sponsor Vim development, become a registered Vim user
48|www|		Vim on the World Wide Web
49|bugs|		Where to send bug reports
50
51USER MANUAL: These files explain how to accomplish an editing task.
52
53|usr_toc.txt|	Table Of Contents
54
55Getting Started ~
56|usr_01.txt|  About the manuals
57|usr_02.txt|  The first steps in Vim
58|usr_03.txt|  Moving around
59|usr_04.txt|  Making small changes
60|usr_05.txt|  Set your settings
61|usr_06.txt|  Using syntax highlighting
62|usr_07.txt|  Editing more than one file
63|usr_08.txt|  Splitting windows
64|usr_09.txt|  Using the GUI
65|usr_10.txt|  Making big changes
66|usr_11.txt|  Recovering from a crash
67|usr_12.txt|  Clever tricks
68
69Editing Effectively ~
70|usr_20.txt|  Typing command-line commands quickly
71|usr_21.txt|  Go away and come back
72|usr_22.txt|  Finding the file to edit
73|usr_23.txt|  Editing other files
74|usr_24.txt|  Inserting quickly
75|usr_25.txt|  Editing formatted text
76|usr_26.txt|  Repeating
77|usr_27.txt|  Search commands and patterns
78|usr_28.txt|  Folding
79|usr_29.txt|  Moving through programs
80|usr_30.txt|  Editing programs
81|usr_31.txt|  Exploiting the GUI
82|usr_32.txt|  The undo tree
83
84Tuning Vim ~
85|usr_40.txt|  Make new commands
86|usr_41.txt|  Write a Vim script
87|usr_42.txt|  Add new menus
88|usr_43.txt|  Using filetypes
89|usr_44.txt|  Your own syntax highlighted
90|usr_45.txt|  Select your language
91
92Making Vim Run ~
93|usr_90.txt|  Installing Vim
94
95
96REFERENCE MANUAL: These files explain every detail of Vim.	*reference_toc*
97
98General subjects ~
99|intro.txt|	general introduction to Vim; notation used in help files
100|help.txt|	overview and quick reference (this file)
101|helphelp.txt|	about using the help files
102|index.txt|	alphabetical index of all commands
103|help-tags|	all the tags you can jump to (index of tags)
104|howto.txt|	how to do the most common editing tasks
105|tips.txt|	various tips on using Vim
106|message.txt|	(error) messages and explanations
107|quotes.txt|	remarks from users of Vim
108|todo.txt|	known problems and desired extensions
109|develop.txt|	development of Vim
110|debug.txt|	debugging Vim itself
111|uganda.txt|	Vim distribution conditions and what to do with your money
112
113Basic editing ~
114|starting.txt|	starting Vim, Vim command arguments, initialisation
115|editing.txt|	editing and writing files
116|motion.txt|	commands for moving around
117|scroll.txt|	scrolling the text in the window
118|insert.txt|	Insert and Replace mode
119|change.txt|	deleting and replacing text
120|undo.txt|	Undo and Redo
121|repeat.txt|	repeating commands, Vim scripts and debugging
122|visual.txt|	using the Visual mode (selecting a text area)
123|various.txt|	various remaining commands
124|recover.txt|	recovering from a crash
125
126Advanced editing ~
127|cmdline.txt|	Command-line editing
128|options.txt|	description of all options
129|pattern.txt|	regexp patterns and search commands
130|map.txt|	key mapping and abbreviations
131|tagsrch.txt|	tags and special searches
132|windows.txt|	commands for using multiple windows and buffers
133|tabpage.txt|	commands for using multiple tab pages
134|spell.txt|	spell checking
135|diff.txt|	working with two to four versions of the same file
136|autocmd.txt|	automatically executing commands on an event
137|eval.txt|	expression evaluation, conditional commands
138|channel.txt|	Jobs, Channels, inter-process communication
139|fold.txt|	hide (fold) ranges of lines
140
141Special issues ~
142|print.txt|	printing
143|remote.txt|	using Vim as a server or client
144|term.txt|	using different terminals and mice
145|terminal.txt|	Terminal window support
146
147Programming language support ~
148|indent.txt|	automatic indenting for C and other languages
149|syntax.txt|	syntax highlighting
150|textprop.txt|	Attaching properties to text for highlighting or other
151|filetype.txt|	settings done specifically for a type of file
152|quickfix.txt|	commands for a quick edit-compile-fix cycle
153|ft_ada.txt|	Ada (the programming language) support
154|ft_rust.txt|	Filetype plugin for Rust
155|ft_sql.txt|	about the SQL filetype plugin
156
157Language support ~
158|digraph.txt|	list of available digraphs
159|mbyte.txt|	multi-byte text support
160|mlang.txt|	non-English language support
161|rileft.txt|	right-to-left editing mode
162|arabic.txt|	Arabic language support and editing
163|farsi.txt|	Farsi (Persian) editing
164|hebrew.txt|	Hebrew language support and editing
165|russian.txt|	Russian language support and editing
166|hangulin.txt|	Hangul (Korean) input mode
167
168GUI ~
169|gui.txt|	Graphical User Interface (GUI)
170|gui_w32.txt|	Win32 GUI
171|gui_x11.txt|	X11 GUI
172
173Interfaces ~
174|if_cscop.txt|	using Cscope with Vim
175|if_lua.txt|	Lua interface
176|if_mzsch.txt|	MzScheme interface
177|if_perl.txt|	Perl interface
178|if_pyth.txt|	Python interface
179|if_tcl.txt|	Tcl interface
180|if_ole.txt|	OLE automation interface for Win32
181|if_ruby.txt|	Ruby interface
182|debugger.txt|	Interface with a debugger
183|netbeans.txt|	NetBeans External Editor interface
184|sign.txt|	debugging signs
185
186Versions ~
187|vi_diff.txt|	Main differences between Vim and Vi
188|version4.txt|	Differences between Vim version 3.0 and 4.x
189|version5.txt|	Differences between Vim version 4.6 and 5.x
190|version6.txt|	Differences between Vim version 5.7 and 6.x
191|version7.txt|	Differences between Vim version 6.4 and 7.x
192|version8.txt|	Differences between Vim version 7.4 and 8.x
193						*sys-file-list*
194Remarks about specific systems ~
195|os_390.txt|	OS/390 Unix
196|os_amiga.txt|	Amiga
197|os_beos.txt|	BeOS and BeBox
198|os_dos.txt|	MS-DOS and MS-Windows NT/95 common items
199|os_mac.txt|	Macintosh
200|os_mint.txt|	Atari MiNT
201|os_msdos.txt|	MS-DOS (plain DOS and DOS box under Windows)
202|os_os2.txt|	OS/2
203|os_qnx.txt|	QNX
204|os_risc.txt|	RISC-OS
205|os_unix.txt|	Unix
206|os_vms.txt|	VMS
207|os_win32.txt|	MS-Windows 95/98/NT
208						*standard-plugin-list*
209Standard plugins ~
210|pi_getscript.txt| Downloading latest version of Vim scripts
211|pi_gzip.txt|      Reading and writing compressed files
212|pi_logipat.txt|   Logical operators on patterns
213|pi_netrw.txt|     Reading and writing files over a network
214|pi_paren.txt|     Highlight matching parens
215|pi_spec.txt|      Filetype plugin to work with rpm spec files
216|pi_tar.txt|       Tar file explorer
217|pi_vimball.txt|   Create a self-installing Vim script
218|pi_zip.txt|       Zip archive explorer
219
220LOCAL ADDITIONS:				*local-additions*
221
222------------------------------------------------------------------------------
223*bars*		Bars example
224
225Now that you've jumped here with CTRL-] or a double mouse click, you can use
226CTRL-T, CTRL-O, g<RightMouse>, or <C-RightMouse> to go back to where you were.
227
228Note that tags are within | characters, but when highlighting is enabled these
229characters are hidden.  That makes it easier to read a command.
230
231Anyway, you can use CTRL-] on any word, also when it is not within |, and Vim
232will try to find help for it.  Especially for options in single quotes, e.g.
233'compatible'.
234
235------------------------------------------------------------------------------
236 vim:tw=78:isk=!-~,^*,^\|,^\":ts=8:noet:ft=help:norl:
237