blob: 3ec4ab4e1e8f23ffbb30256288e7859569b1191c [file] [log] [blame]
Bram Moolenaared39e1d2008-08-09 17:55:22 +00001*help.txt* For Vim version 7.2. Last change: 2008 Jul 21
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
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
Bram Moolenaar14716812006-05-04 21:54:08 +000010Jump to a subject: Position the cursor on a tag (e.g. |bars|) and hit CTRL-].
Bram Moolenaar071d4272004-06-13 20:20:40 +000011 With the mouse: ":set mouse=a" to enable the mouse (in xterm or GUI).
Bram Moolenaar14716812006-05-04 21:54:08 +000012 Double-click the left mouse button on a tag, e.g. |bars|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000013 Jump back: Type CTRL-T or CTRL-O (repeat to go further back).
14
15Get specific help: It is possible to go directly to whatever you want help
Bram Moolenaar1423b9d2006-05-07 15:16:06 +000016 on, by giving an argument to the |:help| command.
Bram Moolenaar071d4272004-06-13 20:20:40 +000017 It is possible to further specify the context:
18 *help-context*
19 WHAT PREPEND EXAMPLE ~
Bram Moolenaarf4d11452005-12-02 00:46:37 +000020 Normal mode command (nothing) :help x
Bram Moolenaarc9b4b052006-04-30 18:54:39 +000021 Visual mode command v_ :help v_u
22 Insert mode command i_ :help i_<Esc>
23 Command-line command : :help :quit
Bram Moolenaar071d4272004-06-13 20:20:40 +000024 Command-line editing c_ :help c_<Del>
Bram Moolenaarc9b4b052006-04-30 18:54:39 +000025 Vim command argument - :help -r
26 Option ' :help 'textwidth'
Bram Moolenaar071d4272004-06-13 20:20:40 +000027 Search for help: Type ":help word", then hit CTRL-D to see matching
28 help entries for "word".
29
30VIM stands for Vi IMproved. Most of VIM was made by Bram Moolenaar, but only
31through the help of many others. See |credits|.
32------------------------------------------------------------------------------
33 *doc-file-list* *Q_ct*
34BASIC:
35|quickref| Overview of the most common commands you will use
36|tutor| 30 minutes training course for beginners
37|copying| About copyrights
38|iccf| Helping poor children in Uganda
39|sponsor| Sponsor Vim development, become a registered Vim user
40|www| Vim on the World Wide Web
41|bugs| Where to send bug reports
42
43USER MANUAL: These files explain how to accomplish an editing task.
44
45|usr_toc.txt| Table Of Contents
46
47Getting Started ~
48|usr_01.txt| About the manuals
49|usr_02.txt| The first steps in Vim
50|usr_03.txt| Moving around
51|usr_04.txt| Making small changes
52|usr_05.txt| Set your settings
53|usr_06.txt| Using syntax highlighting
54|usr_07.txt| Editing more than one file
55|usr_08.txt| Splitting windows
56|usr_09.txt| Using the GUI
57|usr_10.txt| Making big changes
58|usr_11.txt| Recovering from a crash
59|usr_12.txt| Clever tricks
60
61Editing Effectively ~
62|usr_20.txt| Typing command-line commands quickly
63|usr_21.txt| Go away and come back
64|usr_22.txt| Finding the file to edit
65|usr_23.txt| Editing other files
66|usr_24.txt| Inserting quickly
67|usr_25.txt| Editing formatted text
68|usr_26.txt| Repeating
69|usr_27.txt| Search commands and patterns
70|usr_28.txt| Folding
71|usr_29.txt| Moving through programs
72|usr_30.txt| Editing programs
73|usr_31.txt| Exploiting the GUI
Bram Moolenaarc01140a2006-03-24 22:21:52 +000074|usr_32.txt| The undo tree
Bram Moolenaar071d4272004-06-13 20:20:40 +000075
76Tuning Vim ~
77|usr_40.txt| Make new commands
78|usr_41.txt| Write a Vim script
79|usr_42.txt| Add new menus
80|usr_43.txt| Using filetypes
81|usr_44.txt| Your own syntax highlighted
82|usr_45.txt| Select your language
83
84Making Vim Run ~
85|usr_90.txt| Installing Vim
86
87
Bram Moolenaar910f66f2006-04-05 20:41:53 +000088REFERENCE MANUAL: These files explain every detail of Vim. *reference_toc*
Bram Moolenaar071d4272004-06-13 20:20:40 +000089
90General subjects ~
91|intro.txt| general introduction to Vim; notation used in help files
92|help.txt| overview and quick reference (this file)
93|index.txt| alphabetical index of all commands
94|help-tags| all the tags you can jump to (index of tags)
95|howto.txt| how to do the most common editing tasks
96|tips.txt| various tips on using Vim
97|message.txt| (error) messages and explanations
98|quotes.txt| remarks from users of Vim
99|todo.txt| known problems and desired extensions
100|develop.txt| development of Vim
Bram Moolenaare344bea2005-09-01 20:46:49 +0000101|debug.txt| debugging Vim itself
Bram Moolenaar071d4272004-06-13 20:20:40 +0000102|uganda.txt| Vim distribution conditions and what to do with your money
103
104Basic editing ~
105|starting.txt| starting Vim, Vim command arguments, initialisation
106|editing.txt| editing and writing files
107|motion.txt| commands for moving around
108|scroll.txt| scrolling the text in the window
109|insert.txt| Insert and Replace mode
110|change.txt| deleting and replacing text
111|indent.txt| automatic indenting for C and other languages
112|undo.txt| Undo and Redo
113|repeat.txt| repeating commands, Vim scripts and debugging
114|visual.txt| using the Visual mode (selecting a text area)
115|various.txt| various remaining commands
116|recover.txt| recovering from a crash
117
118Advanced editing ~
119|cmdline.txt| Command-line editing
120|options.txt| description of all options
121|pattern.txt| regexp patterns and search commands
122|map.txt| key mapping and abbreviations
123|tagsrch.txt| tags and special searches
124|quickfix.txt| commands for a quick edit-compile-fix cycle
125|windows.txt| commands for using multiple windows and buffers
Bram Moolenaar7e8fd632006-02-18 22:14:51 +0000126|tabpage.txt| commands for using multiple tab pages
Bram Moolenaar071d4272004-06-13 20:20:40 +0000127|syntax.txt| syntax highlighting
Bram Moolenaar217ad922005-03-20 22:37:15 +0000128|spell.txt| spell checking
Bram Moolenaare37d50a2008-08-06 17:06:04 +0000129|diff.txt| working with two to four versions of the same file
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130|autocmd.txt| automatically executing commands on an event
131|filetype.txt| settings done specifically for a type of file
132|eval.txt| expression evaluation, conditional commands
133|fold.txt| hide (fold) ranges of lines
134
135Special issues ~
Bram Moolenaar8299df92004-07-10 09:47:34 +0000136|print.txt| printing
Bram Moolenaar071d4272004-06-13 20:20:40 +0000137|remote.txt| using Vim as a server or client
138|term.txt| using different terminals and mice
139|digraph.txt| list of available digraphs
140|mbyte.txt| multi-byte text support
141|mlang.txt| non-English language support
142|arabic.txt| Arabic language support and editing
143|farsi.txt| Farsi (Persian) editing
144|hebrew.txt| Hebrew language support and editing
145|russian.txt| Russian language support and editing
Bram Moolenaar446cb832008-06-24 21:56:24 +0000146|ft_ada.txt| Ada (the programming language) support
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100147|ft_sql.txt| about the SQL filetype plugin
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148|hangulin.txt| Hangul (Korean) input mode
149|rileft.txt| right-to-left editing mode
150
151GUI ~
152|gui.txt| Graphical User Interface (GUI)
153|gui_w16.txt| Windows 3.1 GUI
154|gui_w32.txt| Win32 GUI
155|gui_x11.txt| X11 GUI
156
157Interfaces ~
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000158|if_cscop.txt| using Cscope with Vim
159|if_mzsch.txt| MzScheme interface
Bram Moolenaar071d4272004-06-13 20:20:40 +0000160|if_perl.txt| Perl interface
161|if_pyth.txt| Python interface
162|if_sniff.txt| SNiFF+ interface
163|if_tcl.txt| Tcl interface
164|if_ole.txt| OLE automation interface for Win32
165|if_ruby.txt| Ruby interface
166|debugger.txt| Interface with a debugger
167|workshop.txt| Sun Visual Workshop interface
168|netbeans.txt| NetBeans External Editor interface
169|sign.txt| debugging signs
170
171Versions ~
172|vi_diff.txt| Main differences between Vim and Vi
173|version4.txt| Differences between Vim version 3.0 and 4.x
174|version5.txt| Differences between Vim version 4.6 and 5.x
175|version6.txt| Differences between Vim version 5.7 and 6.x
Bram Moolenaarc6fe9192006-04-09 21:54:49 +0000176|version7.txt| Differences between Vim version 6.4 and 7.x
Bram Moolenaar071d4272004-06-13 20:20:40 +0000177 *sys-file-list*
178Remarks about specific systems ~
179|os_390.txt| OS/390 Unix
180|os_amiga.txt| Amiga
181|os_beos.txt| BeOS and BeBox
182|os_dos.txt| MS-DOS and MS-Windows NT/95 common items
183|os_mac.txt| Macintosh
184|os_mint.txt| Atari MiNT
185|os_msdos.txt| MS-DOS (plain DOS and DOS box under Windows)
186|os_os2.txt| OS/2
187|os_qnx.txt| QNX
188|os_risc.txt| RISC-OS
189|os_unix.txt| Unix
190|os_vms.txt| VMS
191|os_win32.txt| MS-Windows 95/98/NT
192 *standard-plugin-list*
193Standard plugins ~
Bram Moolenaar9964e462007-05-05 17:54:07 +0000194|pi_getscript.txt| Downloading latest version of Vim scripts
195|pi_gzip.txt| Reading and writing compressed files
196|pi_netrw.txt| Reading and writing files over a network
197|pi_paren.txt| Highlight matching parens
198|pi_tar.txt| Tar file explorer
199|pi_vimball.txt| Create a self-installing Vim script
200|pi_zip.txt| Zip archive explorer
Bram Moolenaar071d4272004-06-13 20:20:40 +0000201
202LOCAL ADDITIONS: *local-additions*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000203
204------------------------------------------------------------------------------
205*bars* Bars example
206
207Now that you've jumped here with CTRL-] or a double mouse click, you can use
208CTRL-T, CTRL-O, g<RightMouse>, or <C-RightMouse> to go back to where you were.
Bram Moolenaar14716812006-05-04 21:54:08 +0000209
210Note that tags are within | characters, but when highlighting is enabled these
Bram Moolenaar91170f82006-05-05 21:15:17 +0000211are hidden. That makes it easier to read a command.
Bram Moolenaar14716812006-05-04 21:54:08 +0000212
213Anyway, you can use CTRL-] on any word, also when it is not within |, and Vim
214will try to find help for it.
215
Bram Moolenaar071d4272004-06-13 20:20:40 +0000216------------------------------------------------------------------------------
217 vim:tw=78:fo=tcq2:isk=!-~,^*,^\|,^\":ts=8:ft=help:norl: