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