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