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