Mercurial > vim
annotate runtime/doc/usr_01.txt @ 22467:e841e4b7ef2a
Added tag v8.2.1781 for changeset 18f400b24f5f7ac9b36ca0ac76feff29cd33dae8
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Thu, 01 Oct 2020 20:15:05 +0200 |
| parents | ccd16426a1f9 |
| children | f8116058ca76 |
| rev | line source |
|---|---|
| 18879 | 1 *usr_01.txt* For Vim version 8.2. Last change: 2019 Nov 21 |
| 7 | 2 |
| 3 VIM USER MANUAL - by Bram Moolenaar | |
| 4 | |
| 5 About the manuals | |
| 6 | |
| 7 | |
| 8 This chapter introduces the manuals available with Vim. Read this to know the | |
| 9 conditions under which the commands are explained. | |
| 10 | |
| 11 |01.1| Two manuals | |
| 12 |01.2| Vim installed | |
| 13 |01.3| Using the Vim tutor | |
| 14 |01.4| Copyright | |
| 15 | |
| 16 Next chapter: |usr_02.txt| The first steps in Vim | |
| 17 Table of contents: |usr_toc.txt| | |
| 18 | |
| 19 ============================================================================== | |
| 20 *01.1* Two manuals | |
| 21 | |
| 22 The Vim documentation consists of two parts: | |
| 23 | |
| 24 1. The User manual | |
| 25 Task oriented explanations, from simple to complex. Reads from start to | |
| 26 end like a book. | |
| 27 | |
| 28 2. The Reference manual | |
| 29 Precise description of how everything in Vim works. | |
| 30 | |
| 31 The notation used in these manuals is explained here: |notation| | |
| 32 | |
| 33 | |
| 34 JUMPING AROUND | |
| 35 | |
| 36 The text contains hyperlinks between the two parts, allowing you to quickly | |
| 37 jump between the description of an editing task and a precise explanation of | |
| 38 the commands and options used for it. Use these two commands: | |
| 39 | |
| 40 Press CTRL-] to jump to a subject under the cursor. | |
| 41 Press CTRL-O to jump back (repeat to go further back). | |
| 42 | |
| 2642 | 43 Many links are in vertical bars, like this: |bars|. The bars themselves may |
| 18719 | 44 be hidden or invisible; see below. An option name, like 'number', a command |
| 2642 | 45 in double quotes like ":write" and any other word can also be used as a link. |
| 46 Try it out: Move the cursor to CTRL-] and press CTRL-] on it. | |
| 7 | 47 |
| 18719 | 48 Other subjects can be found with the ":help" command; see |help.txt|. |
| 7 | 49 |
| 2642 | 50 The bars and stars are usually hidden with the |conceal| feature. They also |
| 51 use |hl-Ignore|, using the same color for the text as the background. You can | |
| 52 make them visible with: > | |
| 53 :set conceallevel=0 | |
| 54 :hi link HelpBar Normal | |
| 55 :hi link HelpStar Normal | |
| 56 | |
| 7 | 57 ============================================================================== |
| 58 *01.2* Vim installed | |
| 59 | |
| 60 Most of the manuals assume that Vim has been properly installed. If you | |
| 61 didn't do that yet, or if Vim doesn't run properly (e.g., files can't be found | |
| 62 or in the GUI the menus do not show up) first read the chapter on | |
| 63 installation: |usr_90.txt|. | |
| 64 *not-compatible* | |
| 65 The manuals often assume you are using Vim with Vi-compatibility switched | |
| 66 off. For most commands this doesn't matter, but sometimes it is important, | |
| 1125 | 67 e.g., for multi-level undo. An easy way to make sure you are using a nice |
| 68 setup is to copy the example vimrc file. By doing this inside Vim you don't | |
| 69 have to check out where it is located. How to do this depends on the system | |
| 70 you are using: | |
| 7 | 71 |
| 72 Unix: > | |
| 73 :!cp -i $VIMRUNTIME/vimrc_example.vim ~/.vimrc | |
|
18912
ccd16426a1f9
patch 8.2.0017: OS/2 and MS-DOS are still mentioned
Bram Moolenaar <Bram@vim.org>
parents:
18879
diff
changeset
|
74 MS-Windows: > |
| 7 | 75 :!copy $VIMRUNTIME/vimrc_example.vim $VIM/_vimrc |
| 76 Amiga: > | |
| 77 :!copy $VIMRUNTIME/vimrc_example.vim $VIM/.vimrc | |
| 78 | |
| 79 If the file already exists you probably want to keep it. | |
| 80 | |
| 81 If you start Vim now, the 'compatible' option should be off. You can check it | |
| 82 with this command: > | |
| 83 | |
| 84 :set compatible? | |
| 85 | |
| 86 If it responds with "nocompatible" you are doing well. If the response is | |
| 87 "compatible" you are in trouble. You will have to find out why the option is | |
| 88 still set. Perhaps the file you wrote above is not found. Use this command | |
| 89 to find out: > | |
| 90 | |
| 91 :scriptnames | |
| 92 | |
| 93 If your file is not in the list, check its location and name. If it is in the | |
| 94 list, there must be some other place where the 'compatible' option is switched | |
| 95 back on. | |
| 96 | |
| 97 For more info see |vimrc| and |compatible-default|. | |
| 98 | |
| 99 Note: | |
| 100 This manual is about using Vim in the normal way. There is an | |
| 101 alternative called "evim" (easy Vim). This is still Vim, but used in | |
| 102 a way that resembles a click-and-type editor like Notepad. It always | |
| 103 stays in Insert mode, thus it feels very different. It is not | |
| 18719 | 104 explained in the user manual, since it should be mostly |
| 105 self-explanatory. See |evim-keys| for details. | |
| 7 | 106 |
| 107 ============================================================================== | |
| 108 *01.3* Using the Vim tutor *tutor* *vimtutor* | |
| 109 | |
| 110 Instead of reading the text (boring!) you can use the vimtutor to learn your | |
| 18719 | 111 first Vim commands. This is a 30-minute tutorial that teaches the most basic |
| 7 | 112 Vim functionality hands-on. |
| 113 | |
| 24 | 114 On Unix, if Vim has been properly installed, you can start it from the shell: |
| 7 | 115 > |
| 116 vimtutor | |
| 117 | |
| 24 | 118 On MS-Windows you can find it in the Program/Vim menu. Or execute |
| 119 vimtutor.bat in the $VIMRUNTIME directory. | |
| 120 | |
| 7 | 121 This will make a copy of the tutor file, so that you can edit it without |
| 122 the risk of damaging the original. | |
| 123 There are a few translated versions of the tutor. To find out if yours is | |
| 124 available, use the two-letter language code. For French: > | |
| 125 | |
| 126 vimtutor fr | |
| 127 | |
| 1622 | 128 On Unix, if you prefer using the GUI version of Vim, use "gvimtutor" or |
| 129 "vimtutor -g" instead of "vimtutor". | |
| 130 | |
| 7 | 131 For OpenVMS, if Vim has been properly installed, you can start vimtutor from a |
| 132 VMS prompt with: > | |
| 133 | |
| 134 @VIM:vimtutor | |
| 135 | |
| 136 Optionally add the two-letter language code as above. | |
| 137 | |
| 138 | |
| 139 On other systems, you have to do a little work: | |
| 140 | |
| 141 1. Copy the tutor file. You can do this with Vim (it knows where to find it): | |
| 142 > | |
|
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
143 vim --clean -c 'e $VIMRUNTIME/tutor/tutor' -c 'w! TUTORCOPY' -c 'q' |
| 7 | 144 < |
| 145 This will write the file "TUTORCOPY" in the current directory. To use a | |
| 146 translated version of the tutor, append the two-letter language code to the | |
| 147 filename. For French: | |
| 148 > | |
|
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
149 vim --clean -c 'e $VIMRUNTIME/tutor/tutor.fr' -c 'w! TUTORCOPY' -c 'q' |
| 7 | 150 < |
| 151 2. Edit the copied file with Vim: | |
| 152 > | |
|
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
153 vim --clean TUTORCOPY |
| 7 | 154 < |
|
11666
5cd9ba96561d
patch 8.0.0716: not easy to start Vim cleanly
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
155 The --clean argument makes sure Vim is started with nice defaults. |
| 7 | 156 |
| 157 3. Delete the copied file when you are finished with it: | |
| 158 > | |
| 159 del TUTORCOPY | |
| 160 < | |
| 161 ============================================================================== | |
| 162 *01.4* Copyright *manual-copyright* | |
| 163 | |
| 164 The Vim user manual and reference manual are Copyright (c) 1988-2003 by Bram | |
| 237 | 165 Moolenaar. This material may be distributed only subject to the terms and |
| 7 | 166 conditions set forth in the Open Publication License, v1.0 or later. The |
| 167 latest version is presently available at: | |
| 1125 | 168 http://www.opencontent.org/openpub/ |
| 7 | 169 |
| 170 People who contribute to the manuals must agree with the above copyright | |
| 171 notice. | |
| 172 *frombook* | |
| 173 Parts of the user manual come from the book "Vi IMproved - Vim" by Steve | |
| 174 Oualline (published by New Riders Publishing, ISBN: 0735710015). The Open | |
| 175 Publication License applies to this book. Only selected parts are included | |
| 176 and these have been modified (e.g., by removing the pictures, updating the | |
| 1125 | 177 text for Vim 6.0 and later, fixing mistakes). The omission of the |frombook| |
| 178 tag does not mean that the text does not come from the book. | |
| 7 | 179 |
| 180 Many thanks to Steve Oualline and New Riders for creating this book and | |
| 181 publishing it under the OPL! It has been a great help while writing the user | |
| 182 manual. Not only by providing literal text, but also by setting the tone and | |
| 183 style. | |
| 184 | |
| 185 If you make money through selling the manuals, you are strongly encouraged to | |
| 186 donate part of the profit to help AIDS victims in Uganda. See |iccf|. | |
| 187 | |
| 188 ============================================================================== | |
| 189 | |
| 190 Next chapter: |usr_02.txt| The first steps in Vim | |
| 191 | |
| 14519 | 192 Copyright: see |manual-copyright| vim:tw=78:ts=8:noet:ft=help:norl: |