blob: 2807676a893ba42176d864c56f037de149055b14 [file] [log] [blame]
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001*help.txt* For Vim version 7.0aa. Last change: 2004 Jul 05
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
10Jump to a subject: Position the cursor on a tag between |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 between |bars|.
13 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
16 on, by giving an argument to the ":help" command |:help|.
17 It is possible to further specify the context:
18 *help-context*
19 WHAT PREPEND EXAMPLE ~
20 Normal mode commands (nothing) :help x
21 Visual mode commands v_ :help v_u
22 Insert mode commands i_ :help i_<Esc>
23 Command-line commands : :help :quit
24 Command-line editing c_ :help c_<Del>
25 Vim command arguments - :help -r
26 Options ' :help 'textwidth'
27 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
74
75Tuning Vim ~
76|usr_40.txt| Make new commands
77|usr_41.txt| Write a Vim script
78|usr_42.txt| Add new menus
79|usr_43.txt| Using filetypes
80|usr_44.txt| Your own syntax highlighted
81|usr_45.txt| Select your language
82
83Making Vim Run ~
84|usr_90.txt| Installing Vim
85
86
87REFERENCE MANUAL: These files explain every detail of Vim.
88
89General subjects ~
90|intro.txt| general introduction to Vim; notation used in help files
91|help.txt| overview and quick reference (this file)
92|index.txt| alphabetical index of all commands
93|help-tags| all the tags you can jump to (index of tags)
94|howto.txt| how to do the most common editing tasks
95|tips.txt| various tips on using Vim
96|message.txt| (error) messages and explanations
97|quotes.txt| remarks from users of Vim
98|todo.txt| known problems and desired extensions
99|develop.txt| development of Vim
100|uganda.txt| Vim distribution conditions and what to do with your money
101
102Basic editing ~
103|starting.txt| starting Vim, Vim command arguments, initialisation
104|editing.txt| editing and writing files
105|motion.txt| commands for moving around
106|scroll.txt| scrolling the text in the window
107|insert.txt| Insert and Replace mode
108|change.txt| deleting and replacing text
109|indent.txt| automatic indenting for C and other languages
110|undo.txt| Undo and Redo
111|repeat.txt| repeating commands, Vim scripts and debugging
112|visual.txt| using the Visual mode (selecting a text area)
113|various.txt| various remaining commands
114|recover.txt| recovering from a crash
115
116Advanced editing ~
117|cmdline.txt| Command-line editing
118|options.txt| description of all options
119|pattern.txt| regexp patterns and search commands
120|map.txt| key mapping and abbreviations
121|tagsrch.txt| tags and special searches
122|quickfix.txt| commands for a quick edit-compile-fix cycle
123|windows.txt| commands for using multiple windows and buffers
124|syntax.txt| syntax highlighting
125|diff.txt| working with two or three versions of the same file
126|autocmd.txt| automatically executing commands on an event
127|filetype.txt| settings done specifically for a type of file
128|eval.txt| expression evaluation, conditional commands
129|fold.txt| hide (fold) ranges of lines
130
131Special issues ~
132|remote.txt| using Vim as a server or client
133|term.txt| using different terminals and mice
134|digraph.txt| list of available digraphs
135|mbyte.txt| multi-byte text support
136|mlang.txt| non-English language support
137|arabic.txt| Arabic language support and editing
138|farsi.txt| Farsi (Persian) editing
139|hebrew.txt| Hebrew language support and editing
140|russian.txt| Russian language support and editing
141|hangulin.txt| Hangul (Korean) input mode
142|rileft.txt| right-to-left editing mode
143
144GUI ~
145|gui.txt| Graphical User Interface (GUI)
146|gui_w16.txt| Windows 3.1 GUI
147|gui_w32.txt| Win32 GUI
148|gui_x11.txt| X11 GUI
149
150Interfaces ~
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000151|if_cscop.txt| using Cscope with Vim
152|if_mzsch.txt| MzScheme interface
Bram Moolenaar071d4272004-06-13 20:20:40 +0000153|if_perl.txt| Perl interface
154|if_pyth.txt| Python interface
155|if_sniff.txt| SNiFF+ interface
156|if_tcl.txt| Tcl interface
157|if_ole.txt| OLE automation interface for Win32
158|if_ruby.txt| Ruby interface
159|debugger.txt| Interface with a debugger
160|workshop.txt| Sun Visual Workshop interface
161|netbeans.txt| NetBeans External Editor interface
162|sign.txt| debugging signs
163
164Versions ~
165|vi_diff.txt| Main differences between Vim and Vi
166|version4.txt| Differences between Vim version 3.0 and 4.x
167|version5.txt| Differences between Vim version 4.6 and 5.x
168|version6.txt| Differences between Vim version 5.7 and 6.x
169 *sys-file-list*
170Remarks about specific systems ~
171|os_390.txt| OS/390 Unix
172|os_amiga.txt| Amiga
173|os_beos.txt| BeOS and BeBox
174|os_dos.txt| MS-DOS and MS-Windows NT/95 common items
175|os_mac.txt| Macintosh
176|os_mint.txt| Atari MiNT
177|os_msdos.txt| MS-DOS (plain DOS and DOS box under Windows)
178|os_os2.txt| OS/2
179|os_qnx.txt| QNX
180|os_risc.txt| RISC-OS
181|os_unix.txt| Unix
182|os_vms.txt| VMS
183|os_win32.txt| MS-Windows 95/98/NT
184 *standard-plugin-list*
185Standard plugins ~
186|pi_netrw.txt| Reading and writing files over a network
187|pi_gzip.txt| Reading and writing compressed files
188|pi_expl.txt| File explorer
189
190LOCAL ADDITIONS: *local-additions*
Bram Moolenaar325b7a22004-07-05 15:58:32 +0000191|engspchk.txt| English Spelling Checker (v57) May 25, 2004
192|example.txt| Example for a locally added help file
193|matchit.txt| Extended "%" matching
194|test.txt| Testing the hélp cömmånd nôw
195|typecorr.txt| Plugin for correcting typing mistakes
196|helpp.txt| Dummy line to avoid an error message
Bram Moolenaar071d4272004-06-13 20:20:40 +0000197
198------------------------------------------------------------------------------
199*bars* Bars example
200
201Now that you've jumped here with CTRL-] or a double mouse click, you can use
202CTRL-T, CTRL-O, g<RightMouse>, or <C-RightMouse> to go back to where you were.
203------------------------------------------------------------------------------
204 vim:tw=78:fo=tcq2:isk=!-~,^*,^\|,^\":ts=8:ft=help:norl: