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