README_ami.txt
1README_ami.txt for version 8.2 of Vim: Vi IMproved.
2
3This file explains the installation of Vim on Amiga systems.
4See README.txt for general information about Vim.
5
6
7Unpack the distributed files in the place where you want to keep them. It is
8wise to have a "vim" directory to keep your vimrc file and any other files you
9change. The distributed files go into a subdirectory. This way you can
10easily upgrade to a new version. For example:
11
12 dh0:editors/vim contains your vimrc and modified files
13 dh0:editors/vim/vim54 contains the Vim version 5.4 distributed files
14 dh0:editors/vim/vim55 contains the Vim version 5.5 distributed files
15
16You would then unpack the archives like this:
17
18 cd dh0:editors
19 tar xf t:vim82bin.tar
20 tar xf t:vim82rt.tar
21
22Set the $VIM environment variable to point to the top directory of your Vim
23files. For the above example:
24
25 set VIM=dh0:editors/vim
26
27Vim version 5.4 will look for your vimrc file in $VIM, and for the runtime
28files in $VIM/vim54. See ":help $VIM" for more information.
29
30Make sure the Vim executable is in your search path. Either copy the Vim
31executable to a directory that is in your search path, or (preferred) modify
32the search path to include the directory where the Vim executable is.
33
README_amibin.txt
1README_amibin.txt for version 8.2 of Vim: Vi IMproved.
2
3See "README.txt" for general information about Vim.
4See "README_ami.txt" for installation instructions for the Amiga.
5These files are in the runtime archive (vim82rt.tgz).
6
7
8The Amiga "bin" archive contains the Vim executable for the Amiga. It was
9compiled with "big" features.
10
11Postscript printing is not included to avoid requiring floating point
12computations.
13
README_amisrc.txt
README_bindos.txt
README_dos.txt
1README_dos.txt for version 8.2 of Vim: Vi IMproved.
2
3This file explains the installation of Vim on MS-Windows systems.
4See "README.txt" for general information about Vim.
5
6There are two ways to install Vim:
7A. Use the self-installing .exe file.
8B. Unpack .zip files and run the install.exe program.
9
10
11A. Using the self-installing .exe
12---------------------------------
13
14This is mostly self-explaining. Just follow the prompts and make the
15selections. A few things to watch out for:
16
17- When an existing installation is detected, you are offered to first remove
18 this. The uninstall program is then started while the install program waits
19 for it to complete. Sometimes the windows overlap each other, which can be
20 confusing. Be sure the complete the uninstalling before continuing the
21 installation. Watch the taskbar for uninstall windows.
22
23- When selecting a directory to install Vim, use the same place where other
24 versions are located. This makes it easier to find your _vimrc file. For
25 example "C:\Program Files\vim" or "D:\vim". A name ending in "vim" is
26 preferred.
27
28- After selecting the directory where to install Vim, clicking on "Next" will
29 start the installation.
30
31
32B. Using .zip files
33-------------------
34
35These are the normal steps to install Vim from the .zip archives:
36
371. Go to the directory where you want to put the Vim files. Examples:
38 cd C:\
39 cd D:\editors
40 If you already have a "vim" directory, go to the directory in which it is
41 located. Check the $VIM setting to see where it points to:
42 set VIM
43 For example, if you have
44 C:\vim\vim82
45 do
46 cd C:\
47 Binary and runtime Vim archives are normally unpacked in the same location,
48 on top of each other.
49
502. Unpack the zip archives. This will create a new directory "vim\vim82",
51 in which all the distributed Vim files are placed. Since the directory
52 name includes the version number, it is unlikely that you overwrite
53 existing files.
54 Examples:
55 pkunzip -d gvim82.zip
56 unzip vim82w32.zip
57
58 You need to unpack the runtime archive and at least one of the binary
59 archives. When using more than one binary version, be careful not to
60 overwrite one version with the other, the names of the executables
61 "vim.exe" and "gvim.exe" are the same.
62
63 After you unpacked the files, you can still move the whole directory tree
64 to another location. That is where they will stay, the install program
65 won't move or copy the runtime files.
66
673. Change to the new directory:
68 cd vim\vim82
69 Run the "install.exe" program. It will ask you a number of questions about
70 how you would like to have your Vim setup. Among these are:
71 - You can tell it to write a "_vimrc" file with your preferences in the
72 parent directory.
73 - It can also install an "Edit with Vim" entry in the Windows Explorer
74 popup menu.
75 - You can have it create batch files, so that you can run Vim from the
76 console or in a shell. You can select one of the directories in your
77 $PATH. If you skip this, you can add Vim to the search path manually:
78 The simplest is to add a line to your autoexec.bat. Examples:
79 set path=%path%;C:\vim\vim82
80 set path=%path%;D:\editors\vim\vim82
81 - Create entries for Vim on the desktop and in the Start menu.
82
83That's it!
84
85
86Remarks:
87
88- If Vim can't find the runtime files, ":help" won't work and the GUI version
89 won't show a menubar. Then you need to set the $VIM environment variable to
90 point to the top directory of your Vim files. Example:
91 set VIM=C:\editors\vim
92 Vim version 8.2 will look for your vimrc file in $VIM, and for the runtime
93 files in $VIM/vim82. See ":help $VIM" for more information.
94
95- To avoid confusion between distributed files of different versions and your
96 own modified vim scripts, it is recommended to use this directory layout:
97 ("C:\vim" is used here as the root, replace it with the path you use)
98 Your own files:
99 C:\vim\_vimrc Your personal vimrc.
100 C:\vim\_viminfo Dynamic info for 'viminfo'.
101 C:\vim\vimfiles\ftplugin\*.vim Filetype plugins
102 C:\vim\... Other files you made.
103 Distributed files:
104 C:\vim\vim82\vim.exe The Vim version 8.2 executable.
105 C:\vim\vim82\doc\*.txt The version 8.2 documentation files.
106 C:\vim\vim82\bugreport.vim A Vim version 8.2 script.
107 C:\vim\vim82\... Other version 8.2 distributed files.
108 In this case the $VIM environment variable would be set like this:
109 set VIM=C:\vim
110 Then $VIMRUNTIME will automatically be set to "$VIM\vim82". Don't add
111 "vim82" to $VIM, that won't work.
112
113- You can put your Vim executable anywhere else. If the executable is not
114 with the other Vim files, you should set $VIM. The simplest is to add a line
115 to your autoexec.bat. Examples:
116 set VIM=c:\vim
117 set VIM=d:\editors\vim
118
119- If you have told the "install.exe" program to add the "Edit with Vim" menu
120 entry, you can remove it by running the "uninstall.exe". See
121 ":help win32-popup-menu".
122
123- In Windows 95/98/NT you can create a shortcut to Vim. This works for all
124 DOS and Win32 console versions. For the console version this gives you the
125 opportunity to set defaults for the Console where Vim runs in.
126
127 1. On the desktop, click right to get a menu. Select New/Shortcut.
128 2. In the dialog, enter Command line: "C:\command.com". Click "Next".
129 3. Enter any name. Click "Finish".
130 The new shortcut will appear on the desktop.
131 4. With the mouse pointer on the new shortcut, click right to get a menu.
132 Select Properties.
133 5. In the Program tab, change the "Cmdline" to add "/c" and the name of the
134 Vim executable. Examples:
135 C:\command.com /c C:\vim\vim82\vim.exe
136 C:\command.com /c D:\editors\vim\vim82\vim.exe
137 6. Select the font, window size, etc. that you like. If this isn't
138 possible, select "Advanced" in the Program tab, and deselect "MS-DOS
139 mode".
140 7. Click OK.
141
142 For gvim, you can use a normal shortcut on the desktop, and set the size of
143 the Window in your $VIM/_gvimrc:
144 set lines=30 columns=90
145
146
147For further information, type one of these inside Vim:
148 :help dos
149 :help win32
150
README_extra.txt
README_haiku.txt
1README_haiku.txt for version 8.2 of Vim: Vi IMproved.
2
3This file explains the installation of Vim on Haiku operating system.
4See "README.txt" for general information about Vim.
5
6Preferred (and easy) way to get Vim on Haiku is to use default Haiku
7software repository HaikuPorts. To get Vim:
8
9- Open HaikuDepot application and search for "vim" package, then install,
10- Open a Terminal and type "pkgman install vim", then follow instructions.
11
12If you prefer to install Vim from source, follow the instructions on
13"runtime/doc/os_haiku.txt", "Compiling Vim" section.
14
README_mac.txt
README_ole.txt
1README_ole.txt for version 8.2 of Vim: Vi IMproved.
2
3This archive contains gvim.exe with OLE interface and VisVim.
4This version of gvim.exe can also load a number of interface dynamically (you
5can optionally install the .dll files for each interface).
6It is only for MS-Windows 95/98/ME/NT/2000/XP.
7
8Also see the README_bindos.txt, README_dos.txt and README.txt files.
9
10Be careful not to overwrite the OLE gvim.exe with the non-OLE gvim.exe when
11unpacking another binary archive! Check the output of ":version":
12 Win32s - "MS-Windows 16/32 bit GUI version"
13 Win32 - "MS-Windows 32 bit GUI version"
14Win32 with OLE - "MS-Windows 32 bit GUI version with OLE support"
15
16For further information, type this inside Vim:
17 :help if_ole
18
19Furthermore, this archive contains VISVIM.DLL. It can be used to integrate
20the OLE gvim with Microsoft Visual Developer Studio. See VisVim/README.txt.
21
README_os2.txt
1README_os2.txt for version 8.2 of Vim: Vi IMproved.
2
3This file used to explain the installation of Vim on OS/2 systems.
4However, support for OS/2 has been removed in patch 7.4.1008.
5See "README.txt" for general information about Vim.
6
README_os390.txt
1README_os390.txt for version 8.2 of Vim: Vi IMproved.
2
3This readme explains how to build Vim on z/OS. Formerly called OS/390.
4See "README.txt" for general information about Vim.
5
6Most likely there are not many users out there using Vim on z/OS. So chances
7are good, that some bugs are still undiscovered.
8
9Getting the source to z/OS:
10==========================
11
12First get the source code in one big tar file and ftp it a binary to z/OS. If
13the tar file is initially compressed with gzip (tar.gz) or bzip2 (tar.bz2)
14uncompress it on your PC, as these tools are (most likely) not available on
15the mainframe.
16
17To reduce the size of the tar file you might compress it into a zip file. On
18z/OS Unix you might have the command "jar" from java to uncompress a zip. Use:
19 jar xvf <zip file name>
20
21Unpack the tar file on z/OS with
22 pax -o from=ISO8859-1,to=IBM-1047 -rf vim.tar
23
24Note: The Vim source contains a few bitmaps etc which will be destroyed by
25this command, but these files are not needed on zOS (at least not for the
26console version).
27
28
29Compiling:
30==========
31
32Vim can be compiled with or without GUI support. For 7.4 only the compilation
33without GUI was tested. Below is a section about compiling with X11 but this
34is from an earlier version of Vim.
35
36Console only:
37-------------
38
39If you build VIM without X11 support, compiling and building is nearly
40straightforward.
41
42Change to the vim directory and do:
43
44 # Don't use c89!
45 # Allow intermixing of compiler options and files.
46
47 $ export CC=cc
48 $ export _CC_CCMODE=1
49 $./configure --with-features=big --without-x --enable-gui=no
50 $ cd src
51 $ make
52
53 There may be warnings:
54 - include files not found (libc, sys/param.h, ...)
55 - Redeclaration of ... differs from ...
56 -- just ignore them.
57
58 $ make test
59
60 This will produce lots of garbage on your screen (including error
61 messages). Don't worry.
62
63 If the test stops at one point in vim (might happen in test 11), just
64 press :q!
65
66 Expected test failures:
67 11: If you don't have gzip installed
68 24: test of backslash sequences in regexp are ASCII dependent
69 42: Multibyte is not supported on z/OS
70 55: ASCII<->EBCDIC sorting
71 57: ASCII<->EBCDIC sorting
72 58: Spell checking is not supported with EBCDIC
73 71: Blowfish encryption doesn't work
74
75 $ make install
76
77
78With X11:
79---------
80
81WARNING: This instruction was not tested with Vim 7.4 or later.
82
83There are two ways for building VIM with X11 support. The first way is simple
84and results in a big executable (~13 Mb), the second needs a few additional
85steps and results in a much smaller executable (~4.5 Mb). These examples
86assume you want Motif.
87
88 The easy way:
89 $ export CC=cc
90 $ export _CC_CCMODE=1
91 $ ./configure --enable-max-features --enable-gui=motif
92 $ cd src
93 $ make
94
95 With this VIM is linked statically with the X11 libraries.
96
97 The smarter way:
98 Make VIM as described above. Then create a file named 'link.sed' with the
99 following content (see src/link.390):
100
101 s/-lXext *//g
102 s/-lXmu *//g
103 s/-lXm */\/usr\/lib\/Xm.x /g
104 s/-lX11 */\/usr\/lib\/X11.x /g
105 s/-lXt *//g
106 s/-lSM */\/usr\/lib\/SM.x /g
107 s/-lICE */\/usr\/lib\/ICE.x /g
108
109 Then do:
110 $ rm vim
111 $ make
112
113 Now Vim is linked with the X11-DLLs.
114
115 See the Makefile and the file link.sh on how link.sed is used.
116
117
118
README_src.txt
1README_src.txt for version 8.2 of Vim: Vi IMproved.
2
3The source archive contains the files needed to compile Vim on Unix systems.
4It is packed for Unix systems (NL line separator).
5
6For more information, see the README.txt file that comes with the runtime
7archive (vim-8.2-rt.tar.gz). To be able to run Vim you MUST get the runtime
8archive too!
9
README_srcdos.txt
1README_srcdos.txt for version 8.2 of Vim: Vi IMproved.
2
3See "README.txt" for general information about Vim.
4See "README_dos.txt" for installation instructions for MS-Windows.
5These files are in the runtime archive (vim82rt.zip).
6
7
8The DOS source archive contains the files needed to compile Vim on MS-Windows.
9It is packed for MS-Windows systems, with CR-LF. It also includes the VisVim
10sources.
11
12See "src/INSTALLpc.txt" for instructions on how to compile Vim on the PC.
13
README_unix.txt
1README_unix.txt for version 8.2 of Vim: Vi IMproved.
2
3This file explains the installation of Vim on Unix systems.
4See "README.txt" for general information about Vim.
5
6
7When you use the source distribution, "make install" is used to install Vim.
8See the "INSTALL" file in the "src" directory.
9
10If you use a compiled package, follow the instructions for the package.
11
README_vms.txt
README_w32s.txt
1README_w32s.txt for version 8.2 of Vim: Vi IMproved.
2
3This file used to explain the installation of Vim on MS-Windows 3.1 and 3.11
4systems. However, support for MS-Windows 3.1 and 3.11 has been removed in
5patch 7.4.1364.
6See "README.txt" for general information about Vim.
7