1 *usr_90.txt* For Vim version 7.1. Last change: 2006 Apr 24
3 VIM USER MANUAL - by Bram Moolenaar
8 Before you can use Vim you have to install it. Depending on your system it's
9 simple or easy. This chapter gives a few hints and also explains how
10 upgrading to a new version is done.
15 |90.4| Common installation issues
16 |90.5| Uninstalling Vim
18 Previous chapter: |usr_45.txt| Select your language
19 Table of contents: |usr_toc.txt|
21 ==============================================================================
24 First you have to decide if you are going to install Vim system-wide or for a
25 single user. The installation is almost the same, but the directory where Vim
26 is installed in differs.
27 For a system-wide installation the base directory "/usr/local" is often
28 used. But this may be different for your system. Try finding out where other
29 packages are installed.
30 When installing for a single user, you can use your home directory as the
31 base. The files will be placed in subdirectories like "bin" and "shared/vim".
36 You can get precompiled binaries for many different UNIX systems. There is a
37 long list with links on this page:
39 http://www.vim.org/binaries.html ~
41 Volunteers maintain the binaries, so they are often out of date. It is a
42 good idea to compile your own UNIX version from the source. Also, creating
43 the editor from the source allows you to control which features are compiled.
44 This does require a compiler though.
46 If you have a Linux distribution, the "vi" program is probably a minimal
47 version of Vim. It doesn't do syntax highlighting, for example. Try finding
48 another Vim package in your distribution, or search on the web site.
53 To compile and install Vim, you will need the following:
55 - A C compiler (GCC preferred)
56 - The GZIP program (you can get it from www.gnu.org)
57 - The Vim source and runtime archives
59 To get the Vim archives, look in this file for a mirror near you, this should
60 provide the fastest download:
62 ftp://ftp.vim.org/pub/vim/MIRRORS ~
64 Or use the home site ftp.vim.org, if you think it's fast enough. Go to the
65 "unix" directory and you'll find a list of files there. The version number is
66 embedded in the file name. You will want to get the most recent version.
67 You can get the files for Unix in two ways: One big archive that contains
68 everything, or four smaller ones that each fit on a floppy disk. For version
69 6.1 the single big one is called:
73 You need the bzip2 program to uncompress it. If you don't have it, get the
74 four smaller files, which can be uncompressed with gzip. For Vim 6.1 they are
85 First create a top directory to work in, for example: >
90 Then unpack the archives there. If you have the one big archive, you unpack
93 bzip2 -d -c path/vim-6.1.tar.bz2 | tar xf -
95 Change "path" to where you have downloaded the file. >
97 gzip -d -c path/vim-6.1-src1.tar.gz | tar xf -
98 gzip -d -c path/vim-6.1-src2.tar.gz | tar xf -
99 gzip -d -c path/vim-6.1-rt1.tar.gz | tar xf -
100 gzip -d -c path/vim-6.1-rt2.tar.gz | tar xf -
102 If you are satisfied with getting the default features, and your environment
103 is setup properly, you should be able to compile Vim with just this: >
108 The make program will run configure and compile everything. Further on we
109 will explain how to compile with different features.
110 If there are errors while compiling, carefully look at the error messages.
111 There should be a hint about what went wrong. Hopefully you will be able to
112 correct it. You might have to disable some features to make Vim compile.
113 Look in the Makefile for specific hints for your system.
118 Now you can check if compiling worked OK: >
122 This will run a sequence of test scripts to verify that Vim works as expected.
123 Vim will be started many times and all kinds of text and messages flash by.
124 If it is alright you will finally see:
129 If there are one or two messages about failed tests, Vim might still work, but
130 not perfectly. If you see a lot of error messages or Vim doesn't finish until
131 the end, there must be something wrong. Either try to find out yourself, or
132 find someone who can solve it. You could look in the |maillist-archive| for a
133 solution. If everything else fails, you could ask in the vim |maillist| if
134 someone can help you.
139 If you want to install in your home directory, edit the Makefile and search
144 Remove the # at the start of the line.
145 When installing for the whole system, Vim has most likely already selected
146 a good installation directory for you. You can also specify one, see below.
147 You need to become root for the following.
153 That should move all the relevant files to the right place. Now you can try
154 running vim to verify that it works. Use two simple tests to check if Vim can
155 find its runtime files: >
160 If this doesn't work, use this command to check where Vim is looking for the
165 You can also start Vim with the "-V" argument to see what happens during
170 Don't forget that the user manual assumes you Vim in a certain way. After
171 installing Vim, follow the instructions at |not-compatible| to make Vim work
172 as assumed in this manual.
177 Vim has many ways to select features. One of the simple ways is to edit the
178 Makefile. There are many directions and examples. Often you can enable or
179 disable a feature by uncommenting a line.
180 An alternative is to run "configure" separately. This allows you to
181 specify configuration options manually. The disadvantage is that you have to
182 figure out what exactly to type.
183 Some of the most interesting configure arguments follow. These can also be
184 enabled from the Makefile.
186 --prefix={directory} Top directory where to install Vim.
188 --with-features=tiny Compile with many features disabled.
189 --with-features=small Compile with some features disabled.
190 --with-features=big Compile with more features enabled.
191 --with-features=huge Compile with most features enabled.
192 See |+feature-list| for which feature
193 is enabled in which case.
195 --enable-perlinterp Enable the Perl interface. There are
196 similar arguments for ruby, python and
199 --disable-gui Do not compile the GUI interface.
200 --without-x Do not compile X-windows features.
201 When both of these are used, Vim will
202 not connect to the X server, which
203 makes startup faster.
205 To see the whole list use: >
209 You can find a bit of explanation for each feature, and links for more
210 information here: |feature-list|.
211 For the adventurous, edit the file "feature.h". You can also change the
212 source code yourself!
214 ==============================================================================
217 There are two ways to install the Vim program for Microsoft Windows. You can
218 uncompress several archives, or use a self-installing big archive. Most users
219 with fairly recent computers will prefer the second method. For the first
222 - An archive with binaries for Vim.
223 - The Vim runtime archive.
224 - A program to unpack the zip files.
226 To get the Vim archives, look in this file for a mirror near you, this should
227 provide the fastest download:
229 ftp://ftp.vim.org/pub/vim/MIRRORS ~
231 Or use the home site ftp.vim.org, if you think it's fast enough. Go to the
232 "pc" directory and you'll find a list of files there. The version number is
233 embedded in the file name. You will want to get the most recent version.
234 We will use "61" here, which is version 6.1.
236 gvim61.exe The self-installing archive.
238 This is all you need for the second method. Just launch the executable, and
241 For the first method you must chose one of the binary archives. These are
244 gvim61.zip The normal MS-Windows GUI version.
245 gvim61ole.zip The MS-Windows GUI version with OLE support.
246 Uses more memory, supports interfacing with
247 other OLE applications.
248 vim61w32.zip 32 bit MS-Windows console version. For use in
249 a Win NT/2000/XP console. Does not work well
251 vim61d32.zip 32 bit MS-DOS version. For use in the
252 Win 95/98 console window.
253 vim61d16.zip 16 bit MS-DOS version. Only for old systems.
254 Does not support long filenames.
256 You only need one of them. Although you could install both a GUI and a
257 console version. You always need to get the archive with runtime files.
259 vim61rt.zip The runtime files.
261 Use your un-zip program to unpack the files. For example, using the "unzip"
265 unzip path\gvim61.zip
266 unzip path\vim61rt.zip
268 This will unpack the files in the directory "c:\vim\vim61". If you already
269 have a "vim" directory somewhere, you will want to move to the directory just
271 Now change to the "vim\vim61" directory and run the install program: >
275 Carefully look through the messages and select the options you want to use.
276 If you finally select "do it" the install program will carry out the actions
278 The install program doesn't move the runtime files. They remain where you
281 In case you are not satisfied with the features included in the supplied
282 binaries, you could try compiling Vim yourself. Get the source archive from
283 the same location as where the binaries are. You need a compiler for which a
284 makefile exists. Microsoft Visual C works, but is expensive. The Free
285 Borland command-line compiler 5.5 can be used, as well as the free MingW and
286 Cygwin compilers. Check the file src/INSTALLpc.txt for hints.
288 ==============================================================================
291 If you are running one version of Vim and want to install another, here is
297 When you type "make install" the runtime files will be copied to a directory
298 which is specific for this version. Thus they will not overwrite a previous
299 version. This makes it possible to use two or more versions next to
301 The executable "vim" will overwrite an older version. If you don't care
302 about keeping the old version, running "make install" will work fine. You can
303 delete the old runtime files manually. Just delete the directory with the
304 version number in it and all files below it. Example: >
306 rm -rf /usr/local/share/vim/vim58
308 There are normally no changed files below this directory. If you did change
309 the "filetype.vim" file, for example, you better merge the changes into the
310 new version before deleting it.
312 If you are careful and want to try out the new version for a while before
313 switching to it, install the new version under another name. You need to
314 specify a configure argument. For example: >
316 ./configure --with-vim-name=vim6
318 Before running "make install", you could use "make -n install" to check that
319 no valuable existing files are overwritten.
320 When you finally decide to switch to the new version, all you need to do is
321 to rename the binary to "vim". For example: >
323 mv /usr/local/bin/vim6 /usr/local/bin/vim
328 Upgrading is mostly equal to installing a new version. Just unpack the files
329 in the same place as the previous version. A new directory will be created,
330 e.g., "vim61", for the files of the new version. Your runtime files, vimrc
331 file, viminfo, etc. will be left alone.
332 If you want to run the new version next to the old one, you will have to do
333 some handwork. Don't run the install program, it will overwrite a few files
334 of the old version. Execute the new binaries by specifying the full path.
335 The program should be able to automatically find the runtime files for the
336 right version. However, this won't work if you set the $VIMRUNTIME variable
338 If you are satisfied with the upgrade, you can delete the files of the
339 previous version. See |90.5|.
341 ==============================================================================
342 *90.4* Common installation issues
344 This section describes some of the common problems that occur when installing
345 Vim and suggests some solutions. It also contains answers to many
346 installation questions.
349 Q: I Do Not Have Root Privileges. How Do I Install Vim? (Unix)
351 Use the following configuration command to install Vim in a directory called
354 ./configure --prefix=$HOME
356 This gives you a personal copy of Vim. You need to put $HOME/bin in your
357 path to execute the editor. Also see |install-home|.
360 Q: The Colors Are Not Right on My Screen. (Unix)
362 Check your terminal settings by using the following command in a shell: >
366 If the terminal type listed is not correct, fix it. For more hints, see
367 |06.2|. Another solution is to always use the GUI version of Vim, called
368 gvim. This avoids the need for a correct terminal setup.
371 Q: My Backspace And Delete Keys Don't Work Right
373 The definition of what key sends what code is very unclear for backspace <BS>
374 and Delete <Del> keys. First of all, check your $TERM setting. If there is
375 nothing wrong with it, try this: >
380 In the first line you need to press CTRL-V and then hit the backspace key.
381 In the second line you need to press CTRL-V and then hit the Delete key.
382 You can put these lines in your vimrc file, see |05.1|. A disadvantage is
383 that it won't work when you use another terminal some day. Look here for
384 alternate solutions: |:fixdel|.
387 Q: I Am Using RedHat Linux. Can I Use the Vim That Comes with the System?
389 By default RedHat installs a minimal version of Vim. Check your RPM packages
390 for something named "Vim-enhanced-version.rpm" and install that.
393 Q: How Do I Turn Syntax Coloring On? How do I make plugins work?
395 Use the example vimrc script. You can find an explanation on how to use it
396 here: |not-compatible|.
398 See chapter 6 for information about syntax highlighting: |usr_06.txt|.
401 Q: What Is a Good vimrc File to Use?
403 See the www.vim.org Web site for several good examples.
406 Q: Where Do I Find a Good Vim Plugin?
408 See the Vim-online site: http://vim.sf.net. Many users have uploaded useful
409 Vim scripts and plugins there.
412 Q: Where Do I Find More Tips?
414 See the Vim-online site: http://vim.sf.net. There is an archive with hints
415 from Vim users. You might also want to search in the |maillist-archive|.
417 ==============================================================================
418 *90.5* Uninstalling Vim
420 In the unlikely event you want to uninstall Vim completely, this is how you do
426 When you installed Vim as a package, check your package manager to find out
427 how to remove the package again.
428 If you installed Vim from sources you can use this command: >
432 However, if you have deleted the original files or you used an archive that
433 someone supplied, you can't do this. Do delete the files manually, here is an
434 example for when "/usr/local" was used as the root: >
436 rm -rf /usr/local/share/vim/vim61
437 rm /usr/local/bin/eview
438 rm /usr/local/bin/evim
440 rm /usr/local/bin/gview
441 rm /usr/local/bin/gvim
442 rm /usr/local/bin/gvim
443 rm /usr/local/bin/gvimdiff
444 rm /usr/local/bin/rgview
445 rm /usr/local/bin/rgvim
446 rm /usr/local/bin/rview
447 rm /usr/local/bin/rvim
448 rm /usr/local/bin/rvim
449 rm /usr/local/bin/view
450 rm /usr/local/bin/vim
451 rm /usr/local/bin/vimdiff
452 rm /usr/local/bin/vimtutor
453 rm /usr/local/bin/xxd
454 rm /usr/local/man/man1/eview.1
455 rm /usr/local/man/man1/evim.1
456 rm /usr/local/man/man1/ex.1
457 rm /usr/local/man/man1/gview.1
458 rm /usr/local/man/man1/gvim.1
459 rm /usr/local/man/man1/gvimdiff.1
460 rm /usr/local/man/man1/rgview.1
461 rm /usr/local/man/man1/rgvim.1
462 rm /usr/local/man/man1/rview.1
463 rm /usr/local/man/man1/rvim.1
464 rm /usr/local/man/man1/view.1
465 rm /usr/local/man/man1/vim.1
466 rm /usr/local/man/man1/vimdiff.1
467 rm /usr/local/man/man1/vimtutor.1
468 rm /usr/local/man/man1/xxd.1
473 If you installed Vim with the self-installing archive you can run
474 the "uninstall-gui" program located in the same directory as the other Vim
475 programs, e.g. "c:\vim\vim61". You can also launch it from the Start menu if
476 installed the Vim entries there. This will remove most of the files, menu
477 entries and desktop shortcuts. Some files may remain however, as they need a
478 Windows restart before being deleted.
479 You will be given the option to remove the whole "vim" directory. It
480 probably contains your vimrc file and other runtime files that you created, so
483 Else, if you installed Vim with the zip archives, the preferred way is to use
484 the "uninstal" program (note the missing l at the end). You can find it in
485 the same directory as the "install" program, e.g., "c:\vim\vim61". This
486 should also work from the usual "install/remove software" page.
487 However, this only removes the registry entries for Vim. You have to
488 delete the files yourself. Simply select the directory "vim\vim61" and delete
489 it recursively. There should be no files there that you changed, but you
490 might want to check that first.
491 The "vim" directory probably contains your vimrc file and other runtime
492 files that you created. You might want to keep that.
494 ==============================================================================
496 Table of contents: |usr_toc.txt|
498 Copyright: see |manual-copyright| vim:tw=78:ts=8:ft=help:norl: