| 1 |
INSTALL - Installation of Vim on different machines. |
| 2 |
|
| 3 |
This file contains instructions for compiling Vim. If you already have an |
| 4 |
executable version of Vim, you don't need this. |
| 5 |
|
| 6 |
Contents: |
| 7 |
1. Generic |
| 8 |
2. Unix |
| 9 |
3. OS/2 (with EMX 0.9b) |
| 10 |
4. Atari MiNT |
| 11 |
|
| 12 |
See INSTALLami.txt for Amiga |
| 13 |
See INSTALLmac.txt for Macintosh |
| 14 |
See INSTALLpc.txt for PC (Windows XP/Vista/7/8/10) |
| 15 |
See INSTALLvms.txt for VMS |
| 16 |
See INSTALLx.txt for cross-compiling on Unix |
| 17 |
See ../READMEdir/README_390.txt for z/OS and OS/390 Unix |
| 18 |
See ../runtime/doc/os_haiku.txt for Haiku |
| 19 |
|
| 20 |
1. Generic |
| 21 |
========== |
| 22 |
|
| 23 |
If you compile Vim without specifying anything, you will get the default |
| 24 |
behaviour as is documented, which should be fine for most people. |
| 25 |
|
| 26 |
For features that you can't enable/disable in another way, you can edit the |
| 27 |
file "feature.h" to match your preferences. |
| 28 |
|
| 29 |
|
| 30 |
2. Unix |
| 31 |
======= |
| 32 |
|
| 33 |
Summary: |
| 34 |
1. make run configure, compile and link |
| 35 |
2. make install installation in /usr/local |
| 36 |
|
| 37 |
This will include the GUI and X11 libraries, if you have them. If you want a |
| 38 |
version of Vim that is small and starts up quickly, see the Makefile for how |
| 39 |
to disable the GUI and X11. If you don't have GUI libraries and/or X11, these |
| 40 |
features will be disabled automatically. |
| 41 |
|
| 42 |
To build Vim on Ubuntu from scratch on a clean system using git: |
| 43 |
Install tools required to be able to get and build Vim: |
| 44 |
% sudo apt install git |
| 45 |
% sudo apt install make |
| 46 |
% sudo apt install clang |
| 47 |
% sudo apt install libtool-bin |
| 48 |
|
| 49 |
Build Vim with default features: |
| 50 |
% git clone https://github.com/vim/vim.git |
| 51 |
% cd vim/src |
| 52 |
% make |
| 53 |
|
| 54 |
Run tests to check there are no problems: |
| 55 |
% make test |
| 56 |
|
| 57 |
Install Vim in /usr/local: |
| 58 |
% sudo make install |
| 59 |
|
| 60 |
Add X windows clipboard support (also needed for GUI): |
| 61 |
% sudo apt install libxt-dev |
| 62 |
% make reconfig |
| 63 |
|
| 64 |
Add Wayland clipboard support: |
| 65 |
% sudo apt install libwayland-dev |
| 66 |
% make reconfig |
| 67 |
|
| 68 |
Add GUI (GTK3) support: |
| 69 |
% sudo apt install libgtk-3-dev |
| 70 |
% make reconfig |
| 71 |
|
| 72 |
Add GUI (GTK4) support: |
| 73 |
% sudo apt install libgtk-4-dev |
| 74 |
(GTK4 is not the default; configure with |
| 75 |
--enable-gui=gtk4 to select it.) |
| 76 |
% make reconfig |
| 77 |
|
| 78 |
Add Python 3 support: |
| 79 |
% sudo apt install libpython3-dev |
| 80 |
Uncomment this line in Makefile: |
| 81 |
"CONF_OPT_PYTHON3 = --enable-python3interp" |
| 82 |
% make reconfig |
| 83 |
|
| 84 |
Debugging: |
| 85 |
% sudo apt install valgrind |
| 86 |
Uncomment this line in Makefile: |
| 87 |
CFLAGS = -g -Wall -Wextra -Wshadow -Wmissing-prototypes -Wunreachable-code -Wno-deprecated-declarations -U_FORTIFY_SOURCE -D_FORTIFY_SOURCE=1 |
| 88 |
% make reconfig |
| 89 |
% make test_{test-name} |
| 90 |
See output in testdir/valgrind.test_{test-name} |
| 91 |
|
| 92 |
|
| 93 |
See the start of Makefile for more detailed instructions about how to compile |
| 94 |
Vim. |
| 95 |
|
| 96 |
If you need extra compiler and/or linker arguments, set $CFLAGS and/or $LIBS |
| 97 |
before starting configure. Example: |
| 98 |
|
| 99 |
env CFLAGS=-I/usr/local/include LIBS=-lm make |
| 100 |
|
| 101 |
This is only needed for things that configure doesn't offer a specific argument |
| 102 |
for or figures out by itself. First try running configure without extra |
| 103 |
arguments. |
| 104 |
|
| 105 |
GNU Autoconf and a few other tools have been used to make Vim work on many |
| 106 |
different Unix systems. The advantage of this is that Vim should compile |
| 107 |
on most systems without any adjustments. The disadvantage is that when |
| 108 |
adjustments are required, it takes some time to understand what is happening. |
| 109 |
|
| 110 |
If configure finds all library files and then complains when linking that some |
| 111 |
of them can't be found, your linker doesn't return an error code for missing |
| 112 |
libraries. Vim should be linked fine anyway, mostly you can just ignore these |
| 113 |
errors. |
| 114 |
|
| 115 |
If you run configure by hand (not using the Makefile), remember that any |
| 116 |
changes in the Makefile have no influence on configure. This may be what you |
| 117 |
want, but maybe not! |
| 118 |
|
| 119 |
The advantage of running configure separately, is that you can write a script |
| 120 |
to build Vim, without changing the Makefile or feature.h. Example (using sh): |
| 121 |
|
| 122 |
CFLAGS=-DCOMPILER_FLAG ./configure --enable-gui=motif |
| 123 |
|
| 124 |
One thing to watch out for: If the configure script itself changes, running |
| 125 |
"make" will execute it again, but without your arguments. Do "make clean" and |
| 126 |
run configure again. |
| 127 |
|
| 128 |
If you are compiling Vim for several machines, for each machine: |
| 129 |
a. make shadow |
| 130 |
b. mv shadow machine_name |
| 131 |
c. cd machine_name |
| 132 |
d. make; make install |
| 133 |
|
| 134 |
[Don't use a path for machine_name, just a directory name, otherwise the links |
| 135 |
that "make shadow" creates won't work.] |
| 136 |
|
| 137 |
|
| 138 |
Unix: COMPILING WITH/WITHOUT GUI |
| 139 |
|
| 140 |
NOTE: This is incomplete, look in Makefile for more info. |
| 141 |
|
| 142 |
These configure arguments can be used to select which GUI to use: |
| 143 |
--enable-gui=gtk or: gtk2, motif, athena or auto |
| 144 |
--disable-gtk-check |
| 145 |
--disable-motif-check |
| 146 |
--disable-athena-check |
| 147 |
|
| 148 |
This configure argument can be used to disable the GUI, even when the necessary |
| 149 |
files are found: |
| 150 |
--disable-gui |
| 151 |
|
| 152 |
--enable-gui defaults to "auto", so it will automatically look for a GUI (in |
| 153 |
the order of GTK, Motif, then Athena). If one is found, then it is used and |
| 154 |
does not proceed to check any of the remaining ones. Otherwise, it moves on |
| 155 |
to the next one. |
| 156 |
|
| 157 |
--enable-{gtk,gtk2,kde,motif,athena}-check all default to "yes", such that if |
| 158 |
--enable-gui is "auto" (which it is by default), GTK, Motif, and Athena will |
| 159 |
be checked for. If you want to *exclude* a certain check, then you use |
| 160 |
--disable-{gtk,gtk2,kde,motif,athena}-check. |
| 161 |
|
| 162 |
For example, if --enable-gui is set to "auto", but you don't want it look for |
| 163 |
Motif, you then also specify --disable-motif-check. This results in only |
| 164 |
checking for GTK and Athena. |
| 165 |
|
| 166 |
Lastly, if you know which one you want to use, then you can just do |
| 167 |
--enable-gui={gtk,gtk2,kde,motif,athena}. So if you wanted to only use Motif, |
| 168 |
then you'd specify --enable-gui=motif. Once you specify what you want, the |
| 169 |
--enable-{gtk,gtk2,kde,motif,athena}-check options are ignored. |
| 170 |
|
| 171 |
On Linux you usually need GUI "-devel" packages. You may already have GTK |
| 172 |
libraries installed, but that doesn't mean you can compile Vim with GTK, you |
| 173 |
also need the header files. |
| 174 |
|
| 175 |
For compiling with the GTK+ GUI, you need a recent version of glib and gtk+. |
| 176 |
Configure checks for at least version 1.1.16. An older version is not selected |
| 177 |
automatically. If you want to use it anyway, run configure with |
| 178 |
"--disable-gtktest". |
| 179 |
GTK requires an ANSI C compiler. If you fail to compile Vim with GTK+ (it |
| 180 |
is the preferred choice), try selecting another one in the Makefile. |
| 181 |
If you are sure you have GTK installed, but for some reason configure says you |
| 182 |
do not, you may have left-over header files and/or library files from an older |
| 183 |
(and incompatible) version of GTK. if this is the case, please check |
| 184 |
auto/config.log for any error messages that may give you a hint as to what's |
| 185 |
happening. |
| 186 |
|
| 187 |
There used to be a KDE version of Vim, using Qt libraries, but since it didn't |
| 188 |
work very well and there was no maintainer it was dropped. |
| 189 |
|
| 190 |
|
| 191 |
Unix: PUTTING vimrc IN /etc |
| 192 |
|
| 193 |
Some Linux distributions prefer to put the global vimrc file in /etc, and the |
| 194 |
Vim runtime files in /usr. This can be done with: |
| 195 |
./configure --prefix=/usr |
| 196 |
make VIMRCLOC=/etc VIMRUNTIMEDIR=/usr/share/vim MAKE="make -e" |
| 197 |
|
| 198 |
Unix: LOCAL HEADERS AND LIBRARIES NOT IN /usr/local |
| 199 |
|
| 200 |
Sometimes it is necessary to search different path than /usr/local for locally |
| 201 |
installed headers (/usr/local/include) and libraries (/usr/local/lib). |
| 202 |
To search /stranger/include and /stranger/lib for locally installed |
| 203 |
headers and libraries, use: |
| 204 |
./configure --with-local-dir=/stranger |
| 205 |
And to not search for locally installed headers and libraries at all, use: |
| 206 |
./configure --without-local-dir |
| 207 |
|
| 208 |
|
| 209 |
3. OS/2 |
| 210 |
======= |
| 211 |
|
| 212 |
OS/2 support was removed in patch 7.4.1008 |
| 213 |
|
| 214 |
|
| 215 |
4. Atari MiNT |
| 216 |
============= |
| 217 |
|
| 218 |
Atari MiNT support was removed in patch 8.2.1215. |