Mercurial > vim
annotate runtime/doc/usr_02.txt @ 30871:86683574317a v9.0.0770
patch 9.0.0770: quickfix commands may keep memory allocated
Commit: https://github.com/vim/vim/commit/d8cd6f7427bc89aa38f42cc44f58bf5fb5f0f972
Author: Yegappan Lakshmanan <yegappan@yahoo.com>
Date: Sun Oct 16 11:30:48 2022 +0100
patch 9.0.0770: quickfix commands may keep memory allocated
Problem: Quickfix commands may keep memory allocated.
Solution: Free memory when it's a bit much. (Yegappan Lakshmanan,
closes #11379)
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Sun, 16 Oct 2022 12:45:05 +0200 |
| parents | f8116058ca76 |
| children | a9b5ffbc0428 |
| rev | line source |
|---|---|
| 29314 | 1 *usr_02.txt* For Vim version 9.0. Last change: 2021 Apr 24 |
| 7 | 2 |
| 3 VIM USER MANUAL - by Bram Moolenaar | |
| 4 | |
| 5 The first steps in Vim | |
| 6 | |
| 7 | |
| 8 This chapter provides just enough information to edit a file with Vim. Not | |
| 9 well or fast, but you can edit. Take some time to practice with these | |
| 10 commands, they form the base for what follows. | |
| 11 | |
| 12 |02.1| Running Vim for the First Time | |
| 13 |02.2| Inserting text | |
| 14 |02.3| Moving around | |
| 15 |02.4| Deleting characters | |
| 16 |02.5| Undo and Redo | |
| 17 |02.6| Other editing commands | |
| 18 |02.7| Getting out | |
| 19 |02.8| Finding help | |
| 20 | |
| 21 Next chapter: |usr_03.txt| Moving around | |
| 22 Previous chapter: |usr_01.txt| About the manuals | |
| 23 Table of contents: |usr_toc.txt| | |
| 24 | |
| 25 ============================================================================== | |
| 26 *02.1* Running Vim for the First Time | |
| 27 | |
| 28 To start Vim, enter this command: > | |
| 29 | |
| 30 gvim file.txt | |
| 31 | |
| 32 In UNIX you can type this at any command prompt. If you are running Microsoft | |
| 18972 | 33 Windows, open a Command Prompt and enter the command. |
| 7 | 34 In either case, Vim starts editing a file called file.txt. Because this |
| 35 is a new file, you get a blank window. This is what your screen will look | |
| 36 like: | |
| 37 | |
| 38 +---------------------------------------+ | |
| 39 |# | | |
| 40 |~ | | |
| 41 |~ | | |
| 42 |~ | | |
| 43 |~ | | |
| 44 |"file.txt" [New file] | | |
| 45 +---------------------------------------+ | |
| 24387 | 46 ('#' is the cursor position.) |
| 7 | 47 |
| 48 The tilde (~) lines indicate lines not in the file. In other words, when Vim | |
| 49 runs out of file to display, it displays tilde lines. At the bottom of the | |
| 50 screen, a message line indicates the file is named file.txt and shows that you | |
| 51 are creating a new file. The message information is temporary and other | |
| 52 information overwrites it. | |
| 53 | |
| 54 | |
| 55 THE VIM COMMAND | |
| 56 | |
| 57 The gvim command causes the editor to create a new window for editing. If you | |
| 58 use this command: > | |
| 59 | |
| 60 vim file.txt | |
| 61 | |
| 62 the editing occurs inside your command window. In other words, if you are | |
| 63 running inside an xterm, the editor uses your xterm window. If you are using | |
| 18972 | 64 an MS-Windows command prompt window, the editing occurs inside this window. |
| 65 The text in the window will look the same for both versions, but with gvim you | |
| 66 have extra features, like a menu bar. More about that later. | |
| 7 | 67 |
| 68 ============================================================================== | |
| 69 *02.2* Inserting text | |
| 70 | |
| 71 The Vim editor is a modal editor. That means that the editor behaves | |
| 72 differently, depending on which mode you are in. The two basic modes are | |
| 73 called Normal mode and Insert mode. In Normal mode the characters you type | |
| 74 are commands. In Insert mode the characters are inserted as text. | |
| 75 Since you have just started Vim it will be in Normal mode. To start Insert | |
| 76 mode you type the "i" command (i for Insert). Then you can enter | |
| 77 the text. It will be inserted into the file. Do not worry if you make | |
| 78 mistakes; you can correct them later. To enter the following programmer's | |
| 79 limerick, this is what you type: > | |
| 80 | |
| 81 iA very intelligent turtle | |
| 82 Found programming UNIX a hurdle | |
| 83 | |
| 84 After typing "turtle" you press the <Enter> key to start a new line. Finally | |
| 85 you press the <Esc> key to stop Insert mode and go back to Normal mode. You | |
| 86 now have two lines of text in your Vim window: | |
| 87 | |
| 88 +---------------------------------------+ | |
| 89 |A very intelligent turtle | | |
| 90 |Found programming UNIX a hurdle | | |
| 91 |~ | | |
| 92 |~ | | |
| 93 | | | |
| 94 +---------------------------------------+ | |
| 95 | |
| 96 | |
| 97 WHAT IS THE MODE? | |
| 98 | |
| 99 To be able to see what mode you are in, type this command: > | |
| 100 | |
| 101 :set showmode | |
| 102 | |
| 103 You will notice that when typing the colon Vim moves the cursor to the last | |
| 104 line of the window. That's where you type colon commands (commands that start | |
| 105 with a colon). Finish this command by pressing the <Enter> key (all commands | |
| 106 that start with a colon are finished this way). | |
| 107 Now, if you type the "i" command Vim will display --INSERT-- at the bottom | |
| 108 of the window. This indicates you are in Insert mode. | |
| 109 | |
| 110 +---------------------------------------+ | |
| 111 |A very intelligent turtle | | |
| 112 |Found programming UNIX a hurdle | | |
| 113 |~ | | |
| 114 |~ | | |
| 115 |-- INSERT -- | | |
| 116 +---------------------------------------+ | |
| 117 | |
| 118 If you press <Esc> to go back to Normal mode the last line will be made blank. | |
| 119 | |
| 120 | |
| 121 GETTING OUT OF TROUBLE | |
| 122 | |
| 123 One of the problems for Vim novices is mode confusion, which is caused by | |
| 124 forgetting which mode you are in or by accidentally typing a command that | |
| 125 switches modes. To get back to Normal mode, no matter what mode you are in, | |
| 126 press the <Esc> key. Sometimes you have to press it twice. If Vim beeps back | |
| 127 at you, you already are in Normal mode. | |
| 128 | |
| 129 ============================================================================== | |
| 130 *02.3* Moving around | |
| 131 | |
| 132 After you return to Normal mode, you can move around by using these keys: | |
| 133 | |
| 134 h left *hjkl* | |
| 135 j down | |
| 136 k up | |
| 137 l right | |
| 138 | |
| 139 At first, it may appear that these commands were chosen at random. After all, | |
| 140 who ever heard of using l for right? But actually, there is a very good | |
| 141 reason for these choices: Moving the cursor is the most common thing you do in | |
| 142 an editor, and these keys are on the home row of your right hand. In other | |
| 143 words, these commands are placed where you can type them the fastest | |
| 144 (especially when you type with ten fingers). | |
| 145 | |
| 146 Note: | |
| 147 You can also move the cursor by using the arrow keys. If you do, | |
| 148 however, you greatly slow down your editing because to press the arrow | |
| 149 keys, you must move your hand from the text keys to the arrow keys. | |
| 150 Considering that you might be doing it hundreds of times an hour, this | |
| 151 can take a significant amount of time. | |
| 152 Also, there are keyboards which do not have arrow keys, or which | |
| 153 locate them in unusual places; therefore, knowing the use of the hjkl | |
| 154 keys helps in those situations. | |
| 155 | |
| 156 One way to remember these commands is that h is on the left, l is on the | |
| 157 right and j points down. In a picture: > | |
| 158 | |
| 159 k | |
| 160 h l | |
| 161 j | |
| 162 | |
| 163 The best way to learn these commands is by using them. Use the "i" command to | |
| 164 insert some more lines of text. Then use the hjkl keys to move around and | |
| 165 insert a word somewhere. Don't forget to press <Esc> to go back to Normal | |
| 166 mode. The |vimtutor| is also a nice way to learn by doing. | |
| 167 | |
| 168 For Japanese users, Hiroshi Iwatani suggested using this: | |
| 169 | |
| 170 Komsomolsk | |
| 171 ^ | |
| 172 | | |
| 173 Huan Ho <--- ---> Los Angeles | |
| 174 (Yellow river) | | |
| 175 v | |
| 176 Java (the island, not the programming language) | |
| 177 | |
| 178 ============================================================================== | |
| 179 *02.4* Deleting characters | |
| 180 | |
| 181 To delete a character, move the cursor over it and type "x". (This is a | |
| 182 throwback to the old days of the typewriter, when you deleted things by typing | |
| 183 xxxx over them.) Move the cursor to the beginning of the first line, for | |
| 184 example, and type xxxxxxx (seven x's) to delete "A very ". The result should | |
| 185 look like this: | |
| 186 | |
| 187 +---------------------------------------+ | |
| 188 |intelligent turtle | | |
| 189 |Found programming UNIX a hurdle | | |
| 190 |~ | | |
| 191 |~ | | |
| 192 | | | |
| 193 +---------------------------------------+ | |
| 194 | |
| 195 Now you can insert new text, for example by typing: > | |
| 196 | |
| 197 iA young <Esc> | |
| 198 | |
| 199 This begins an insert (the i), inserts the words "A young", and then exits | |
| 200 insert mode (the final <Esc>). The result: | |
| 201 | |
| 202 +---------------------------------------+ | |
| 203 |A young intelligent turtle | | |
| 204 |Found programming UNIX a hurdle | | |
| 205 |~ | | |
| 206 |~ | | |
| 207 | | | |
| 208 +---------------------------------------+ | |
| 209 | |
| 210 | |
| 211 DELETING A LINE | |
| 212 | |
| 213 To delete a whole line use the "dd" command. The following line will | |
| 214 then move up to fill the gap: | |
| 215 | |
| 216 +---------------------------------------+ | |
| 217 |Found programming UNIX a hurdle | | |
| 218 |~ | | |
| 219 |~ | | |
| 220 |~ | | |
| 221 | | | |
| 222 +---------------------------------------+ | |
| 223 | |
| 224 | |
| 225 DELETING A LINE BREAK | |
| 226 | |
| 227 In Vim you can join two lines together, which means that the line break | |
| 228 between them is deleted. The "J" command does this. | |
| 229 Take these two lines: | |
| 230 | |
| 231 A young intelligent ~ | |
| 232 turtle ~ | |
| 233 | |
| 234 Move the cursor to the first line and press "J": | |
| 235 | |
| 236 A young intelligent turtle ~ | |
| 237 | |
| 238 ============================================================================== | |
| 239 *02.5* Undo and Redo | |
| 240 | |
| 241 Suppose you delete too much. Well, you can type it in again, but an easier | |
| 242 way exists. The "u" command undoes the last edit. Take a look at this in | |
| 243 action: After using "dd" to delete the first line, "u" brings it back. | |
| 244 Another one: Move the cursor to the A in the first line: | |
| 245 | |
| 246 A young intelligent turtle ~ | |
| 247 | |
| 248 Now type xxxxxxx to delete "A young". The result is as follows: | |
| 249 | |
| 250 intelligent turtle ~ | |
| 251 | |
| 252 Type "u" to undo the last delete. That delete removed the g, so the undo | |
| 253 restores the character. | |
| 254 | |
| 255 g intelligent turtle ~ | |
| 256 | |
| 18719 | 257 The next "u" command restores the next-to-last character deleted: |
| 7 | 258 |
| 259 ng intelligent turtle ~ | |
| 260 | |
| 18719 | 261 The next "u" command gives you the u, and so on: |
| 7 | 262 |
| 263 ung intelligent turtle ~ | |
| 264 oung intelligent turtle ~ | |
| 265 young intelligent turtle ~ | |
| 266 young intelligent turtle ~ | |
| 267 A young intelligent turtle ~ | |
| 268 | |
| 269 Note: | |
| 270 If you type "u" twice, and the result is that you get the same text | |
| 271 back, you have Vim configured to work Vi compatible. Look here to fix | |
| 272 this: |not-compatible|. | |
| 273 This text assumes you work "The Vim Way". You might prefer to use | |
| 274 the good old Vi way, but you will have to watch out for small | |
| 275 differences in the text then. | |
| 276 | |
| 277 | |
| 278 REDO | |
| 279 | |
| 280 If you undo too many times, you can press CTRL-R (redo) to reverse the | |
| 281 preceding command. In other words, it undoes the undo. To see this in | |
| 282 action, press CTRL-R twice. The character A and the space after it disappear: | |
| 283 | |
| 284 young intelligent turtle ~ | |
| 285 | |
| 286 There's a special version of the undo command, the "U" (undo line) command. | |
| 287 The undo line command undoes all the changes made on the last line that was | |
| 288 edited. Typing this command twice cancels the preceding "U". | |
| 289 | |
| 290 A very intelligent turtle ~ | |
| 291 xxxx Delete very | |
| 292 | |
| 293 A intelligent turtle ~ | |
| 294 xxxxxx Delete turtle | |
| 295 | |
| 296 A intelligent ~ | |
| 297 Restore line with "U" | |
| 298 A very intelligent turtle ~ | |
| 299 Undo "U" with "u" | |
| 300 A intelligent ~ | |
| 301 | |
| 302 The "U" command is a change by itself, which the "u" command undoes and CTRL-R | |
| 303 redoes. This might be a bit confusing. Don't worry, with "u" and CTRL-R you | |
|
2281
e41433ea71df
Added ":earlier 1f" and ":later 1f".
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
304 can go to any of the situations you had. More about that in section |32.2|. |
| 7 | 305 |
| 306 ============================================================================== | |
| 307 *02.6* Other editing commands | |
| 308 | |
| 309 Vim has a large number of commands to change the text. See |Q_in| and below. | |
| 310 Here are a few often used ones. | |
| 311 | |
| 312 | |
| 313 APPENDING | |
| 314 | |
| 315 The "i" command inserts a character before the character under the cursor. | |
| 316 That works fine; but what happens if you want to add stuff to the end of the | |
| 317 line? For that you need to insert text after the cursor. This is done with | |
| 318 the "a" (append) command. | |
| 319 For example, to change the line | |
| 320 | |
| 321 and that's not saying much for the turtle. ~ | |
| 322 to | |
| 323 and that's not saying much for the turtle!!! ~ | |
| 324 | |
| 325 move the cursor over to the dot at the end of the line. Then type "x" to | |
| 326 delete the period. The cursor is now positioned at the end of the line on the | |
| 327 e in turtle. Now type > | |
| 328 | |
| 329 a!!!<Esc> | |
| 330 | |
| 331 to append three exclamation points after the e in turtle: | |
| 332 | |
| 333 and that's not saying much for the turtle!!! ~ | |
| 334 | |
| 335 | |
| 336 OPENING UP A NEW LINE | |
| 337 | |
| 338 The "o" command creates a new, empty line below the cursor and puts Vim in | |
| 339 Insert mode. Then you can type the text for the new line. | |
| 340 Suppose the cursor is somewhere in the first of these two lines: | |
| 341 | |
| 342 A very intelligent turtle ~ | |
| 343 Found programming UNIX a hurdle ~ | |
| 344 | |
| 345 If you now use the "o" command and type new text: > | |
| 346 | |
| 347 oThat liked using Vim<Esc> | |
| 348 | |
| 349 The result is: | |
| 350 | |
| 351 A very intelligent turtle ~ | |
| 352 That liked using Vim ~ | |
| 353 Found programming UNIX a hurdle ~ | |
| 354 | |
| 355 The "O" command (uppercase) opens a line above the cursor. | |
| 356 | |
| 357 | |
| 358 USING A COUNT | |
| 359 | |
| 360 Suppose you want to move up nine lines. You can type "kkkkkkkkk" or you can | |
| 361 enter the command "9k". In fact, you can precede many commands with a number. | |
| 362 Earlier in this chapter, for instance, you added three exclamation points to | |
| 363 the end of a line by typing "a!!!<Esc>". Another way to do this is to use the | |
| 364 command "3a!<Esc>". The count of 3 tells the command that follows to triple | |
| 365 its effect. Similarly, to delete three characters, use the command "3x". The | |
| 366 count always comes before the command it applies to. | |
| 367 | |
| 368 ============================================================================== | |
| 369 *02.7* Getting out | |
| 370 | |
| 371 To exit, use the "ZZ" command. This command writes the file and exits. | |
| 372 | |
| 373 Note: | |
| 374 Unlike many other editors, Vim does not automatically make a backup | |
| 375 file. If you type "ZZ", your changes are committed and there's no | |
| 376 turning back. You can configure the Vim editor to produce backup | |
| 18719 | 377 files; see |07.4|. |
| 7 | 378 |
| 379 | |
| 380 DISCARDING CHANGES | |
| 381 | |
| 382 Sometimes you will make a sequence of changes and suddenly realize you were | |
| 383 better off before you started. Not to worry; Vim has a | |
| 384 quit-and-throw-things-away command. It is: > | |
| 385 | |
| 386 :q! | |
| 387 | |
| 388 Don't forget to press <Enter> to finish the command. | |
| 389 | |
| 390 For those of you interested in the details, the three parts of this command | |
| 391 are the colon (:), which enters Command-line mode; the q command, which tells | |
| 392 the editor to quit; and the override command modifier (!). | |
| 393 The override command modifier is needed because Vim is reluctant to throw | |
| 394 away changes. If you were to just type ":q", Vim would display an error | |
| 395 message and refuse to exit: | |
| 396 | |
| 397 E37: No write since last change (use ! to override) ~ | |
| 398 | |
| 399 By specifying the override, you are in effect telling Vim, "I know that what | |
| 18719 | 400 I'm doing looks stupid, but I really want to do this." |
| 7 | 401 |
| 402 If you want to continue editing with Vim: The ":e!" command reloads the | |
| 403 original version of the file. | |
| 404 | |
| 405 ============================================================================== | |
| 406 *02.8* Finding help | |
| 407 | |
| 408 Everything you always wanted to know can be found in the Vim help files. | |
| 409 Don't be afraid to ask! | |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
410 |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
411 If you know what you are looking for, it is usually easier to search for it |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
412 using the help system, instead of using Google. Because the subjects follow |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
413 a certain style guide. |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
414 |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
415 Also the help has the advantage of belonging to your particular Vim version. |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
416 You won't see help for commands added later. These would not work for you. |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
417 |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
418 To get generic help use this command: > |
| 7 | 419 |
| 420 :help | |
| 421 | |
| 422 You could also use the first function key <F1>. If your keyboard has a <Help> | |
| 423 key it might work as well. | |
| 424 If you don't supply a subject, ":help" displays the general help window. | |
| 425 The creators of Vim did something very clever (or very lazy) with the help | |
| 426 system: They made the help window a normal editing window. You can use all | |
| 427 the normal Vim commands to move through the help information. Therefore h, j, | |
| 428 k, and l move left, down, up and right. | |
| 429 To get out of the help window, use the same command you use to get out of | |
| 430 the editor: "ZZ". This will only close the help window, not exit Vim. | |
| 431 | |
| 432 As you read the help text, you will notice some text enclosed in vertical bars | |
| 433 (for example, |help|). This indicates a hyperlink. If you position the | |
| 434 cursor anywhere between the bars and press CTRL-] (jump to tag), the help | |
| 236 | 435 system takes you to the indicated subject. (For reasons not discussed here, |
| 7 | 436 the Vim terminology for a hyperlink is tag. So CTRL-] jumps to the location |
| 437 of the tag given by the word under the cursor.) | |
| 438 After a few jumps, you might want to go back. CTRL-T (pop tag) takes you | |
| 439 back to the preceding position. CTRL-O (jump to older position) also works | |
| 440 nicely here. | |
| 441 At the top of the help screen, there is the notation *help.txt*. This name | |
| 442 between "*" characters is used by the help system to define a tag (hyperlink | |
| 443 destination). | |
| 444 See |29.1| for details about using tags. | |
| 445 | |
| 446 To get help on a given subject, use the following command: > | |
| 447 | |
| 448 :help {subject} | |
| 449 | |
| 450 To get help on the "x" command, for example, enter the following: > | |
| 451 | |
| 452 :help x | |
| 453 | |
| 454 To find out how to delete text, use this command: > | |
| 455 | |
| 456 :help deleting | |
| 457 | |
| 458 To get a complete index of all Vim commands, use the following command: > | |
| 459 | |
| 460 :help index | |
| 461 | |
| 462 When you need to get help for a control character command (for example, | |
| 463 CTRL-A), you need to spell it with the prefix "CTRL-". > | |
| 464 | |
| 465 :help CTRL-A | |
| 466 | |
| 467 The Vim editor has many different modes. By default, the help system displays | |
| 468 the normal-mode commands. For example, the following command displays help | |
| 469 for the normal-mode CTRL-H command: > | |
| 470 | |
| 471 :help CTRL-H | |
| 472 | |
| 473 To identify other modes, use a mode prefix. If you want the help for the | |
| 474 insert-mode version of a command, use "i_". For CTRL-H this gives you the | |
| 475 following command: > | |
| 476 | |
| 477 :help i_CTRL-H | |
| 478 | |
| 479 When you start the Vim editor, you can use several command-line arguments. | |
| 480 These all begin with a dash (-). To find what the -t argument does, for | |
| 481 example, use the command: > | |
| 482 | |
| 483 :help -t | |
| 484 | |
| 485 The Vim editor has a number of options that enable you to configure and | |
| 486 customize the editor. If you want help for an option, you need to enclose it | |
| 487 in single quotation marks. To find out what the 'number' option does, for | |
| 488 example, use the following command: > | |
| 489 | |
| 490 :help 'number' | |
| 491 | |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
492 The table with all mode prefixes can be found below: |help-summary|. |
| 7 | 493 |
| 236 | 494 Special keys are enclosed in angle brackets. To find help on the up-arrow key |
| 7 | 495 in Insert mode, for instance, use this command: > |
| 496 | |
| 497 :help i_<Up> | |
| 498 | |
| 499 If you see an error message that you don't understand, for example: | |
| 500 | |
| 501 E37: No write since last change (use ! to override) ~ | |
| 502 | |
| 503 You can use the error ID at the start to find help about it: > | |
| 504 | |
| 505 :help E37 | |
| 506 | |
| 1121 | 507 |
| 508 Summary: *help-summary* > | |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
509 |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
510 1) Use Ctrl-D after typing a topic and let Vim show all available topics. |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
511 Or press Tab to complete: > |
| 19180 | 512 :help some<Tab> |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
513 < More information on how to use the help: > |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
514 :help helphelp |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
515 |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
516 2) Follow the links in bars to related help. You can go from the detailed |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
517 help to the user documentation, which describes certain commands more from |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
518 a user perspective and less detailed. E.g. after: > |
| 19180 | 519 :help pattern.txt |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
520 < You can see the user guide topics |03.9| and |usr_27.txt| in the |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
521 introduction. |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
522 |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
523 3) Options are enclosed in single apostrophes. To go to the help topic for the |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
524 list option: > |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
525 :help 'list' |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
526 < If you only know you are looking for a certain option, you can also do: > |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
527 :help options.txt |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
528 < to open the help page which describes all option handling and then search |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
529 using regular expressions, e.g. textwidth. |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
530 Certain options have their own namespace, e.g.: > |
| 19180 | 531 :help cpo-<letter> |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
532 < for the corresponding flag of the 'cpoptions' settings, substitute <letter> |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
533 by a specific flag, e.g.: > |
| 19180 | 534 :help cpo-; |
| 24569 | 535 < And for the 'guioptions' flags: > |
| 19180 | 536 :help go-<letter> |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
537 |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
538 4) Normal mode commands do not have a prefix. To go to the help page for the |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
539 "gt" command: > |
| 19180 | 540 :help gt |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
541 |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
542 5) Insert mode commands start with i_. Help for deleting a word: > |
| 19180 | 543 :help i_CTRL-W |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
544 |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
545 6) Visual mode commands start with v_. Help for jumping to the other side of |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
546 the Visual area: > |
| 19180 | 547 :help v_o |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
548 |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
549 7) Command line editing and arguments start with c_. Help for using the |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
550 command argument %: > |
| 19180 | 551 :help c_% |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
552 |
| 18719 | 553 8) Ex-commands always start with ":", so to go to the ":s" command help: > |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
554 :help :s |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
555 |
| 11160 | 556 9) Commands specifically for debugging start with ">". To go to the help |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
557 for the "cont" debug command: > |
|
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
558 :help >cont |
|
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
559 |
|
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
560 10) Key combinations. They usually start with a single letter indicating |
|
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
561 the mode for which they can be used. E.g.: > |
| 19180 | 562 :help i_CTRL-X |
| 18719 | 563 < takes you to the family of CTRL-X commands for insert mode which can be |
| 564 used to auto-complete different things. Note, that certain keys will | |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
565 always be written the same, e.g. Control will always be CTRL. |
|
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
566 For normal mode commands there is no prefix and the topic is available at |
|
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
567 :h CTRL-<Letter>. E.g. > |
| 19180 | 568 :help CTRL-W |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
569 < In contrast > |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
570 :help c_CTRL-R |
| 18719 | 571 < will describe what the CTRL-R does when entering commands in the Command |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
572 line and > |
| 19180 | 573 :help v_CTRL-A |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
574 < talks about incrementing numbers in visual mode and > |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
575 :help g_CTRL-A |
| 18719 | 576 < talks about the "g<C-A>" command (e.g. you have to press "g" then |
| 19180 | 577 <CTRL-A>). Here the "g" stands for the normal command "g" which always |
| 18719 | 578 expects a second key before doing something similar to the commands |
| 19180 | 579 starting with "z". |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
580 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
581 11) Regexp items always start with /. So to get help for the "\+" quantifier |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
582 in Vim regexes: > |
| 19180 | 583 :help /\+ |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
584 < If you need to know everything about regular expressions, start reading |
|
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
585 at: > |
| 19180 | 586 :help pattern.txt |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
587 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
588 12) Registers always start with "quote". To find out about the special ":" |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
589 register: > |
| 19180 | 590 :help quote: |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
591 |
|
10942
e05695e59f6d
patch 8.0.0360: sometimes VimL is used instead of "Vim script"
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
592 13) Vim script is available at > |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
593 :help eval.txt |
| 19180 | 594 < Certain aspects of the language are available at :h expr-X where "X" is a |
| 595 single letter. E.g. > | |
| 596 :help expr-! | |
| 597 < will take you to the topic describing the "!" (Not) operator for Vim | |
| 598 script. | |
| 599 Also important is > | |
| 600 :help function-list | |
| 601 < to find a short description of all functions available. Help topics for | |
| 602 Vim script functions always include the "()", so: > | |
| 603 :help append() | |
| 604 < talks about the append Vim script function rather than how to append text | |
| 605 in the current buffer. | |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
606 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
607 14) Mappings are talked about in the help page :h |map.txt|. Use > |
| 19180 | 608 :help mapmode-i |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
609 < to find out about the |:imap| command. Also use :map-topic |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
610 to find out about certain subtopics particular for mappings. e.g: > |
| 19180 | 611 :help :map-local |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
612 < for buffer-local mappings or > |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
613 :help map-bar |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
614 < for how the '|' is handled in mappings. |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
615 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
616 15) Command definitions are talked about :h command-topic, so use > |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
617 :help command-bar |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
618 < to find out about the '!' argument for custom commands. |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
619 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
620 16) Window management commands always start with CTRL-W, so you find the |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
621 corresponding help at :h CTRL-W_letter. E.g. > |
| 19180 | 622 :help CTRL-W_p |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
623 < for moving the previous accessed window. You can also access > |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
624 :help windows.txt |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
625 < and read your way through if you are looking for window handling |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
626 commands. |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
627 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
628 17) Use |:helpgrep| to search in all help pages (and also of any installed |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
629 plugins). See |:helpgrep| for how to use it. |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
630 To search for a topic: > |
| 19180 | 631 :helpgrep topic |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
632 < This takes you to the first match. To go to the next one: > |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
633 :cnext |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
634 < All matches are available in the quickfix window which can be opened |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
635 with: > |
| 19180 | 636 :copen |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
637 < Move around to the match you like and press Enter to jump to that help. |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
638 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
639 18) The user manual. This describes help topics for beginners in a rather |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
640 friendly way. Start at |usr_toc.txt| to find the table of content (as you |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
641 might have guessed): > |
| 19180 | 642 :help usr_toc.txt |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
643 < Skim over the contents to find interesting topics. The "Digraphs" and |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
644 "Entering special characters" items are in chapter 24, so to go to that |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
645 particular help page: > |
| 19180 | 646 :help usr_24.txt |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
647 < Also if you want to access a certain chapter in the help, the chapter |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
648 number can be accessed directly like this: > |
| 19180 | 649 :help 10.1 |
| 18719 | 650 < which goes to chapter 10.1 in |usr_10.txt| and talks about recording |
| 651 macros. | |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
652 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
653 19) Highlighting groups. Always start with hl-groupname. E.g. > |
| 19180 | 654 :help hl-WarningMsg |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
655 < talks about the WarningMsg highlighting group. |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
656 |
| 18719 | 657 20) Syntax highlighting is namespaced to :syn-topic. E.g. > |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
658 :help :syn-conceal |
| 18719 | 659 < talks about the conceal argument for the ":syn" command. |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
660 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
661 21) Quickfix commands usually start with :c while location list commands |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
662 usually start with :l |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
663 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
664 22) Autocommand events can be found by their name: > |
| 19180 | 665 :help BufWinLeave |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
666 < To see all possible events: > |
| 11062 | 667 :help autocommand-events |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
668 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
669 23) Command-line switches always start with "-". So for the help of the -f |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
670 command switch of Vim use: > |
| 19180 | 671 :help -f |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
672 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
673 24) Optional features always start with "+". To find out about the |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
674 conceal feature use: > |
| 19180 | 675 :help +conceal |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
676 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
677 25) Documentation for included filetype specific functionality is usually |
| 19180 | 678 available in the form ft-<filetype>-<functionality>. So > |
| 679 :help ft-c-syntax | |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
680 < talks about the C syntax file and the option it provides. Sometimes, |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
681 additional sections for omni completion > |
| 19180 | 682 :help ft-php-omni |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
683 < or filetype plugins > |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
684 :help ft-tex-plugin |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
685 < are available. |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
686 |
|
7659
07f11de5efca
commit https://github.com/vim/vim/commit/85084ef1e999dcf50e8d466106a33bac24a0febb
Christian Brabandt <cb@256bit.org>
parents:
7597
diff
changeset
|
687 26) Error and Warning codes can be looked up directly in the help. So > |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
688 :help E297 |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
689 < takes you exactly to the description of the swap error message and > |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
690 :help W10 |
|
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
691 < talks about the warning "Changing a readonly file". |
| 18719 | 692 Sometimes, however, those error codes are not described, but rather are |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
693 listed at the Vim command that usually causes this. So: > |
| 19180 | 694 :help E128 |
|
7597
3012eaddb6b2
commit https://github.com/vim/vim/commit/345efa013dc6d1754ba06e5596a26c48c9935937
Christian Brabandt <cb@256bit.org>
parents:
6741
diff
changeset
|
695 < takes you to the |:function| command |
| 1121 | 696 |
| 697 | |
| 7 | 698 ============================================================================== |
| 699 | |
| 700 Next chapter: |usr_03.txt| Moving around | |
| 701 | |
| 14519 | 702 Copyright: see |manual-copyright| vim:tw=78:ts=8:noet:ft=help:norl: |