blob: b875b77c9ae7a6ac6f5cc068b5623a7355c7e1e1 [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001INSTALLpc.txt - Installation of Vim on PC
2
3This file contains instructions for compiling Vim. If you already have an
4executable version of Vim, you don't need this.
5
Bram Moolenaar362e1a32006-03-06 23:29:24 +00006More information can be found here: (Very stale now.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008 http://mywebpage.netscape.com/sharppeople/vim/howto/
Bram Moolenaar071d4272004-06-13 20:20:40 +00009
10The file "feature.h" can be edited to match your preferences. You can skip
11this, then you will get the default behavior as is documented, which should
12be fine for most people.
13
Bram Moolenaar02cfac82016-04-21 14:34:58 +020014This document assumes that you are building Vim for Win32 or later (Windows
15XP/2003/Vista/7/8/10). There are also instructions for pre-XP systems, but
16they might no longer work.
Bram Moolenaar362e1a32006-03-06 23:29:24 +000017
Bram Moolenaar071d4272004-06-13 20:20:40 +000018
19Contents:
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000201. Microsoft Visual C++
212. Using MinGW
223. Cygwin
234. Borland
245. Cross compiling for Win32 from a Linux machine
256. Building with Python support
Bram Moolenaar30a89472016-01-10 14:35:58 +0100267. Building with Python3 support
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100278. Building with MzScheme/Racket support
Bram Moolenaar30a89472016-01-10 14:35:58 +0100289. Building with Lua support
2910. Building with Perl support
3011. Building with Ruby support
3112. Building with Tcl support
Bram Moolenaar8f84c3a2017-07-22 16:14:44 +02003213. Building with Terminal support
3314. Windows 3.1
3415. MS-DOS
Bram Moolenaar362e1a32006-03-06 23:29:24 +000035
Bram Moolenaar8f84c3a2017-07-22 16:14:44 +02003616. Installing after building from sources
Bram Moolenaar734d9982011-07-15 13:52:04 +020037
38
Bram Moolenaarc236c162008-07-13 17:41:49 +000039The currently preferred method is using the free Visual C++ Toolkit 2008
Bram Moolenaar02cfac82016-04-21 14:34:58 +020040|msvc-2008-express|, the produced binary runs on most MS-Windows systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +000041
42
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000431. Microsoft Visual C++
44=======================
45
46Visual Studio
47-------------
48
Bram Moolenaar30a89472016-01-10 14:35:58 +010049Building with Visual Studio (VS 98, VS .NET, VS .NET 2003, VS 2005, VS 2008,
50VS2010, VS2012, VS2013 and VS2015) is straightforward. (These instructions
51should also work for VS 4 and VS 5.)
Bram Moolenaar362e1a32006-03-06 23:29:24 +000052
Bram Moolenaar89eaa412016-07-31 14:17:27 +020053Using VS C++ 2008 Express is recommended, the binaries built with that run on
Bram Moolenaar97cc2382012-10-03 21:46:54 +020054nearly all platforms. Binaries from later versions may not run on Windows 95
55or XP.
56
Bram Moolenaar362e1a32006-03-06 23:29:24 +000057To build Vim from the command line with MSVC, use Make_mvc.mak.
58Visual Studio installed a batch file called vcvars32.bat, which you must
59run to set up paths for nmake and MSVC.
60
Bram Moolenaarc9b4b052006-04-30 18:54:39 +000061nmake -f Make_mvc.mak console Win32 SDK or Microsoft Visual C++
62nmake -f Make_mvc.mak GUI=yes GUI Microsoft Visual C++
63nmake -f Make_mvc.mak OLE=yes OLE Microsoft Visual C++
Bram Moolenaar362e1a32006-03-06 23:29:24 +000064nmake -f Make_mvc.mak PERL=C:\Perl PYTHON=C:\Python etc.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +000065 Perl, Python, etc.
Bram Moolenaar362e1a32006-03-06 23:29:24 +000066
67Make_mvc.mak allows a Vim to be built with various different features and
68debug support. Debugging with MS Devstudio is provided by Make_dvc.mak.
69For a description of the use of Make_dvc.mak, look in Make_mvc.mak.
70
71For compiling Gvim with IME support on far-east Windows, add IME=yes
72to the parameters you pass to Make_mvc.mak.
73
74To build Vim from within the Visual Studio IDE, open the Make_ivc.mak project.
75(Note: Make_ivc.mak is not as rich as Make_mvc.mak, which allows for
76far more configuration.) Make_ivc.mak can also be built with nmake.
77
78nmake -f Make_ivc.mak CFG="Vim - Win32 Release gvim"
Bram Moolenaarc9b4b052006-04-30 18:54:39 +000079 GUI Microsoft Visual C++ 4.x or later
Bram Moolenaar362e1a32006-03-06 23:29:24 +000080nmake -f Make_ivc.mak CFG="Vim - Win32 Release gvim OLE"
Bram Moolenaarc9b4b052006-04-30 18:54:39 +000081 OLE Microsoft Visual C++ 4.x or later
Bram Moolenaar362e1a32006-03-06 23:29:24 +000082
83See the specific files for comments and options.
84
85These files have been supplied by George V. Reilly, Ben Singer, Ken Scott and
86Ron Aaron; they have been tested.
87
88
Bram Moolenaar02cfac82016-04-21 14:34:58 +020089Visual C++ 2008 Express Edition *msvc-2008-express*
90-------------------------------
91
92Visual C++ 2008 Express Edition can be downloaded for free from:
93 http://www.microsoft.com/express/downloads/
94This includes the IDE and the debugger.
95
96To set the environment execute the msvc2008.bat script. You can then build
97Vim with Make_mvc.mak.
98
99For building 64 bit binaries you also need to install the SDK:
100"Microsoft Windows SDK for Windows 7 and .NET Framework 3.5 SP1"
101You don't need the examples and documentation.
102
103If you get an error that Win32.mak can't be found, you have to set the
104variable SDK_INCLUDE_DIR. For example, on Windows 10, installation of MSVC
105puts include files in the following directory:
106 set SDK_INCLUDE_DIR=C:\Program Files\Microsoft SDKs\Windows\v6.0A\Include
107
108
109Visual C++ 2010 Express Edition *msvc-2010-express*
110-------------------------------
111
112Visual C++ 2010 Express Edition can be downloaded for free from:
113 http://www.microsoft.com/express/vc/Default.aspx
114This includes the IDE and the debugger.
115
116To set the environment execute the msvc2010.bat script. You can then build
117Vim with Make_mvc.mak.
118
119
120Targeting Windows XP with new MSVC *new-msvc-windows-xp*
121----------------------------------
122
123Beginning with Visual C++ 2012, Microsoft changed the behavior of LINK.EXE
124so that it targets Windows 6.0 (Vista) by default. In order to override
125this, the target Windows version number needs to be passed to LINK like
126follows:
127 LINK ... /subsystem:console,5.01
128
129Make_mvc.mak now supports a macro SUBSYSTEM_VER to pass the Windows version.
130Use lines like follows to target Windows XP (assuming using Visual C++ 2012
131under 64-bit Windows):
132 set WinSdk71=%ProgramFiles(x86)%\Microsoft SDKs\Windows\v7.1A
133 set SDK_INCLUDE_DIR=%WinSdk71%\Include
134 set INCLUDE=%WinSdk71%\Include;%INCLUDE%
135 set LIB=%WinSdk71%\Lib;%LIB%
136 set PATH=%WinSdk71%\Bin;%PATH%
137 set CL=/D_USING_V110_SDK71_
138 nmake -f Make_mvc.mak ... WINVER=0x0501 SUBSYSTEM_VER=5.01
139
140The following Visual C++ team blog can serve as a reference page:
141 http://blogs.msdn.com/b/vcblog/archive/2012/10/08/windows-xp-targeting-with-c-in-visual-studio-2012.aspx
142
143
144OLDER VERSIONS
145
146The minimal supported version is Windows XP. Building with older compilers
147might still work, but these instructions might be outdated.
148
149If you need the executable to run on Windows 98 or ME, use the 2003 one
150|msvc-2003-toolkit|.
151
Bram Moolenaarc236c162008-07-13 17:41:49 +0000152Visual C++ Toolkit 2003 *msvc-2003-toolkit*
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000153-----------------------
154
Bram Moolenaarc236c162008-07-13 17:41:49 +0000155You could download the Microsoft Visual C++ Toolkit 2003 from
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000156 http://msdn.microsoft.com/visualc/vctoolkit2003/
Bram Moolenaarc236c162008-07-13 17:41:49 +0000157Unfortunately this URL is no longer valid. Inofficial downloads appear to be
158available from links mentioned on these pages (use at your own risk):
159 http://www.filewatcher.com/m/VCToolkitSetup.exe.32952488.0.0.html
160 http://feargame.net/wiki/index.php?title=Building_Source_with_the_VC2003_Toolkit
161
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000162This contains the command-line tools (compiler, linker, CRT headers,
163and libraries) for Visual Studio .NET 2003, but not the Visual Studio IDE.
164To compile and debug Vim with the VC2003 Toolkit, you will also need
165|ms-platform-sdk|, |dotnet-1.1-redist|, |dotnet-1.1-sdk|,
166and |windbg-download|.
167
Bram Moolenaar0fde2902008-03-16 13:54:13 +0000168It's easier to download Visual C++ 2008 Express Edition, |msvc-2008-express|,
169which is freely available in perpetuity.
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000170
171The free Code::Blocks IDE works with the VC2003 Toolkit, as described at
172 http://wiki.codeblocks.org/index.php?title=Integrating_Microsoft_Visual_Toolkit_2003_with_Code::Blocks_IDE
173(This site also takes you through configuring a number of other
174free C compilers for Win32.)
175
176To compile Vim using the VC2003 Toolkit and Make_mvc.mak, you must first
177execute the following commands in a cmd.exe window (the msvcsetup.bat batch
178file can be used):
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000179
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000180 set PATH=%SystemRoot%\Microsoft.NET\Framework\v1.1.4322;%PATH%
181 call "%VCToolkitInstallDir%vcvars32.bat"
182 set MSVCVer=7.1
183 call "%ProgramFiles%\Microsoft Platform SDK\SetEnv.Cmd"
184 set LIB=%ProgramFiles%\Microsoft Visual Studio .NET 2003\Vc7\lib;%LIB%
185
186Now you can build Vim with Make_mvc.mak.
187
188
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000189Getting the Windows Platform SDK *ms-platform-sdk*
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000190
191You will also need a copy of the Windows Platform SDK from
192 http://www.microsoft.com/msdownload/platformsdk/sdkupdate/
193Specifically, you need the Windows Core SDK subset of the Platform SDK,
194which contains the Windows headers and libraries.
195
196
197Getting the .NET Framework 1.1 Runtime *dotnet-1.1-redist*
198
199You need the .NET Framework 1.1 Redistributable Package from
200 http://www.microsoft.com/downloads/details.aspx?familyid=262d25e3-f589-4842-8157-034d1e7cf3a3
201or from Windows Update:
202 http://windowsupdate.microsoft.com/
203This is needed to install |dotnet-1.1-sdk|. It also contains cvtres.exe,
204which is needed to link Vim.
205
206
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000207Getting the .NET Framework 1.1 SDK *dotnet-1.1-sdk*
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000208
209You need the .NET Framework 1.1 SDK from
210 http://www.microsoft.com/downloads/details.aspx?familyid=9b3a2ca6-3647-4070-9f41-a333c6b9181d
211This contains some additional libraries needed to compile Vim,
212such as msvcrt.lib. You must install |dotnet-1.1-redist| before
213installing the .NET 1.1 SDK.
214
215
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000216Getting the WinDbg debugger *windbg-download*
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000217
218The Debugging Tools for Windows can be downloaded from
219 http://www.microsoft.com/whdc/devtools/debugging/default.mspx
220This includes the WinDbg debugger, which you will want if you ever need
221to debug Vim itself. An earlier version of the Debugging Tools
222is also available through the Platform SDK, |ms-platform-sdk|.
223
224
Bram Moolenaar98385dc2008-06-20 14:52:32 +0000225Visual C++ 2005 Express Edition *msvc-2005-express*
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000226-------------------------------
227
Bram Moolenaarfc1421e2006-04-20 22:17:20 +0000228Visual C++ 2005 Express Edition can be downloaded for free from:
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000229 http://msdn.microsoft.com/vstudio/express/visualC/default.aspx
230This includes the IDE and the debugger. You will also need
231|ms-platform-sdk|. You can build Vim with Make_mvc.mak.
232
233Instructions for integrating the Platform SDK into VC Express:
234 http://msdn.microsoft.com/vstudio/express/visualc/usingpsdk/default.aspx
235
236
Bram Moolenaarce2f2e02014-08-22 18:12:57 +0200237
Bram Moolenaar362e1a32006-03-06 23:29:24 +00002382. MinGW
239========
240
241(written by Ron Aaron: <ronaharon@yahoo.com>)
242
243This is about how to produce a Win32 binary of gvim with MinGW.
244
245First, you need to get the 'mingw32' compiler, which is free for the download
246at:
247
248 http://www.mingw.org/
249
Bram Moolenaar4f7e8212014-11-05 13:53:32 +0100250or you can use 'MinGW-w64' compiler.
251
252 http://mingw-w64.sourceforge.net/
253
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100254Or a compiler provided on msys2:
255
256 https://msys2.github.io/
257
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000258Once you have downloaded the compiler binaries, unpack them on your hard disk
259somewhere, and put them on your PATH. If you are on Win95/98 you can edit
260your AUTOEXEC.BAT file with a line like:
261
Bram Moolenaar4f7e8212014-11-05 13:53:32 +0100262 set PATH=C:\MinGW\bin;%PATH%
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000263
264or on NT/2000/XP, go to the Control Panel, (Performance and Maintenance),
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100265System, Advanced, and edit the environment from there. If you use msys2
266compilers, set your installed paths:
267
268 C:\msys2\mingw32\bin
Bram Moolenaar02cfac82016-04-21 14:34:58 +0200269or
270 C:\msys64\mingw32\bin
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100271
272for 32bit. And 64bit:
273
274 C:\msys2\mingw64\bin
Bram Moolenaar02cfac82016-04-21 14:34:58 +0200275or
276 C:\msys64\mingw64\bin
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000277
278Test if gcc is on your path. From a CMD (or COMMAND on '95/98) window:
279
280 C:\> gcc --version
Bram Moolenaar4f7e8212014-11-05 13:53:32 +0100281 gcc (GCC) 4.8.1
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000282
Bram Moolenaar4f7e8212014-11-05 13:53:32 +0100283 C:\> mingw32-make --version
284 GNU Make 3.82.90 (...etc...)
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000285
286Now you are ready to rock 'n' roll. Unpack the vim sources (look on
287www.vim.org for exactly which version of the vim files you need).
288
289Change directory to 'vim\src':
290
291 C:\> cd vim\src
292 C:\VIM\SRC>
293
294and you type:
295
Bram Moolenaar4f7e8212014-11-05 13:53:32 +0100296 mingw32-make -f Make_ming.mak gvim.exe
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000297
298After churning for a while, you will end up with 'gvim.exe' in the 'vim\src'
299directory.
300
301You should not need to do *any* editing of any files to get vim compiled this
302way. If, for some reason, you want the console-mode-only version of vim (this
Bram Moolenaar5e3dae82010-03-02 16:19:40 +0100303is NOT recommended on Win32, especially on '95/'98!!!), you can use:
Bram Moolenaard8e21d32010-01-06 21:16:31 +0100304
Bram Moolenaar4f7e8212014-11-05 13:53:32 +0100305 mingw32-make -f Make_ming.mak GUI=no vim.exe
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000306
307If you are dismayed by how big the EXE is, I strongly recommend you get 'UPX'
308(also free!) and compress the file (typical compression is 50%). UPX can be
309found at
310 http://www.upx.org/
311
Bram Moolenaar91856272012-02-29 16:56:39 +0100312As of 2011, UPX still does not support compressing 64-bit EXE's; if you have
313built a 64-bit vim then an alternative to UPX is 'MPRESS'. MPRESS can be found
314at:
315 http://www.matcode.com/mpress.htm
316
317
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000318ADDITION: NLS support with MinGW
319
320(by Eduardo F. Amatria <eferna1@platea.pntic.mec.es>)
321
322If you want National Language Support, read the file src/po/README_mingw.txt.
323You need to uncomment lines in Make_ming.mak to have NLS defined.
324
325
3263. Cygwin
327=========
328
329Use Make_cyg.mak with Cygwin's GCC. See
330 http://users.skynet.be/antoine.mechelynck/vim/compile.htm
331
Bram Moolenaar4f7e8212014-11-05 13:53:32 +0100332With Cygnus gcc you should use the Unix Makefile instead (you need to get the
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000333Unix archive then). Then you get a Cygwin application (feels like Vim is
Bram Moolenaar48f80c22010-02-24 15:08:27 +0100334running on Unix), while with Make_cyg.mak you get a Windows application (like
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000335with the other makefiles).
336
337
3384. Borland
339===========
340
341Use Make_bc5.mak with Borland C++ 5.x. See
342 http://users.skynet.be/antoine.mechelynck/vim/compile.htm
343
344
3455. Cross compiling for Win32 from a Linux machine
346=================================================
347
348[Update of 1) needs to be verified]
349
350If you like, you can compile the 'mingw' Win32 version from the comfort of
351your Linux (or other unix) box. To do this, you need to follow a few steps:
352 1) Install the mingw32 cross-compiler. See
Bram Moolenaard8e21d32010-01-06 21:16:31 +0100353 http://www.mingw.org/wiki/LinuxCrossMinGW
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000354 http://www.libsdl.org/extras/win32/cross/README.txt
Bram Moolenaara7241f52008-06-24 20:39:31 +0000355 2) Get and unpack both the Unix sources and the extra archive
Bram Moolenaar4f7e8212014-11-05 13:53:32 +0100356 3) in 'Make_cyg_ming.mak', set 'CROSS' to 'yes' instead of 'no'.
357 Make further changes to 'Make_cyg_ming.mak' and 'Make_ming.mak' as you
358 wish. If your cross-compiler prefix differs from the predefined value,
Bram Moolenaard8e21d32010-01-06 21:16:31 +0100359 set 'CROSS_COMPILE' corresponding.
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000360 4) make -f Make_ming.mak gvim.exe
361
362Now you have created the Windows binary from your Linux box! Have fun...
363
364
3656. Building with Python support
366===============================
367
Bram Moolenaar97cc2382012-10-03 21:46:54 +0200368For building with MSVC 2008 the "Windows Installer" from www.python.org
369works fine.
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000370
Bram Moolenaar30a89472016-01-10 14:35:58 +0100371When building, you need to set the following variables at least:
372
373 PYTHON: Where Python is installed. E.g. C:\Python27
374 DYNAMIC_PYTHON: Whether dynamic linking is used. Usually, set to yes.
375 PYTHON_VER: Python version. E.g. 27 for Python 2.7.X.
376
377E.g. When using MSVC (as one line):
378
379 nmake -f Make_mvc.mak
380 PYTHON=C:\Python27 DYNAMIC_PYTHON=yes PYTHON_VER=27
381
Bram Moolenaar97cc2382012-10-03 21:46:54 +0200382(rest written by Ron Aaron: <ronaharon@yahoo.com>)
383
384Building with the mingw32 compiler, and the ActiveState ActivePython:
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000385 http://www.ActiveState.com/Products/ActivePython/
386
387After installing the ActivePython, you will have to create a 'mingw32'
388'libpython20.a' to link with:
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100389 cd $PYTHON/libs
390 pexports python20.dll > python20.def
391 dlltool -d python20.def -l libpython20.a
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000392
393Once that is done, edit the 'Make_ming.mak' so the PYTHON variable points to
394the root of the Python installation (C:\Python20, for example). If you are
395cross-compiling on Linux with the mingw32 setup, you need to also convert all
396the 'Include' files to *unix* line-endings. This bash command will do it
397easily:
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100398 for fil in *.h ; do vim -e -c 'set ff=unix|w|q' $fil
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000399
400Now just do:
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100401 make -f Make_ming.mak gvim.exe
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000402
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100403And if you use msys2 to build python support (as one line):
404
405 mingw32-make -f Make_ming.mak PYTHON=c:/msys64/mingw64
406 PYTHON_HOME=c:/msys64/mingw64
407 PYTHONINC=-Ic:/msys64/mingw64/include/python2.7
408 DYNAMIC_PYTHON=yes
409 PYTHON_VER=27
410 DYNAMIC_PYTHON_DLL=libpython2.7.dll
411 ARCH=x86-64
412 STATIC_STDCPLUS=yes
413
414You will end up with a Python-enabled, Win32 version. Enjoy!
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000415
416
Bram Moolenaar30a89472016-01-10 14:35:58 +01004177. Building with Python3 support
418================================
419
420For building with MSVC 2008 the "Windows Installer" from www.python.org
421works fine. Python 3.4 is recommended.
422
423When building, you need to set the following variables at least:
424
425 PYTHON3: Where Python3 is installed. E.g. C:\Python34
426 DYNAMIC_PYTHON3: Whether dynamic linking is used. Usually, set to yes.
427 PYTHON3_VER: Python3 version. E.g. 34 for Python 3.4.X.
428
429E.g. When using MSVC (as one line):
430
431 nmake -f Make_mvc.mak
432 PYTHON3=C:\Python34 DYNAMIC_PYTHON3=yes PYTHON3_VER=34
433
434
Bram Moolenaar4e640bd2016-01-16 16:20:38 +01004358. Building with MzScheme/Racket support
436========================================
437
4381) Building with MzScheme support
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000439
440(written by Sergey Khorev <sergey.khorev@gmail.com>)
441
442Vim with MzScheme (http://www.plt-scheme.org/software/mzscheme) support can
443be built with either MSVC, or MinGW, or Cygwin. Supported versions are 205 and
444above (including 299 and 30x series).
445
446The MSVC build is quite straightforward. Simply invoke (in one line)
447nmake -fMake_mvc.mak MZSCHEME=<Path-to-MzScheme>
448 [MZSCHEME_VER=<MzScheme-version>] [DYNAMIC_MZSCHEME=<yes or no>]
449where <MzScheme-version> is the last seven characters from MzScheme dll name
450(libmzschXXXXXXX.dll).
451If DYNAMIC_MZSCHEME=yes, resulting executable will not depend on MzScheme
452DLL's, but will load them in runtime on demand.
453
454Building dynamic MzScheme support on MinGW and Cygwin is similar. Take into
455account that <Path-to-MzScheme> should contain slashes rather than backslashes
456(e.g. d:/Develop/MzScheme)
457
458"Static" MzScheme support (Vim executable will depend on MzScheme DLLs
459explicitly) on MinGW and Cygwin requires additional step.
460
461libmzschXXXXXXX.dll and libmzgcXXXXXXX.dll should be copied from
462%WINDOWS%\System32 to other location (either build directory, some temporary
463dir or even MzScheme home).
464
465Pass that path as MZSCHEME_DLLS parameter for Make. E.g.,
466make -f Make_cyg.mak MZSCHEME=d:/Develop/MzScheme MZSCHEME_VER=209_000
467 MZSCHEME_DLLS=c:/Temp DYNAMIC_MZSCHEME=no
468
469After a successful build, these dlls can be freely removed, leaving them in
470%WINDOWS%\System32 only.
471
472
Bram Moolenaar4e640bd2016-01-16 16:20:38 +01004732) Building with Racket support
474
475MzScheme and PLT Scheme names have been rebranded as Racket. Vim with Racket
476(https://racket-lang.org/) support can be built with either MSVC or MinGW (or
477Cygwin).
478
479You need to set the following variables:
480
481 MZSCHEME: Where Racket is installed.
482 E.g. C:\Program Files (x86)\Racket
483 DYNAMIC_MZSCHEME: Whether dynamic linking is used. Usually, set to yes.
484 MZSCHEME_VER: Racket DLL version. E.g. 3m_9z0ds0 for Racket 6.3.
485 MZSCHEME_COLLECTS: (Optional) Path of the collects directory used at
486 runtime. Default: $(MZSCHEME)\collects
487 User can override this with the PLTCOLLECTS environment
488 variable.
489
490E.g. When using MSVC (as one line):
491
492 nmake -f Make_mvc.mak
493 MZSCHEME="C:\Program Files (x86)\Racket" DYNAMIC_MZSCHEME=yes
494 MZSCHEME_VER=3m_9z0ds0
495
496Or when using MinGW (as one line):
497
498 mingw32-make -f Make_ming.mak
499 MZSCHEME='C:/Program\ Files\ (x86)/Racket' DYNAMIC_MZSCHEME=yes
500 MZSCHEME_VER=3m_9z0ds0
501
502 Spaces should be escaped with '\'.
503
504
Bram Moolenaar30a89472016-01-10 14:35:58 +01005059. Building with Lua support
506============================
507
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100508Vim with Lua support can be built with either MSVC or MinGW (or maybe Cygwin).
509You can use binaries from LuaBinaries: http://luabinaries.sourceforge.net/
510This also applies to when you get a Vim executable and don't build yourself,
511do the part up to "Build".
Bram Moolenaar30a89472016-01-10 14:35:58 +0100512
5131) Download and install LuaBinaries
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100514
Bram Moolenaar30a89472016-01-10 14:35:58 +0100515Go to the Download page of LuaBinaries:
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100516 http://luabinaries.sourceforge.net/download.html
Bram Moolenaar30a89472016-01-10 14:35:58 +0100517
518Download lua-X.Y.Z_Win32_dllw4_lib.zip for x86 or
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100519lua-X.Y.Z_Win64_dllw4_lib.zip for x64. You can use them both for MSVC and
Bram Moolenaar30a89472016-01-10 14:35:58 +0100520MinGW.
521
522Unpack it to a working directory. E.g. C:\projects\lua53.
523Lua's header files will be installed under the include directory.
524
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100525Copy luaXY.dll to your Windows system directory. The system directory depends
526on your Windows bitness and Vim bitness:
527 32-bit Vim on 32-bit Windows: C:\Windows\System32
528 32-bit Vim on 64-bit Windows: C:\Windows\SysWOW64
529 64-bit Vim on 64-bit Windows: C:\Windows\System32
530
531Or another option is copying luaXY.dll to the directory where gvim.exe
532(or vim.exe) is.
533
Bram Moolenaar30a89472016-01-10 14:35:58 +0100534
5352) Build
Bram Moolenaar30a89472016-01-10 14:35:58 +0100536
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100537You need to set LUA, DYNAMIC_LUA and LUA_VER.
538
539 LUA: Where Lua's header files are installed. E.g. C:\projects\lua53.
540 DYNAMIC_LUA: Whether dynamic linking is used. Set to yes.
541 LUA_VER: Lua version. E.g. 53 for Lua 5.3.X.
Bram Moolenaar30a89472016-01-10 14:35:58 +0100542
543E.g. When using MSVC (as one line):
544
545 nmake -f Make_mvc.mak
546 LUA=C:\projects\lua53 DYNAMIC_LUA=yes LUA_VER=53
547
548Or when using MinGW (as one line):
549
550 mingw32-make -f Make_mingw.mak
551 LUA=C:\projects\lua53 DYNAMIC_LUA=yes LUA_VER=53
552
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100553
554Or when using Cygwin (as one line) (untested):
Bram Moolenaar30a89472016-01-10 14:35:58 +0100555
556 make -f Make_cyg.mak
557 LUA=/cygdrive/c/projects/lua53 DYNAMIC_LUA=yes LUA_VER=53
558
559
56010. Building with Perl support
561==============================
562
563Vim with Perl support can be built with either MSVC or MinGW (or Cygwin).
564You can use binaries from ActiveState (ActivePerl) or Strawberry Perl.
565
566 http://www.activestate.com/activeperl
567 http://strawberryperl.com/
568
569When building, you need to set the following variables:
570
571 PERL: Where perl is installed. E.g. C:\Perl, C:\Strawberry\perl
572 DYNAMIC_PERL: Whether dynamic linking is used. Usually, set to yes.
573 PERL_VER: Perl version. E.g. 522 for Perl 5.22.X.
574
575E.g. When using MSVC (as one line):
576
577 nmake -f Make_mvc.mak
578 PERL=C:\Perl DYNAMIC_PERL=yes PERL_VER=522
579
580Or when using MinGW (as one line):
581
582 mingw32-make -f Make_mingw.mak
583 PERL=C:\Perl DYNAMIC_PERL=yes PERL_VER=522
584
585
58611. Building with Ruby support
587==============================
588
589Vim with Ruby support can be built with either MSVC or MinGW (or Cygwin).
590Ruby doesn't provide the official Windows binaries. The most widely used
591Windows binaries might be RubyInstaller.
592
593 http://rubyinstaller.org/
594
595If you use MinGW you can easily build with RubyInstaller, but if you use MSVC
596you need some tricks described below.
597(Another binary distribution is ActiveScriptRuby:
598 http://www.artonx.org/data/asr/)
599
600When building, you need to set the following variables at least:
601
Bram Moolenaar6384c5d2016-09-06 22:06:35 +0200602 RUBY: Where ruby is installed. E.g. C:\Ruby22
603 DYNAMIC_RUBY: Whether dynamic linking is used. Usually, set to yes.
604 RUBY_VER: Ruby version. E.g. 22 for Ruby 2.2.X.
605 RUBY_API_VER_LONG: Ruby API version in a long format.
606 E.g. 2.2.0 for Ruby 2.2.X.
Bram Moolenaar30a89472016-01-10 14:35:58 +0100607
608Ruby version vs. Ruby API version:
609
610 Ruby ver. | Ruby API ver.
611 =========================
612 1.8.X | 1.8
613 1.9.[1-3] | 1.9.1
614 2.0.0 | 2.0.0
615 2.X.Y | 2.X.0
616
617(Ruby 1.9.0 is excluded from the table because it is an unstable version.)
618
619
620A) Using MSVC
621
622If you want to link with ruby, normally you must use the same compiler as
623which was used to build the ruby binary. RubyInstaller is built with MinGW,
624so normally you cannot use MSVC for building Vim if you want to link with
Bram Moolenaar02cfac82016-04-21 14:34:58 +0200625RubyInstaller. If you use a different compiler, there are mainly two problems:
Bram Moolenaar30a89472016-01-10 14:35:58 +0100626config.h and Ruby's DLL name. Here are the steps for working around them:
627
628 1) Download and Install RubyInstaller.
629 You can install RubyInstaller with the default options and directory.
630 E.g.:
631 C:\Ruby22 (32-bit) or C:\Ruby22-x64 (64-bit)
632
633 Ruby 2.2.X is used in this example.
634
635 2) Download Ruby 2.2.X's source code and generate config.h:
636
637 cd C:\projects
638 git clone https://github.com/ruby/ruby.git -b ruby_2_2
639 cd ruby
640 win32\configure.bat
641 nmake .config.h.time
642
643 Note that ruby_2_2 is the branch name for Ruby 2.2.X's source code.
644 There is no need to build whole Ruby, just config.h is needed.
645 If you use 32-bit MSVC10, the config.h is generated in the
646 .ext\include\i386-mswin32_100 directory.
647
648 3) Install the generated config.h.
649
650 xcopy /s .ext\include C:\Ruby22\include\ruby-2.2.0
651
652 Note that 2.2.0 is Ruby API version of Ruby 2.2.X.
653
654 4) Build Vim. Note that you need to adjust some variables (as one line):
655
656 nmake -f Make_mvc.mak
Bram Moolenaar6384c5d2016-09-06 22:06:35 +0200657 RUBY=C:\Ruby22 DYNAMIC_RUBY=yes RUBY_VER=22 RUBY_API_VER_LONG=2.2.0
Bram Moolenaar30a89472016-01-10 14:35:58 +0100658 RUBY_MSVCRT_NAME=msvcrt
Bram Moolenaar02cfac82016-04-21 14:34:58 +0200659 WINVER=0x501
Bram Moolenaar30a89472016-01-10 14:35:58 +0100660
Bram Moolenaar02cfac82016-04-21 14:34:58 +0200661 If you set WINVER explicitly, it must be set to >=0x500, when building
662 with Ruby 2.1 or later. (Default is 0x501.)
Bram Moolenaar30a89472016-01-10 14:35:58 +0100663 When using this trick, you also need to set RUBY_MSVCRT_NAME to msvcrt
664 which is used for the Ruby's DLL name.
665
666B) Using MinGW
667
668Using MinGW is easier than using MSVC when linking with RubyInstaller.
669After you install RubyInstaller, just type this (as one line):
670
671 mingw32-make -f Make_ming.mak
Bram Moolenaar6384c5d2016-09-06 22:06:35 +0200672 RUBY=C:/Ruby22 DYNAMIC_RUBY=yes RUBY_VER=22 RUBY_API_VER_LONG=2.2.0
Bram Moolenaar02cfac82016-04-21 14:34:58 +0200673 WINVER=0x501
Bram Moolenaar30a89472016-01-10 14:35:58 +0100674
Bram Moolenaar02cfac82016-04-21 14:34:58 +0200675If you set WINVER explicitly, it must be set to >=0x500, when building with
676Ruby 2.1 or later. (Default is 0x501.)
677
Bram Moolenaar30a89472016-01-10 14:35:58 +0100678
679
68012. Building with Tcl support
681=============================
682
683Vim with Tcl support can be built with either MSVC or MinGW (or Cygwin).
684You can use binaries from ActiveState (ActiveTcl).
685
686 http://www.activestate.com/activetcl
687
688When building, you need to set the following variables:
689
690 TCL: Where tcl is installed. E.g. C:\Tcl86
691 DYNAMIC_TCL: Whether dynamic linking is used. Usually, set to yes.
692 TCL_VER: Tcl version in a short format. E.g. 86 for Tcl 8.6.X.
693 TCL_VER_LONG: Tcl version in a long format. E.g. 8.6 for Tcl 8.6.X.
694
695E.g. When using MSVC (as one line):
696
697 nmake -f Make_mvc.mak
698 TCL=C:\Tcl86 DYNAMIC_TCL=yes TCL_VER=86 TCL_VER_LONG=8.6
699
700Or when using MinGW (as one line):
701
702 mingw32-make -f Make_mingw.mak
703 TCL=C:\Tcl86 DYNAMIC_TCL=yes TCL_VER=86 TCL_VER_LONG=8.6
704
705
Bram Moolenaar8f84c3a2017-07-22 16:14:44 +020070613. Building with Terminal support
707==================================
708
Bram Moolenaar2aeaf3f2017-07-23 17:11:15 +0200709Vim with Terminal support can be built with either MSVC, or MinGW or Cygwin.
710This uses the included libvterm and winpty. No extra header files or
711libraries are needed for building.
712
713Running Vim with terminal support requires the following two winpty files:
Bram Moolenaar8f84c3a2017-07-22 16:14:44 +0200714
715 winpty.dll
716 winpty-agent.dll
717
Bram Moolenaar2aeaf3f2017-07-23 17:11:15 +0200718You can download them from the following page:
Bram Moolenaar8f84c3a2017-07-22 16:14:44 +0200719
720 https://github.com/rprichard/winpty
721
Bram Moolenaar2aeaf3f2017-07-23 17:11:15 +0200722Just put the DLL files somewhere in your PATH.
Bram Moolenaar8f84c3a2017-07-22 16:14:44 +0200723
724
72514. Windows 3.1x
Bram Moolenaar30a89472016-01-10 14:35:58 +0100726================
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000727
Bram Moolenaar6e722e22016-02-26 19:58:58 +0100728The Windows 3.1x support was removed in patch 7.4.1364.
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000729
730
Bram Moolenaar8f84c3a2017-07-22 16:14:44 +020073115. MS-DOS
Bram Moolenaar30a89472016-01-10 14:35:58 +0100732==========
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733
Bram Moolenaar6e722e22016-02-26 19:58:58 +0100734The MS-DOS support was removed in patch 7.4.1399.
Bram Moolenaar734d9982011-07-15 13:52:04 +0200735
736
Bram Moolenaar8f84c3a2017-07-22 16:14:44 +020073716. Installing after building from sources
Bram Moolenaar734d9982011-07-15 13:52:04 +0200738==========================================
739
740[provided by Michael Soyka]
741
742After you've built the Vim binaries as described above, you're ready to
743install Vim on your system. However, if you've obtained the Vim sources
Bram Moolenaar30a89472016-01-10 14:35:58 +0100744using Git, Mercurial or by downloading them as a unix tar file, you must
Bram Moolenaarbbe917d2016-09-21 22:41:24 +0200745first create a "vim80" directory. If you instead downloaded the sources as
Bram Moolenaar734d9982011-07-15 13:52:04 +0200746zip files, you can skip this setup as the zip archives already have the
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100747correct directory structure.
Bram Moolenaar734d9982011-07-15 13:52:04 +0200748
Bram Moolenaarbbe917d2016-09-21 22:41:24 +0200749 A. Create a Vim "runtime" subdirectory named "vim80"
Bram Moolenaar734d9982011-07-15 13:52:04 +0200750 -----------------------------------------------------
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100751 If you obtained your Vim sources as zip files, you can skip this step.
Bram Moolenaar734d9982011-07-15 13:52:04 +0200752 Otherwise, continue reading.
753
754 Go to the directory that contains the Vim "src" and "runtime"
Bram Moolenaarbbe917d2016-09-21 22:41:24 +0200755 directories and create a new subdirectory named "vim80".
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100756
Bram Moolenaarbbe917d2016-09-21 22:41:24 +0200757 Copy the "runtime" files into "vim80":
758 copy runtime\* vim80
Bram Moolenaar734d9982011-07-15 13:52:04 +0200759
Bram Moolenaarbbe917d2016-09-21 22:41:24 +0200760 B. Copy the new binaries into the "vim80" directory
Bram Moolenaar734d9982011-07-15 13:52:04 +0200761 ----------------------------------------------------
762 Regardless of how you installed the Vim sources, you need to copy the
Bram Moolenaarbbe917d2016-09-21 22:41:24 +0200763 new binaries you created above into "vim80":
Bram Moolenaar734d9982011-07-15 13:52:04 +0200764
Bram Moolenaarbbe917d2016-09-21 22:41:24 +0200765 copy src\*.exe vim80
766 copy src\GvimExt\gvimext.dll vim80
767 copy src\xxd\xxd.exe vim80
Bram Moolenaar734d9982011-07-15 13:52:04 +0200768
Bram Moolenaarbbe917d2016-09-21 22:41:24 +0200769 C. Move the "vim80" directory into the Vim installation subdirectory
Bram Moolenaar734d9982011-07-15 13:52:04 +0200770 ---------------------------------------------------------------------
Bram Moolenaarbbe917d2016-09-21 22:41:24 +0200771 Move the "vim80" subdirectory into the subdirectory where you want Vim
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100772 to be installed. Typically, this subdirectory will be named "vim".
Bram Moolenaarbbe917d2016-09-21 22:41:24 +0200773 If you already have a "vim80" subdirectory in "vim", delete it first
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100774 by running its uninstal.exe program.
Bram Moolenaar734d9982011-07-15 13:52:04 +0200775
776 D. Install Vim
777 ---------------
Bram Moolenaarbbe917d2016-09-21 22:41:24 +0200778 "cd" to your Vim installation subdirectory "vim\vim80" and run the
Bram Moolenaar734d9982011-07-15 13:52:04 +0200779 "install.exe" program. It will ask you a number of questions about
780 how you would like to have your Vim setup. Among these are:
781 - You can tell it to write a "_vimrc" file with your preferences in the
782 parent directory.
783 - It can also install an "Edit with Vim" entry in the Windows Explorer
784 popup menu.
785 - You can have it create batch files, so that you can run Vim from the
786 console or in a shell. You can select one of the directories in your
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100787 PATH or add the directory to PATH using the Windows Control Panel.
Bram Moolenaar734d9982011-07-15 13:52:04 +0200788 - Create entries for Vim on the desktop and in the Start menu.
789
790Happy Vimming!