Mercurial > vim
annotate runtime/doc/help.txt @ 18486:9d887cad7315
Added tag v8.1.2237 for changeset 63ee3c2b140fe1b4801389872a8e47aec19d028b
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Thu, 31 Oct 2019 20:00:04 +0100 |
| parents | e414281d8bb4 |
| children | af69c9335223 |
| rev | line source |
|---|---|
|
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
1 *help.txt* For Vim version 8.1. Last change: 2019 Jul 21 |
| 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|. |
| 15334 | 13 Jump back: Type CTRL-O. Repeat to go further back. |
| 7 | 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. |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
17 Prepend something to specify the context: *help-context* |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
18 |
| 7 | 19 WHAT PREPEND EXAMPLE ~ |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
20 Normal mode command :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 /[ |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
7557
diff
changeset
|
28 See |help-summary| for more contexts and an explanation. |
|
7557
502ca0a62fd8
commit https://github.com/vim/vim/commit/acb4f221c715a333f4c49a2235a8006c6ac6e4d5
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
29 |
| 7 | 30 Search for help: Type ":help word", then hit CTRL-D to see matching |
| 31 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
|
32 Or use ":helpgrep word". |:helpgrep| |
| 7 | 33 |
| 15334 | 34 Getting started: Do the Vim tutor, a 20 minute interactive training for the |
| 35 basic commands, see |vimtutor|. | |
| 36 Read the user manual from start to end: |usr_01.txt| | |
| 37 | |
| 11473 | 38 Vim stands for Vi IMproved. Most of Vim was made by Bram Moolenaar, but only |
| 7 | 39 through the help of many others. See |credits|. |
| 40 ------------------------------------------------------------------------------ | |
| 41 *doc-file-list* *Q_ct* | |
| 42 BASIC: | |
| 43 |quickref| Overview of the most common commands you will use | |
| 15334 | 44 |tutor| 20 minutes training course for beginners |
| 7 | 45 |copying| About copyrights |
| 46 |iccf| Helping poor children in Uganda | |
| 47 |sponsor| Sponsor Vim development, become a registered Vim user | |
| 48 |www| Vim on the World Wide Web | |
| 49 |bugs| Where to send bug reports | |
| 50 | |
| 51 USER MANUAL: These files explain how to accomplish an editing task. | |
| 52 | |
| 53 |usr_toc.txt| Table Of Contents | |
| 54 | |
| 55 Getting Started ~ | |
| 56 |usr_01.txt| About the manuals | |
| 57 |usr_02.txt| The first steps in Vim | |
| 58 |usr_03.txt| Moving around | |
| 59 |usr_04.txt| Making small changes | |
| 60 |usr_05.txt| Set your settings | |
| 61 |usr_06.txt| Using syntax highlighting | |
| 62 |usr_07.txt| Editing more than one file | |
| 63 |usr_08.txt| Splitting windows | |
| 64 |usr_09.txt| Using the GUI | |
| 65 |usr_10.txt| Making big changes | |
| 66 |usr_11.txt| Recovering from a crash | |
| 67 |usr_12.txt| Clever tricks | |
| 68 | |
| 69 Editing Effectively ~ | |
| 70 |usr_20.txt| Typing command-line commands quickly | |
| 71 |usr_21.txt| Go away and come back | |
| 72 |usr_22.txt| Finding the file to edit | |
| 73 |usr_23.txt| Editing other files | |
| 74 |usr_24.txt| Inserting quickly | |
| 75 |usr_25.txt| Editing formatted text | |
| 76 |usr_26.txt| Repeating | |
| 77 |usr_27.txt| Search commands and patterns | |
| 78 |usr_28.txt| Folding | |
| 79 |usr_29.txt| Moving through programs | |
| 80 |usr_30.txt| Editing programs | |
| 81 |usr_31.txt| Exploiting the GUI | |
| 799 | 82 |usr_32.txt| The undo tree |
| 7 | 83 |
| 84 Tuning Vim ~ | |
| 85 |usr_40.txt| Make new commands | |
| 86 |usr_41.txt| Write a Vim script | |
| 87 |usr_42.txt| Add new menus | |
| 88 |usr_43.txt| Using filetypes | |
| 89 |usr_44.txt| Your own syntax highlighted | |
| 90 |usr_45.txt| Select your language | |
| 91 | |
| 92 Making Vim Run ~ | |
| 93 |usr_90.txt| Installing Vim | |
| 94 | |
| 95 | |
| 819 | 96 REFERENCE MANUAL: These files explain every detail of Vim. *reference_toc* |
| 7 | 97 |
| 98 General subjects ~ | |
| 99 |intro.txt| general introduction to Vim; notation used in help files | |
| 100 |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
|
101 |helphelp.txt| about using the help files |
| 7 | 102 |index.txt| alphabetical index of all commands |
| 103 |help-tags| all the tags you can jump to (index of tags) | |
| 104 |howto.txt| how to do the most common editing tasks | |
| 105 |tips.txt| various tips on using Vim | |
| 106 |message.txt| (error) messages and explanations | |
| 107 |quotes.txt| remarks from users of Vim | |
| 108 |todo.txt| known problems and desired extensions | |
| 109 |develop.txt| development of Vim | |
| 502 | 110 |debug.txt| debugging Vim itself |
| 7 | 111 |uganda.txt| Vim distribution conditions and what to do with your money |
| 112 | |
| 113 Basic editing ~ | |
| 114 |starting.txt| starting Vim, Vim command arguments, initialisation | |
| 115 |editing.txt| editing and writing files | |
| 116 |motion.txt| commands for moving around | |
| 117 |scroll.txt| scrolling the text in the window | |
| 118 |insert.txt| Insert and Replace mode | |
| 119 |change.txt| deleting and replacing text | |
| 120 |undo.txt| Undo and Redo | |
| 121 |repeat.txt| repeating commands, Vim scripts and debugging | |
| 122 |visual.txt| using the Visual mode (selecting a text area) | |
| 123 |various.txt| various remaining commands | |
| 124 |recover.txt| recovering from a crash | |
| 125 | |
| 126 Advanced editing ~ | |
| 127 |cmdline.txt| Command-line editing | |
| 128 |options.txt| description of all options | |
| 129 |pattern.txt| regexp patterns and search commands | |
| 130 |map.txt| key mapping and abbreviations | |
| 131 |tagsrch.txt| tags and special searches | |
| 132 |windows.txt| commands for using multiple windows and buffers | |
| 674 | 133 |tabpage.txt| commands for using multiple tab pages |
| 221 | 134 |spell.txt| spell checking |
| 1698 | 135 |diff.txt| working with two to four versions of the same file |
| 7 | 136 |autocmd.txt| automatically executing commands on an event |
| 137 |eval.txt| expression evaluation, conditional commands | |
|
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
138 |channel.txt| Jobs, Channels, inter-process communication |
| 7 | 139 |fold.txt| hide (fold) ranges of lines |
| 140 | |
| 141 Special issues ~ | |
|
17456
e414281d8bb4
patch 8.1.1726: the eval.txt help file is too big
Bram Moolenaar <Bram@vim.org>
parents:
16808
diff
changeset
|
142 |testing.txt| testing Vim and Vim scripts |
| 15 | 143 |print.txt| printing |
| 7 | 144 |remote.txt| using Vim as a server or client |
| 145 |term.txt| using different terminals and mice | |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
146 |terminal.txt| Terminal window support |
|
16654
7d54a66c95d7
patch 8.1.1329: plans for popup window support are spread out
Bram Moolenaar <Bram@vim.org>
parents:
15512
diff
changeset
|
147 |popup.txt| popop window support |
| 15194 | 148 |
| 149 Programming language support ~ | |
| 150 |indent.txt| automatic indenting for C and other languages | |
| 151 |syntax.txt| syntax highlighting | |
| 152 |textprop.txt| Attaching properties to text for highlighting or other | |
| 153 |filetype.txt| settings done specifically for a type of file | |
| 154 |quickfix.txt| commands for a quick edit-compile-fix cycle | |
| 155 |ft_ada.txt| Ada (the programming language) support | |
| 156 |ft_rust.txt| Filetype plugin for Rust | |
| 157 |ft_sql.txt| about the SQL filetype plugin | |
| 158 | |
| 159 Language support ~ | |
| 7 | 160 |digraph.txt| list of available digraphs |
| 161 |mbyte.txt| multi-byte text support | |
| 162 |mlang.txt| non-English language support | |
| 15194 | 163 |rileft.txt| right-to-left editing mode |
| 7 | 164 |arabic.txt| Arabic language support and editing |
| 165 |farsi.txt| Farsi (Persian) editing | |
| 166 |hebrew.txt| Hebrew language support and editing | |
| 167 |russian.txt| Russian language support and editing | |
| 168 |hangulin.txt| Hangul (Korean) input mode | |
| 169 | |
| 170 GUI ~ | |
| 171 |gui.txt| Graphical User Interface (GUI) | |
| 172 |gui_w32.txt| Win32 GUI | |
| 173 |gui_x11.txt| X11 GUI | |
| 174 | |
| 175 Interfaces ~ | |
| 14 | 176 |if_cscop.txt| using Cscope with Vim |
|
2320
966a5609669e
Added Lua interfae. (Luis Carvalho)
Bram Moolenaar <bram@vim.org>
parents:
2246
diff
changeset
|
177 |if_lua.txt| Lua interface |
| 14 | 178 |if_mzsch.txt| MzScheme interface |
| 7 | 179 |if_perl.txt| Perl interface |
| 180 |if_pyth.txt| Python interface | |
| 181 |if_tcl.txt| Tcl interface | |
| 182 |if_ole.txt| OLE automation interface for Win32 | |
| 183 |if_ruby.txt| Ruby interface | |
| 184 |debugger.txt| Interface with a debugger | |
| 185 |netbeans.txt| NetBeans External Editor interface | |
| 186 |sign.txt| debugging signs | |
| 187 | |
| 188 Versions ~ | |
| 189 |vi_diff.txt| Main differences between Vim and Vi | |
| 190 |version4.txt| Differences between Vim version 3.0 and 4.x | |
| 191 |version5.txt| Differences between Vim version 4.6 and 5.x | |
| 192 |version6.txt| Differences between Vim version 5.7 and 6.x | |
| 824 | 193 |version7.txt| Differences between Vim version 6.4 and 7.x |
|
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
8303
diff
changeset
|
194 |version8.txt| Differences between Vim version 7.4 and 8.x |
| 7 | 195 *sys-file-list* |
| 196 Remarks about specific systems ~ | |
| 197 |os_390.txt| OS/390 Unix | |
| 198 |os_amiga.txt| Amiga | |
| 199 |os_beos.txt| BeOS and BeBox | |
| 200 |os_dos.txt| MS-DOS and MS-Windows NT/95 common items | |
| 201 |os_mac.txt| Macintosh | |
| 202 |os_mint.txt| Atari MiNT | |
| 203 |os_msdos.txt| MS-DOS (plain DOS and DOS box under Windows) | |
| 204 |os_os2.txt| OS/2 | |
| 205 |os_qnx.txt| QNX | |
| 206 |os_risc.txt| RISC-OS | |
| 207 |os_unix.txt| Unix | |
| 208 |os_vms.txt| VMS | |
| 209 |os_win32.txt| MS-Windows 95/98/NT | |
| 210 *standard-plugin-list* | |
| 211 Standard plugins ~ | |
| 1121 | 212 |pi_getscript.txt| Downloading latest version of Vim scripts |
| 4073 | 213 |pi_gzip.txt| Reading and writing compressed files |
| 6884 | 214 |pi_logipat.txt| Logical operators on patterns |
| 4073 | 215 |pi_netrw.txt| Reading and writing files over a network |
| 216 |pi_paren.txt| Highlight matching parens | |
|
12756
3b26420fc639
Long overdue runtime update.
Christian Brabandt <cb@256bit.org>
parents:
11473
diff
changeset
|
217 |pi_spec.txt| Filetype plugin to work with rpm spec files |
| 4073 | 218 |pi_tar.txt| Tar file explorer |
| 1121 | 219 |pi_vimball.txt| Create a self-installing Vim script |
| 4073 | 220 |pi_zip.txt| Zip archive explorer |
| 7 | 221 |
| 222 LOCAL ADDITIONS: *local-additions* | |
| 223 | |
| 224 ------------------------------------------------------------------------------ | |
| 225 *bars* Bars example | |
| 226 | |
| 227 Now that you've jumped here with CTRL-] or a double mouse click, you can use | |
| 228 CTRL-T, CTRL-O, g<RightMouse>, or <C-RightMouse> to go back to where you were. | |
| 864 | 229 |
| 230 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
|
231 characters are hidden. That makes it easier to read a command. |
| 864 | 232 |
| 233 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
|
234 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
|
235 'compatible'. |
| 864 | 236 |
| 7 | 237 ------------------------------------------------------------------------------ |
| 14945 | 238 vim:tw=78:isk=!-~,^*,^\|,^\":ts=8:noet:ft=help:norl: |