blob: 43d024a4a35105f9c770afb9dbf92ea65226ccb5 [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 Moolenaara87f8fd2018-09-18 22:58:41 +02006You can find the latest here: https://github.com/vim/vim-win32-installer
Bram Moolenaar18cfa942017-10-08 17:58:44 +02007This page also has links to install support for interfaces such as Perl,
8Python, Lua, etc.
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 Moolenaar18cfa942017-10-08 17:58:44 +020018The recommended way is to build a 32 bit Vim, also on 64 bit systems. You can
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +010019build a 64 bit Vim if you like, the executable will be bigger and Vim won't be
Bram Moolenaar18cfa942017-10-08 17:58:44 +020020any faster, but you can edit files larger than 2 Gbyte.
21
Bram Moolenaar071d4272004-06-13 20:20:40 +000022
23Contents:
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000241. Microsoft Visual C++
Bram Moolenaar304925e2018-06-30 16:27:02 +0200252. Using MSYS2 with MinGW
263. Using MinGW
274. Cygwin
Bram Moolenaareae1b912019-05-09 15:12:55 +0200285. Cross compiling for Win32 from a Linux machine
296. Building with Python support
307. Building with Python3 support
318. Building with Racket or MzScheme support
329. Building with Lua support
3310. Building with Perl support
3411. Building with Ruby support
3512. Building with Tcl support
Bram Moolenaar8024f932020-01-14 19:29:13 +01003613. Building with DirectX (DirectWrite) support
K.Takatad8f86292022-03-07 15:16:15 +00003714. Building with libsodium support
3815. Windows 3.1
3916. MS-DOS
Bram Moolenaar362e1a32006-03-06 23:29:24 +000040
K.Takatad8f86292022-03-07 15:16:15 +00004117. Installing after building from sources
Bram Moolenaar734d9982011-07-15 13:52:04 +020042
43
Bram Moolenaar18cfa942017-10-08 17:58:44 +020044The currently recommended way (that means it has been verified to work) is
45using the "Visual Studio Community 2015" installation. This includes the SDK
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +010046needed to target Windows XP. But not older Windows versions (95, 98), see
Bram Moolenaara0754902019-11-19 23:01:28 +010047"OLDER VERSIONS" below for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +000048
49
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000501. Microsoft Visual C++
51=======================
52
Bram Moolenaar73f44392017-10-07 18:38:43 +020053We do not provide download links, since Microsoft keeps changing them. You
Bram Moolenaar18cfa942017-10-08 17:58:44 +020054can search for "Visual Studio Community 2015", for example. You will need to
Bram Moolenaar73f44392017-10-07 18:38:43 +020055create a Microsoft account (it's free).
56
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +010057When installing "Visual Studio Community 2015 with Update 3" make sure to
58select "custom" and check "Windows XP Support for C++" and all checkboxes
59under "Universal Windows App Development Tools"
60
Bram Moolenaar73f44392017-10-07 18:38:43 +020061
Bram Moolenaar362e1a32006-03-06 23:29:24 +000062Visual Studio
63-------------
64
Bram Moolenaara0754902019-11-19 23:01:28 +010065Building with Visual Studio (VS2010, VS2012, VS2013, VS2015, VS2017 and VS2019)
66is straightforward.
Bram Moolenaar97cc2382012-10-03 21:46:54 +020067
Bram Moolenaar362e1a32006-03-06 23:29:24 +000068To build Vim from the command line with MSVC, use Make_mvc.mak.
69Visual Studio installed a batch file called vcvars32.bat, which you must
70run to set up paths for nmake and MSVC.
71
Bram Moolenaarc9b4b052006-04-30 18:54:39 +000072nmake -f Make_mvc.mak console Win32 SDK or Microsoft Visual C++
73nmake -f Make_mvc.mak GUI=yes GUI Microsoft Visual C++
74nmake -f Make_mvc.mak OLE=yes OLE Microsoft Visual C++
Bram Moolenaar362e1a32006-03-06 23:29:24 +000075nmake -f Make_mvc.mak PERL=C:\Perl PYTHON=C:\Python etc.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +000076 Perl, Python, etc.
Bram Moolenaar362e1a32006-03-06 23:29:24 +000077
78Make_mvc.mak allows a Vim to be built with various different features and
Bram Moolenaarfda97842019-05-07 22:25:27 +020079debug support.
Bram Moolenaar362e1a32006-03-06 23:29:24 +000080
Bram Moolenaara0754902019-11-19 23:01:28 +010081For compiling gVim with IME support on far-east Windows, add IME=yes
Bram Moolenaar362e1a32006-03-06 23:29:24 +000082to the parameters you pass to Make_mvc.mak.
83
Bram Moolenaar362e1a32006-03-06 23:29:24 +000084See the specific files for comments and options.
85
86These files have been supplied by George V. Reilly, Ben Singer, Ken Scott and
87Ron Aaron; they have been tested.
88
89
Bram Moolenaar02cfac82016-04-21 14:34:58 +020090Visual C++ 2010 Express Edition *msvc-2010-express*
91-------------------------------
92
93Visual C++ 2010 Express Edition can be downloaded for free from:
94 http://www.microsoft.com/express/vc/Default.aspx
95This includes the IDE and the debugger.
96
97To set the environment execute the msvc2010.bat script. You can then build
98Vim with Make_mvc.mak.
99
100
Bram Moolenaar73f44392017-10-07 18:38:43 +0200101Targeting Windows XP with MSVC 2012 and later *new-msvc-windows-xp*
102---------------------------------------------
Bram Moolenaar02cfac82016-04-21 14:34:58 +0200103
104Beginning with Visual C++ 2012, Microsoft changed the behavior of LINK.EXE
105so that it targets Windows 6.0 (Vista) by default. In order to override
106this, the target Windows version number needs to be passed to LINK like
107follows:
108 LINK ... /subsystem:console,5.01
109
110Make_mvc.mak now supports a macro SUBSYSTEM_VER to pass the Windows version.
Bram Moolenaar73f44392017-10-07 18:38:43 +0200111Use lines like follows to target Windows XP x86 (assuming using Visual C++
1122012 under 64-bit Windows):
Bram Moolenaar02cfac82016-04-21 14:34:58 +0200113 set WinSdk71=%ProgramFiles(x86)%\Microsoft SDKs\Windows\v7.1A
Bram Moolenaar02cfac82016-04-21 14:34:58 +0200114 set INCLUDE=%WinSdk71%\Include;%INCLUDE%
115 set LIB=%WinSdk71%\Lib;%LIB%
Bram Moolenaar02cfac82016-04-21 14:34:58 +0200116 set CL=/D_USING_V110_SDK71_
117 nmake -f Make_mvc.mak ... WINVER=0x0501 SUBSYSTEM_VER=5.01
118
Bram Moolenaar73f44392017-10-07 18:38:43 +0200119To target Windows XP x64 instead of x86, you need to change the settings of
120LIB and SUBSYSTEM_VER:
121 ...
122 set LIB=%WinSdk71%\Lib\x64;%LIB%
123 ...
124 nmake -f Make_mvc.mak ... WINVER=0x0501 SUBSYSTEM_VER=5.02
125
126If you use Visual C++ 2015 (either Express or Community Edition), executing
127msvc2015.bat will set them automatically. For x86 builds run this without
128options:
129 msvc2015
130For x64 builds run this with the "x86_amd64" option:
131 msvc2015 x86_amd64
Bram Moolenaara87f8fd2018-09-18 22:58:41 +0200132This enables x86_x64 cross compiler. This works on any editions including
133Express edition.
134If you use Community (or Professional) edition, you can enable the x64 native
135compiler by using the "x64" option:
136 msvc2015 x64
Bram Moolenaar73f44392017-10-07 18:38:43 +0200137
Bram Moolenaar02cfac82016-04-21 14:34:58 +0200138The following Visual C++ team blog can serve as a reference page:
139 http://blogs.msdn.com/b/vcblog/archive/2012/10/08/windows-xp-targeting-with-c-in-visual-studio-2012.aspx
140
Bram Moolenaara0754902019-11-19 23:01:28 +0100141VC 2019 dropped support for targeting Windows XP. If you want a binary that
142targeting Windows XP, use VC 2017 or earlier.
143
Bram Moolenaar02cfac82016-04-21 14:34:58 +0200144
Bram Moolenaar577fadf2019-04-04 20:32:24 +0200145Cross compile support for Windows on ARM64
146------------------------------------------
147
148This depends on VS2017 with the optional ARM64 compiler and SDK
149installed. Use "vcvarsall.bat x64_arm64" as the build environment.
150
151The ARM64 support was provided by Leendert van Doorn.
152
153
Bram Moolenaar02cfac82016-04-21 14:34:58 +0200154OLDER VERSIONS
155
156The minimal supported version is Windows XP. Building with older compilers
157might still work, but these instructions might be outdated.
158
K.Takata76687d22022-01-25 10:31:37 +0000159If you need the executable to run on Windows 98 or ME, use the 2005 one
160|msvc-2005-express|, and use the source code before 8.0.0029.
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000161
162
Bram Moolenaar98385dc2008-06-20 14:52:32 +0000163Visual C++ 2005 Express Edition *msvc-2005-express*
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000164-------------------------------
165
Bram Moolenaara0754902019-11-19 23:01:28 +0100166NOTE: this most likely does not work
167
Bram Moolenaarfc1421e2006-04-20 22:17:20 +0000168Visual C++ 2005 Express Edition can be downloaded for free from:
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000169 http://msdn.microsoft.com/vstudio/express/visualC/default.aspx
170This includes the IDE and the debugger. You will also need
171|ms-platform-sdk|. You can build Vim with Make_mvc.mak.
172
173Instructions for integrating the Platform SDK into VC Express:
174 http://msdn.microsoft.com/vstudio/express/visualc/usingpsdk/default.aspx
175
176
Bram Moolenaara0754902019-11-19 23:01:28 +0100177Visual C++ 2008 Express Edition *msvc-2008-express*
178-------------------------------
179
180NOTE: this most likely does not work
181
182Visual C++ 2008 Express Edition can be downloaded for free from:
183 http://www.microsoft.com/express/downloads/
184This includes the IDE and the debugger.
185
186To set the environment execute the msvc2008.bat script. You can then build
187Vim with Make_mvc.mak.
188
189For building 64 bit binaries you also need to install the SDK:
190"Microsoft Windows SDK for Windows 7 and .NET Framework 3.5 SP1"
191You don't need the examples and documentation.
192
Bram Moolenaara0754902019-11-19 23:01:28 +0100193
Bram Moolenaar304925e2018-06-30 16:27:02 +02001942. MSYS2 with MinGW
195===================
Bram Moolenaarce2f2e02014-08-22 18:12:57 +0200196
Bram Moolenaar304925e2018-06-30 16:27:02 +02001972.1. Setup the basic msys2 environment
198
199Go to the official page of MSYS2: https://www.msys2.org
200Download an installer:
201
202* msys2-x86_64-YYYYMMDD.exe for 64-bit Windows
203 (Even if you want to build 32-bit Vim)
204* msys2-i686-YYYYMMDD.exe for 32-bit Windows
205
206Execute the installer and follow the instructions to update basic packages.
207At the end keep the checkbox checked to run msys2 now. If needed, you can
Bram Moolenaara87f8fd2018-09-18 22:58:41 +0200208open the window from the start menu, MSYS2 64 bit / MSYS2 MSYS.
Bram Moolenaar304925e2018-06-30 16:27:02 +0200209
210Execute:
211 $ pacman -Syu
Bram Moolenaara87f8fd2018-09-18 22:58:41 +0200212
Bram Moolenaar2346a632021-06-13 19:02:49 +0200213And restart MSYS2 console (select "MSYS2 MSYS 32-Bit" icon from the Start
214Menu for building 32 bit Vim, otherwise select "MSYS2 MinGW 64-Bit").
Bram Moolenaar304925e2018-06-30 16:27:02 +0200215Then execute:
216 $ pacman -Su
217
218If pacman complains that `catgets` and `libcatgets` conflict with another
219package, select `y` to remove them.
220
221
2222.2. Install additional packages for building Vim
223
224The following package groups are required for building Vim:
225
226* base-devel
227* mingw-w64-i686-toolchain (for building 32-bit Vim)
228* mingw-w64-x86_64-toolchain (for building 64-bit Vim)
229
Bram Moolenaara87f8fd2018-09-18 22:58:41 +0200230(These groups also include some useful packages which are not used by Vim.)
Bram Moolenaar304925e2018-06-30 16:27:02 +0200231Use the following command to install them:
232
233 $ pacman -S base-devel mingw-w64-i686-toolchain mingw-w64-x86_64-toolchain
234
235Or you can use the `pacboy` command to avoid long package names:
236
237 $ pacboy -S base-devel: toolchain:m
238
Bram Moolenaara87f8fd2018-09-18 22:58:41 +0200239The suffix ":" means that it disables the package name translation.
240The suffix ":m" means both i686 and x86_64. You can also use the ":i" suffix
241to install only i686, and the ":x" suffix to install only x86_64.
Bram Moolenaar304925e2018-06-30 16:27:02 +0200242(See `pacboy help` for the help.)
243
Bram Moolenaara87f8fd2018-09-18 22:58:41 +0200244See also the pacman page in ArchWiki for the general usage of pacman:
245 https://wiki.archlinux.org/index.php/pacman
246
247MSYS2 has its own git package, and you can also install it via pacman:
248
249 $ pacman -S git
250
Bram Moolenaar304925e2018-06-30 16:27:02 +0200251
2522.3. Keep the build environment up-to-date
253
254After you have installed the build environment, you may want to keep it
255up-to-date (E.g. always use the latest GCC).
256In that case, you just need to execute the command:
257 $ pacman -Syu
258
259
Bram Moolenaara87f8fd2018-09-18 22:58:41 +02002602.4. Build Vim
Bram Moolenaar304925e2018-06-30 16:27:02 +0200261
262Select one of the following icon from the Start Menu:
263
264* MSYS2 MinGW 32-bit (To build 32-bit versions of Vim)
265* MSYS2 MinGW 64-bit (To build 64-bit versions of Vim)
266
267Go to the source directory of Vim, then execute the make command. E.g.:
268
269 make -f Make_ming.mak
270 make -f Make_ming.mak GUI=no
271 make -f Make_ming.mak GUI=no DEBUG=yes
272
Bram Moolenaara87f8fd2018-09-18 22:58:41 +0200273NOTE: you can't execute vim.exe in the MSYS2 console, open a normal Windows
Bram Moolenaar304925e2018-06-30 16:27:02 +0200274console for that. You need to set $PATH to be able to build there, e.g.:
275
276 set PATH=c:\msys64\mingw32\bin;c:\msys64\usr\bin;%PATH%
277
Bram Moolenaara87f8fd2018-09-18 22:58:41 +0200278This command is in msys32.bat. Or for the 64 bit compiler use msys64.bat:
Bram Moolenaar304925e2018-06-30 16:27:02 +0200279
280 set PATH=c:\msys64\mingw64\bin;c:\msys64\usr\bin;%PATH%
281
282If you have msys64 in another location you will need to adjust the paths for
283that.
284
Yegappan Lakshmanan1630bd92022-06-14 12:30:25 +01002852.5. Build Vim with Clang
286
287The following package group is required for building Vim with Clang:
288
289* mingw-w64-clang-x86_64-clang
290
291Use the following command to install it:
292
293 $ pacman -S mingw-w64-clang-x86_64-clang
294
295Go to the source directory of Vim, then execute the make command. E.g.:
296
297 CC=clang
298 CXX=clang++
Yegappan Lakshmanancf65d882022-06-15 18:31:45 +0100299 # To build Vim without the GUI support
Yegappan Lakshmanan1630bd92022-06-14 12:30:25 +0100300 make -f Make_ming.mak GUI=no
Yegappan Lakshmanancf65d882022-06-15 18:31:45 +0100301 # To build Vim with the GUI support
302 make -f Make_ming.mak GUI=yes XPM=no
Yegappan Lakshmanan1630bd92022-06-14 12:30:25 +0100303
304To build Vim with the address sanitizer (ASAN), execute the following command:
305
306 CC=clang
307 CXX=clang++
308 make -f Make_ming.mak DEBUG=yes ASAN=yes
Bram Moolenaar304925e2018-06-30 16:27:02 +0200309
3103. MinGW
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000311========
312
Bram Moolenaara0754902019-11-19 23:01:28 +0100313(written by Ron Aaron: <ronaharon@yahoo.com>, updated by Ken Takata, et al.)
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000314
Bram Moolenaara0754902019-11-19 23:01:28 +0100315This is about how to produce a Win32 binary of gvim with MinGW from the normal
316Command Prompt window. (To use MSYS2 console, see above.)
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000317
Bram Moolenaara0754902019-11-19 23:01:28 +0100318First, you need to get the 'MinGW-w64' compiler, which is free for the
319download at:
Bram Moolenaar4f7e8212014-11-05 13:53:32 +0100320
321 http://mingw-w64.sourceforge.net/
322
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100323Or a compiler provided on msys2:
324
Bram Moolenaara0754902019-11-19 23:01:28 +0100325 https://www.msys2.org/
326
327The original 'mingw32' compiler is outdated, and may no longer work:
328
329 http://www.mingw.org/
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100330
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000331Once you have downloaded the compiler binaries, unpack them on your hard disk
Bram Moolenaara0754902019-11-19 23:01:28 +0100332somewhere, and put them on your PATH. Go to the Control Panel, (Performance
333and Maintenance), System, Advanced, and edit the environment from there. If
Bram Moolenaar23515b42020-11-29 14:36:24 +0100334you use the standalone MinGW-w64 compiler, the path may depend on your
Bram Moolenaara0754902019-11-19 23:01:28 +0100335installation. If you use msys2 compilers, set your installed paths (normally
336one of the following):
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100337
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +0100338 C:\msys32\mingw32\bin (32-bit msys2, targeting 32-bit builds)
339 C:\msys64\mingw32\bin (64-bit msys2, targeting 32-bit builds)
340 C:\msys64\mingw64\bin (64-bit msys2, targeting 64-bit builds)
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000341
Bram Moolenaara0754902019-11-19 23:01:28 +0100342Test if gcc is on your path. From a Command Prompt window:
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000343
344 C:\> gcc --version
Bram Moolenaar4f7e8212014-11-05 13:53:32 +0100345 gcc (GCC) 4.8.1
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000346
Bram Moolenaar4f7e8212014-11-05 13:53:32 +0100347 C:\> mingw32-make --version
348 GNU Make 3.82.90 (...etc...)
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000349
350Now you are ready to rock 'n' roll. Unpack the vim sources (look on
351www.vim.org for exactly which version of the vim files you need).
352
353Change directory to 'vim\src':
354
355 C:\> cd vim\src
356 C:\VIM\SRC>
357
358and you type:
359
Bram Moolenaar4f7e8212014-11-05 13:53:32 +0100360 mingw32-make -f Make_ming.mak gvim.exe
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000361
362After churning for a while, you will end up with 'gvim.exe' in the 'vim\src'
363directory.
364
365You should not need to do *any* editing of any files to get vim compiled this
366way. If, for some reason, you want the console-mode-only version of vim (this
Bram Moolenaar5e3dae82010-03-02 16:19:40 +0100367is NOT recommended on Win32, especially on '95/'98!!!), you can use:
Bram Moolenaard8e21d32010-01-06 21:16:31 +0100368
Bram Moolenaar4f7e8212014-11-05 13:53:32 +0100369 mingw32-make -f Make_ming.mak GUI=no vim.exe
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000370
371If you are dismayed by how big the EXE is, I strongly recommend you get 'UPX'
372(also free!) and compress the file (typical compression is 50%). UPX can be
373found at
374 http://www.upx.org/
375
Bram Moolenaar91856272012-02-29 16:56:39 +0100376As of 2011, UPX still does not support compressing 64-bit EXE's; if you have
377built a 64-bit vim then an alternative to UPX is 'MPRESS'. MPRESS can be found
378at:
379 http://www.matcode.com/mpress.htm
380
381
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000382ADDITION: NLS support with MinGW
383
384(by Eduardo F. Amatria <eferna1@platea.pntic.mec.es>)
385
386If you want National Language Support, read the file src/po/README_mingw.txt.
387You need to uncomment lines in Make_ming.mak to have NLS defined.
388
389
Bram Moolenaar304925e2018-06-30 16:27:02 +02003904. Cygwin
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000391=========
392
393Use Make_cyg.mak with Cygwin's GCC. See
394 http://users.skynet.be/antoine.mechelynck/vim/compile.htm
395
Bram Moolenaar4f7e8212014-11-05 13:53:32 +0100396With Cygnus gcc you should use the Unix Makefile instead (you need to get the
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000397Unix archive then). Then you get a Cygwin application (feels like Vim is
Bram Moolenaar48f80c22010-02-24 15:08:27 +0100398running on Unix), while with Make_cyg.mak you get a Windows application (like
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000399with the other makefiles).
400
401
Bram Moolenaareae1b912019-05-09 15:12:55 +02004025. Cross compiling for Win32 from a Linux machine
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000403=================================================
404
405[Update of 1) needs to be verified]
406
407If you like, you can compile the 'mingw' Win32 version from the comfort of
408your Linux (or other unix) box. To do this, you need to follow a few steps:
409 1) Install the mingw32 cross-compiler. See
Bram Moolenaard8e21d32010-01-06 21:16:31 +0100410 http://www.mingw.org/wiki/LinuxCrossMinGW
Bram Moolenaarc9b4b052006-04-30 18:54:39 +0000411 http://www.libsdl.org/extras/win32/cross/README.txt
Bram Moolenaara7241f52008-06-24 20:39:31 +0000412 2) Get and unpack both the Unix sources and the extra archive
Bram Moolenaar4f7e8212014-11-05 13:53:32 +0100413 3) in 'Make_cyg_ming.mak', set 'CROSS' to 'yes' instead of 'no'.
414 Make further changes to 'Make_cyg_ming.mak' and 'Make_ming.mak' as you
415 wish. If your cross-compiler prefix differs from the predefined value,
Bram Moolenaard8e21d32010-01-06 21:16:31 +0100416 set 'CROSS_COMPILE' corresponding.
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000417 4) make -f Make_ming.mak gvim.exe
418
419Now you have created the Windows binary from your Linux box! Have fun...
420
421
Bram Moolenaareae1b912019-05-09 15:12:55 +02004226. Building with Python support
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000423===============================
424
Bram Moolenaara0754902019-11-19 23:01:28 +0100425For building with MSVC the "Windows Installer" from www.python.org works fine.
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000426
Bram Moolenaar30a89472016-01-10 14:35:58 +0100427When building, you need to set the following variables at least:
428
429 PYTHON: Where Python is installed. E.g. C:\Python27
430 DYNAMIC_PYTHON: Whether dynamic linking is used. Usually, set to yes.
431 PYTHON_VER: Python version. E.g. 27 for Python 2.7.X.
432
433E.g. When using MSVC (as one line):
434
435 nmake -f Make_mvc.mak
436 PYTHON=C:\Python27 DYNAMIC_PYTHON=yes PYTHON_VER=27
437
Bram Moolenaarba7e1862019-01-09 23:02:43 +0100438When using MinGW and link with the official Python (as one line):
439
440 mingw32-make -f Make_ming.mak
441 PYTHON=C:/Python27 DYNAMIC_PYTHON=yes PYTHON_VER=27
442
443When using msys2 and link with Python2 bundled with msys2 (as one line):
444
445 mingw32-make -f Make_ming.mak PYTHON=c:/msys64/mingw64
446 PYTHON_HOME=c:/msys64/mingw64
447 PYTHONINC=-Ic:/msys64/mingw64/include/python2.7
448 DYNAMIC_PYTHON=yes
449 PYTHON_VER=27
450 DYNAMIC_PYTHON_DLL=libpython2.7.dll
451 STATIC_STDCPLUS=yes
452
453(This is for 64-bit builds. For 32-bit builds, replace mingw64 with mingw32.)
454(STATIC_STDCPLUS is optional. Set to yes if you don't want to require
455libstdc++-6.dll.)
456
457
Bram Moolenaar97cc2382012-10-03 21:46:54 +0200458(rest written by Ron Aaron: <ronaharon@yahoo.com>)
459
460Building with the mingw32 compiler, and the ActiveState ActivePython:
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000461 http://www.ActiveState.com/Products/ActivePython/
462
463After installing the ActivePython, you will have to create a 'mingw32'
464'libpython20.a' to link with:
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100465 cd $PYTHON/libs
466 pexports python20.dll > python20.def
467 dlltool -d python20.def -l libpython20.a
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000468
469Once that is done, edit the 'Make_ming.mak' so the PYTHON variable points to
470the root of the Python installation (C:\Python20, for example). If you are
471cross-compiling on Linux with the mingw32 setup, you need to also convert all
472the 'Include' files to *unix* line-endings. This bash command will do it
473easily:
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100474 for fil in *.h ; do vim -e -c 'set ff=unix|w|q' $fil
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000475
476Now just do:
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100477 make -f Make_ming.mak gvim.exe
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000478
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100479You will end up with a Python-enabled, Win32 version. Enjoy!
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000480
481
Bram Moolenaareae1b912019-05-09 15:12:55 +02004827. Building with Python3 support
Bram Moolenaar30a89472016-01-10 14:35:58 +0100483================================
484
Bram Moolenaara0754902019-11-19 23:01:28 +0100485For building with MSVC the "Windows Installer" from www.python.org works fine.
486Python 3.6 is recommended.
Bram Moolenaar30a89472016-01-10 14:35:58 +0100487
488When building, you need to set the following variables at least:
489
Bram Moolenaar59eb0162017-12-10 18:17:44 +0100490 PYTHON3: Where Python3 is installed. E.g. C:\Python36
Bram Moolenaar30a89472016-01-10 14:35:58 +0100491 DYNAMIC_PYTHON3: Whether dynamic linking is used. Usually, set to yes.
Bram Moolenaar59eb0162017-12-10 18:17:44 +0100492 PYTHON3_VER: Python3 version. E.g. 36 for Python 3.6.X.
Bram Moolenaar30a89472016-01-10 14:35:58 +0100493
494E.g. When using MSVC (as one line):
495
496 nmake -f Make_mvc.mak
Bram Moolenaar59eb0162017-12-10 18:17:44 +0100497 PYTHON3=C:\Python36 DYNAMIC_PYTHON3=yes PYTHON3_VER=36
498
Bram Moolenaarba7e1862019-01-09 23:02:43 +0100499When using MinGW and link with the official Python3 (as one line):
500
501 mingw32-make -f Make_ming.mak
502 PYTHON3=C:/Python36 DYNAMIC_PYTHON3=yes PYTHON3_VER=36
Bram Moolenaar59eb0162017-12-10 18:17:44 +0100503
504When using msys2 and link with Python3 bundled with msys2 (as one line):
505
506 mingw32-make -f Make_ming.mak PYTHON3=c:/msys64/mingw64
507 PYTHON3_HOME=c:/msys64/mingw64
508 PYTHON3INC=-Ic:/msys64/mingw64/include/python3.6m
509 DYNAMIC_PYTHON3=yes
510 PYTHON3_VER=36
511 DYNAMIC_PYTHON3_DLL=libpython3.6m.dll
512 STATIC_STDCPLUS=yes
513
514(This is for 64-bit builds. For 32-bit builds, replace mingw64 with mingw32.)
Bram Moolenaarba7e1862019-01-09 23:02:43 +0100515(STATIC_STDCPLUS is optional. Set to yes if you don't want to require
516libstdc++-6.dll.)
Bram Moolenaar30a89472016-01-10 14:35:58 +0100517
518
Bram Moolenaareae1b912019-05-09 15:12:55 +02005198. Building with Racket or MzScheme support
Bram Moolenaara0754902019-11-19 23:01:28 +0100520===========================================
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100521
Bram Moolenaar18cfa942017-10-08 17:58:44 +02005221) Building with Racket support (newest)
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100523
524MzScheme and PLT Scheme names have been rebranded as Racket. Vim with Racket
Bram Moolenaar18cfa942017-10-08 17:58:44 +0200525support can be built with either MSVC or MinGW (or Cygwin).
526Get it from https://download.racket-lang.org/
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100527
Bram Moolenaar18cfa942017-10-08 17:58:44 +0200528Copy lib/libracket{version}.dll to your Windows system directory. The system
529directory depends on your Windows bitness and Vim bitness:
530 32-bit Vim on 32-bit Windows: C:\Windows\System32
531 32-bit Vim on 64-bit Windows: C:\Windows\SysWOW64
532 64-bit Vim on 64-bit Windows: C:\Windows\System32
533
534For building you need to set the following variables:
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100535
536 MZSCHEME: Where Racket is installed.
537 E.g. C:\Program Files (x86)\Racket
538 DYNAMIC_MZSCHEME: Whether dynamic linking is used. Usually, set to yes.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +0200539 MZSCHEME_VER: Racket DLL version which is used for the file name.
Bram Moolenaar73f44392017-10-07 18:38:43 +0200540 See below for a list of MZSCHEME_VER.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +0200541 The DLL can be found under the lib directory. E.g.
542 C:\Program Files (x86)\Racket\lib\libracket3m_XXXXXX.dll
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100543 MZSCHEME_COLLECTS: (Optional) Path of the collects directory used at
544 runtime. Default: $(MZSCHEME)\collects
545 User can override this with the PLTCOLLECTS environment
546 variable.
547
Bram Moolenaar73f44392017-10-07 18:38:43 +0200548List of MZSCHEME_VER (incomplete):
549
550 Racket ver. | MZSCHEME_VER
551 ==========================
552 6.3 | 3m_9z0ds0
553 6.6 | 3m_a0solc
554 6.8 | 3m_a1zjsw
555 6.10 | 3m_a36fs8
556
557
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100558E.g. When using MSVC (as one line):
559
560 nmake -f Make_mvc.mak
561 MZSCHEME="C:\Program Files (x86)\Racket" DYNAMIC_MZSCHEME=yes
562 MZSCHEME_VER=3m_9z0ds0
563
564Or when using MinGW (as one line):
565
566 mingw32-make -f Make_ming.mak
567 MZSCHEME='C:/Program\ Files\ (x86)/Racket' DYNAMIC_MZSCHEME=yes
568 MZSCHEME_VER=3m_9z0ds0
569
570 Spaces should be escaped with '\'.
571
572
Bram Moolenaar18cfa942017-10-08 17:58:44 +02005732) Building with MzScheme support (older)
574
575(written by Sergey Khorev <sergey.khorev@gmail.com>)
576
577Vim with MzScheme (http://www.plt-scheme.org/software/mzscheme) support can
578be built with either MSVC, or MinGW, or Cygwin. Supported versions are 205 and
579above (including 299 and 30x series).
580
581The MSVC build is quite straightforward. Simply invoke (in one line)
582nmake -fMake_mvc.mak MZSCHEME=<Path-to-MzScheme>
583 [MZSCHEME_VER=<MzScheme-version>] [DYNAMIC_MZSCHEME=<yes or no>]
584where <MzScheme-version> is the last seven characters from MzScheme dll name
585(libmzschXXXXXXX.dll).
586If DYNAMIC_MZSCHEME=yes, resulting executable will not depend on MzScheme
587DLL's, but will load them in runtime on demand.
588
589Building dynamic MzScheme support on MinGW and Cygwin is similar. Take into
590account that <Path-to-MzScheme> should contain slashes rather than backslashes
591(e.g. d:/Develop/MzScheme)
592
593"Static" MzScheme support (Vim executable will depend on MzScheme DLLs
594explicitly) on MinGW and Cygwin requires additional step.
595
596libmzschXXXXXXX.dll and libmzgcXXXXXXX.dll should be copied from
597%WINDOWS%\System32 to other location (either build directory, some temporary
598dir or even MzScheme home).
599
600Pass that path as MZSCHEME_DLLS parameter for Make. E.g.,
601make -f Make_cyg.mak MZSCHEME=d:/Develop/MzScheme MZSCHEME_VER=209_000
602 MZSCHEME_DLLS=c:/Temp DYNAMIC_MZSCHEME=no
603
604After a successful build, these dlls can be freely removed, leaving them in
605%WINDOWS%\System32 only.
606
607
608
Bram Moolenaareae1b912019-05-09 15:12:55 +02006099. Building with Lua support
Bram Moolenaar30a89472016-01-10 14:35:58 +0100610============================
611
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100612Vim with Lua support can be built with either MSVC or MinGW (or maybe Cygwin).
613You can use binaries from LuaBinaries: http://luabinaries.sourceforge.net/
614This also applies to when you get a Vim executable and don't build yourself,
615do the part up to "Build".
Bram Moolenaar30a89472016-01-10 14:35:58 +0100616
6171) Download and install LuaBinaries
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100618
Bram Moolenaar30a89472016-01-10 14:35:58 +0100619Go to the Download page of LuaBinaries:
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100620 http://luabinaries.sourceforge.net/download.html
Bram Moolenaar30a89472016-01-10 14:35:58 +0100621
622Download lua-X.Y.Z_Win32_dllw4_lib.zip for x86 or
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100623lua-X.Y.Z_Win64_dllw4_lib.zip for x64. You can use them both for MSVC and
Bram Moolenaar30a89472016-01-10 14:35:58 +0100624MinGW.
625
626Unpack it to a working directory. E.g. C:\projects\lua53.
627Lua's header files will be installed under the include directory.
628
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100629Copy luaXY.dll to your Windows system directory. The system directory depends
630on your Windows bitness and Vim bitness:
631 32-bit Vim on 32-bit Windows: C:\Windows\System32
632 32-bit Vim on 64-bit Windows: C:\Windows\SysWOW64
633 64-bit Vim on 64-bit Windows: C:\Windows\System32
634
635Or another option is copying luaXY.dll to the directory where gvim.exe
636(or vim.exe) is.
637
Bram Moolenaar30a89472016-01-10 14:35:58 +0100638
6392) Build
Bram Moolenaar30a89472016-01-10 14:35:58 +0100640
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100641You need to set LUA, DYNAMIC_LUA and LUA_VER.
642
643 LUA: Where Lua's header files are installed. E.g. C:\projects\lua53.
644 DYNAMIC_LUA: Whether dynamic linking is used. Set to yes.
645 LUA_VER: Lua version. E.g. 53 for Lua 5.3.X.
Bram Moolenaar30a89472016-01-10 14:35:58 +0100646
647E.g. When using MSVC (as one line):
648
649 nmake -f Make_mvc.mak
650 LUA=C:\projects\lua53 DYNAMIC_LUA=yes LUA_VER=53
651
652Or when using MinGW (as one line):
653
Bram Moolenaar18cfa942017-10-08 17:58:44 +0200654 mingw32-make -f Make_ming.mak
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +0100655 LUA=C:/projects/lua53 DYNAMIC_LUA=yes LUA_VER=53
Bram Moolenaar30a89472016-01-10 14:35:58 +0100656
Bram Moolenaar4e640bd2016-01-16 16:20:38 +0100657
658Or when using Cygwin (as one line) (untested):
Bram Moolenaar30a89472016-01-10 14:35:58 +0100659
660 make -f Make_cyg.mak
661 LUA=/cygdrive/c/projects/lua53 DYNAMIC_LUA=yes LUA_VER=53
662
663
Bram Moolenaareae1b912019-05-09 15:12:55 +020066410. Building with Perl support
Bram Moolenaar30a89472016-01-10 14:35:58 +0100665==============================
666
667Vim with Perl support can be built with either MSVC or MinGW (or Cygwin).
668You can use binaries from ActiveState (ActivePerl) or Strawberry Perl.
669
670 http://www.activestate.com/activeperl
671 http://strawberryperl.com/
672
673When building, you need to set the following variables:
674
675 PERL: Where perl is installed. E.g. C:\Perl, C:\Strawberry\perl
676 DYNAMIC_PERL: Whether dynamic linking is used. Usually, set to yes.
677 PERL_VER: Perl version. E.g. 522 for Perl 5.22.X.
678
679E.g. When using MSVC (as one line):
680
681 nmake -f Make_mvc.mak
682 PERL=C:\Perl DYNAMIC_PERL=yes PERL_VER=522
683
684Or when using MinGW (as one line):
685
Bram Moolenaar18cfa942017-10-08 17:58:44 +0200686 mingw32-make -f Make_ming.mak
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +0100687 PERL=C:/Perl DYNAMIC_PERL=yes PERL_VER=522
Bram Moolenaar30a89472016-01-10 14:35:58 +0100688
689
Bram Moolenaareae1b912019-05-09 15:12:55 +020069011. Building with Ruby support
Bram Moolenaar30a89472016-01-10 14:35:58 +0100691==============================
692
693Vim with Ruby support can be built with either MSVC or MinGW (or Cygwin).
694Ruby doesn't provide the official Windows binaries. The most widely used
Bram Moolenaar18cfa942017-10-08 17:58:44 +0200695Windows binaries might be RubyInstaller. Currently Ruby 2.4 is recommended.
Bram Moolenaar30a89472016-01-10 14:35:58 +0100696
697 http://rubyinstaller.org/
698
699If you use MinGW you can easily build with RubyInstaller, but if you use MSVC
700you need some tricks described below.
701(Another binary distribution is ActiveScriptRuby:
702 http://www.artonx.org/data/asr/)
703
704When building, you need to set the following variables at least:
705
Bram Moolenaar18cfa942017-10-08 17:58:44 +0200706 RUBY: Where ruby is installed. E.g. C:\Ruby24
Bram Moolenaar6384c5d2016-09-06 22:06:35 +0200707 DYNAMIC_RUBY: Whether dynamic linking is used. Usually, set to yes.
Bram Moolenaar18cfa942017-10-08 17:58:44 +0200708 RUBY_VER: Ruby version. E.g. 24 for Ruby 2.4.X.
Bram Moolenaar6384c5d2016-09-06 22:06:35 +0200709 RUBY_API_VER_LONG: Ruby API version in a long format.
Bram Moolenaar18cfa942017-10-08 17:58:44 +0200710 E.g. 2.4.0 for Ruby 2.4.X.
Bram Moolenaar30a89472016-01-10 14:35:58 +0100711
712Ruby version vs. Ruby API version:
713
714 Ruby ver. | Ruby API ver.
715 =========================
716 1.8.X | 1.8
717 1.9.[1-3] | 1.9.1
718 2.0.0 | 2.0.0
719 2.X.Y | 2.X.0
720
721(Ruby 1.9.0 is excluded from the table because it is an unstable version.)
722
723
724A) Using MSVC
725
726If you want to link with ruby, normally you must use the same compiler as
727which was used to build the ruby binary. RubyInstaller is built with MinGW,
728so normally you cannot use MSVC for building Vim if you want to link with
Bram Moolenaar02cfac82016-04-21 14:34:58 +0200729RubyInstaller. If you use a different compiler, there are mainly two problems:
Bram Moolenaar30a89472016-01-10 14:35:58 +0100730config.h and Ruby's DLL name. Here are the steps for working around them:
731
732 1) Download and Install RubyInstaller.
733 You can install RubyInstaller with the default options and directory.
734 E.g.:
Bram Moolenaar18cfa942017-10-08 17:58:44 +0200735 C:\Ruby24 (32-bit) or C:\Ruby24-x64 (64-bit)
Bram Moolenaar30a89472016-01-10 14:35:58 +0100736
Bram Moolenaar18cfa942017-10-08 17:58:44 +0200737 Ruby 2.4.X is used in this example.
Bram Moolenaar30a89472016-01-10 14:35:58 +0100738
Bram Moolenaar18cfa942017-10-08 17:58:44 +0200739 2) Download Ruby 2.4.X's source code and generate config.h:
Bram Moolenaar30a89472016-01-10 14:35:58 +0100740
741 cd C:\projects
Bram Moolenaar18cfa942017-10-08 17:58:44 +0200742 git clone https://github.com/ruby/ruby.git -b ruby_2_4
Bram Moolenaar30a89472016-01-10 14:35:58 +0100743 cd ruby
744 win32\configure.bat
745 nmake .config.h.time
746
Bram Moolenaar18cfa942017-10-08 17:58:44 +0200747 Note that ruby_2_4 is the branch name for Ruby 2.4.X's source code.
Bram Moolenaar30a89472016-01-10 14:35:58 +0100748 There is no need to build whole Ruby, just config.h is needed.
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +0100749 If you use 32-bit MSVC 2015, the config.h is generated in the
Bram Moolenaar18cfa942017-10-08 17:58:44 +0200750 .ext\include\i386-mswin32_140 directory.
Bram Moolenaar59eb0162017-12-10 18:17:44 +0100751 If you use 64-bit MSVC 2015, the config.h is generated in the
752 .ext\include\x64-mswin64_140 directory.
Bram Moolenaar30a89472016-01-10 14:35:58 +0100753
754 3) Install the generated config.h.
755
Bram Moolenaar59eb0162017-12-10 18:17:44 +0100756 For 32-bit version:
757
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +0100758 xcopy /s .ext\include C:\Ruby24\include\ruby-2.4.0
Bram Moolenaar30a89472016-01-10 14:35:58 +0100759
Bram Moolenaar59eb0162017-12-10 18:17:44 +0100760 For 64-bit version:
761
762 xcopy /s .ext\include C:\Ruby24-x64\include\ruby-2.4.0
763
Bram Moolenaar18cfa942017-10-08 17:58:44 +0200764 Note that 2.4.0 is Ruby API version of Ruby 2.4.X.
765 You may need to close the console and reopen it to pick up the new $PATH.
Bram Moolenaar30a89472016-01-10 14:35:58 +0100766
767 4) Build Vim. Note that you need to adjust some variables (as one line):
768
Bram Moolenaar59eb0162017-12-10 18:17:44 +0100769 For 32-bit version:
770
Bram Moolenaar30a89472016-01-10 14:35:58 +0100771 nmake -f Make_mvc.mak
Bram Moolenaar18cfa942017-10-08 17:58:44 +0200772 RUBY=C:\Ruby24 DYNAMIC_RUBY=yes RUBY_VER=24 RUBY_API_VER_LONG=2.4.0
Bram Moolenaar30a89472016-01-10 14:35:58 +0100773 RUBY_MSVCRT_NAME=msvcrt
Bram Moolenaar02cfac82016-04-21 14:34:58 +0200774 WINVER=0x501
Bram Moolenaar30a89472016-01-10 14:35:58 +0100775
Bram Moolenaar59eb0162017-12-10 18:17:44 +0100776 For 64-bit version, replace RUBY=C:\Ruby24 with RUBY=C:\Ruby24-x64.
777
Bram Moolenaar02cfac82016-04-21 14:34:58 +0200778 If you set WINVER explicitly, it must be set to >=0x500, when building
779 with Ruby 2.1 or later. (Default is 0x501.)
Bram Moolenaar30a89472016-01-10 14:35:58 +0100780 When using this trick, you also need to set RUBY_MSVCRT_NAME to msvcrt
781 which is used for the Ruby's DLL name.
782
783B) Using MinGW
784
785Using MinGW is easier than using MSVC when linking with RubyInstaller.
786After you install RubyInstaller, just type this (as one line):
787
788 mingw32-make -f Make_ming.mak
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +0100789 RUBY=C:/Ruby24 DYNAMIC_RUBY=yes RUBY_VER=24 RUBY_API_VER_LONG=2.4.0
Bram Moolenaarba7e1862019-01-09 23:02:43 +0100790 WINVER=0x600
Bram Moolenaar30a89472016-01-10 14:35:58 +0100791
Bram Moolenaar59eb0162017-12-10 18:17:44 +0100792For 64-bit version, replace RUBY=C:/Ruby24 with RUBY=C:/Ruby24-x64.
Bram Moolenaar02cfac82016-04-21 14:34:58 +0200793If you set WINVER explicitly, it must be set to >=0x500, when building with
Bram Moolenaarba7e1862019-01-09 23:02:43 +0100794Ruby 2.1 or later. (Default is 0x600.)
Bram Moolenaar02cfac82016-04-21 14:34:58 +0200795
Bram Moolenaar30a89472016-01-10 14:35:58 +0100796
797
Bram Moolenaareae1b912019-05-09 15:12:55 +020079812. Building with Tcl support
Bram Moolenaar30a89472016-01-10 14:35:58 +0100799=============================
800
801Vim with Tcl support can be built with either MSVC or MinGW (or Cygwin).
802You can use binaries from ActiveState (ActiveTcl).
803
804 http://www.activestate.com/activetcl
805
Bram Moolenaarba7e1862019-01-09 23:02:43 +0100806Alternatively, you can use the binaries provided by IronTcl from
807
808 https://www.irontcl.com/
809
810They might lack behind the latest version a bit, but should provide 64bit
811and 32bit versions even if ActiveTcl does not provide them anymore.
812
813For building with MSVC 2015 use version 8.6.6 or later.
Bram Moolenaar30a89472016-01-10 14:35:58 +0100814When building, you need to set the following variables:
815
816 TCL: Where tcl is installed. E.g. C:\Tcl86
817 DYNAMIC_TCL: Whether dynamic linking is used. Usually, set to yes.
818 TCL_VER: Tcl version in a short format. E.g. 86 for Tcl 8.6.X.
819 TCL_VER_LONG: Tcl version in a long format. E.g. 8.6 for Tcl 8.6.X.
820
Bram Moolenaar18cfa942017-10-08 17:58:44 +0200821Sometimes the Tcl dll name changes. E.g. ActiveTcl 8.6.4 comes with tcl86.dll,
822but ActiveTcl 8.6.6 comes with tcl86t.dll. You can set the dll name by setting
823the TCL_DLL variable:
824 TCL_DLL=tcl86t.dll
825
Bram Moolenaar30a89472016-01-10 14:35:58 +0100826E.g. When using MSVC (as one line):
827
828 nmake -f Make_mvc.mak
829 TCL=C:\Tcl86 DYNAMIC_TCL=yes TCL_VER=86 TCL_VER_LONG=8.6
830
831Or when using MinGW (as one line):
832
Bram Moolenaar18cfa942017-10-08 17:58:44 +0200833 mingw32-make -f Make_ming.mak
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +0100834 TCL=C:/Tcl86 DYNAMIC_TCL=yes TCL_VER=86 TCL_VER_LONG=8.6
Bram Moolenaar30a89472016-01-10 14:35:58 +0100835
836
Bram Moolenaar8024f932020-01-14 19:29:13 +010083713. Building with DirectX (DirectWrite) support
Bram Moolenaar7f88b652017-12-14 13:15:19 +0100838===============================================
839
840Vim with DirectX (DirectWrite) support can be built with either MSVC or MinGW.
841This requires dwrite_2.h and some other header files which come with Windows
842SDK 8.1 or later (or MinGW-w64), if you want to enable color emoji support.
843This also requires MBYTE=yes which is enabled by default.
844
845A) Using MSVC
846
847If you use MSVC 2013 or later, Windows SDK 8.1 or later is used by default.
848You just need to specify DIRECTX=yes:
849
850 nmake -f Make_mvc.mak DIRECTX=yes
851
852If you use MSVC 2012 or earlier, the required header files are not available
853by default. However, you can use the header files from newer SDKs with older
854compilers. E.g.:
855
856 set "INCLUDE=%INCLUDE%;C:\Program Files (x86)\Windows Kits\8.1\Include\um"
857 nmake -f Make_mvc.mak DIRECTX=yes
858
859If you don't need color emoji support, only dwrite.h is required. You can use
860older compilers (e.g. VC2010) without Windows SDK 8.1. E.g.:
861
862 nmake -f Make_mvc.mak DIRECTX=yes COLOR_EMOJI=no
863
864B) Using MinGW-w64
865
866Just set DIRECTX to yes:
867
868 mingw32-make -f Make_ming.mak DIRECTX=yes
869
870
K.Takatad8f86292022-03-07 15:16:15 +000087114. Building with libsodium support
872===================================
873
874For better encryption support, you can build Vim with libsodium.
875
876A) Using MSVC
877
878You can download the latest libsodium library from here:
879 https://download.libsodium.org/libsodium/releases/
880
881At this moment, libsodium-1.0.18-stable-msvc.zip is the latest package.
882Unpack it to anywhere you like, and specify the path to the SODIUM option:
883
884 nmake -f Make_mvc.mak SODIUM=C:/path/to/libsodium
885 (libsodium.dll will be used as the libsodium DLL name.)
886
887B) Using MinGW
888
889If you use msys2, you can install the libsodium package by pacman (or pacboy):
890
891 $ pacman -S mingw-w64-x86_64-libsodium # for 64-bit Vim
892 $ pacman -S mingw-w64-i686-libsodium # for 32-bit Vim
893 $ pacboy -S libsodium:m # for both 32-bit and 64-bit Vim
894
895Then set SODIUM to yes:
896
897 mingw32-make -f Make_ming.mak SODIUM=yes
898 (libsodium-23.dll will be used as the libsodium DLL name.)
899
900Or you can set the path to libsodium explicitly:
901
902 mingw32-make -f Make_ming.mak SODIUM=C:/path/to/libsodium
903 (libsodium.dll will be used as the libsodium DLL name.)
904
905
90615. Windows 3.1x
Bram Moolenaar30a89472016-01-10 14:35:58 +0100907================
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000908
Bram Moolenaar6e722e22016-02-26 19:58:58 +0100909The Windows 3.1x support was removed in patch 7.4.1364.
Bram Moolenaar362e1a32006-03-06 23:29:24 +0000910
911
K.Takatad8f86292022-03-07 15:16:15 +000091216. MS-DOS
Bram Moolenaar30a89472016-01-10 14:35:58 +0100913==========
Bram Moolenaar071d4272004-06-13 20:20:40 +0000914
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +0100915The MS-DOS support was removed in patch 7.4.1399. Only very old Vim versions
916work on MS-DOS because of the limited amount of memory available.
Bram Moolenaar734d9982011-07-15 13:52:04 +0200917
918
K.Takatad8f86292022-03-07 15:16:15 +000091917. Installing after building from sources
Bram Moolenaar734d9982011-07-15 13:52:04 +0200920==========================================
921
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +0100922[provided by Michael Soyka, updated by Ken Takata]
Bram Moolenaar734d9982011-07-15 13:52:04 +0200923
924After you've built the Vim binaries as described above, you're ready to
925install Vim on your system. However, if you've obtained the Vim sources
Bram Moolenaar30a89472016-01-10 14:35:58 +0100926using Git, Mercurial or by downloading them as a unix tar file, you must
Bram Moolenaar8024f932020-01-14 19:29:13 +0100927first create a "vim82" directory. If you instead downloaded the sources as
Bram Moolenaar734d9982011-07-15 13:52:04 +0200928zip files, you can skip this setup as the zip archives already have the
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100929correct directory structure.
Bram Moolenaar734d9982011-07-15 13:52:04 +0200930
Bram Moolenaar8024f932020-01-14 19:29:13 +0100931 A. Create a Vim "runtime" subdirectory named "vim82"
Bram Moolenaar734d9982011-07-15 13:52:04 +0200932 -----------------------------------------------------
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100933 If you obtained your Vim sources as zip files, you can skip this step.
Bram Moolenaar734d9982011-07-15 13:52:04 +0200934 Otherwise, continue reading.
935
936 Go to the directory that contains the Vim "src" and "runtime"
Bram Moolenaar8024f932020-01-14 19:29:13 +0100937 directories and create a new subdirectory named "vim82".
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100938
Bram Moolenaar8024f932020-01-14 19:29:13 +0100939 Copy the "runtime" files into "vim82":
940 copy runtime\* vim82
Bram Moolenaarade0d392020-01-21 22:33:58 +0100941 xcopy /s runtime\* vim82
Bram Moolenaar734d9982011-07-15 13:52:04 +0200942
Bram Moolenaar8024f932020-01-14 19:29:13 +0100943 B. Copy the new binaries into the "vim82" directory
Bram Moolenaar734d9982011-07-15 13:52:04 +0200944 ----------------------------------------------------
945 Regardless of how you installed the Vim sources, you need to copy the
Bram Moolenaar8024f932020-01-14 19:29:13 +0100946 new binaries you created above into "vim82":
Bram Moolenaar734d9982011-07-15 13:52:04 +0200947
Bram Moolenaar8024f932020-01-14 19:29:13 +0100948 copy src\*.exe vim82
949 copy src\tee\tee.exe vim82
950 copy src\xxd\xxd.exe vim82
Bram Moolenaar734d9982011-07-15 13:52:04 +0200951
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +0100952 To install the "Edit with Vim" popup menu, you need both 32-bit and 64-bit
Bram Moolenaar8024f932020-01-14 19:29:13 +0100953 versions of gvimext.dll. They should be copied to "vim82\GvimExt32" and
954 "vim82\GvimExt64" respectively.
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +0100955 First, build the 32-bit version, then:
956
Bram Moolenaar8024f932020-01-14 19:29:13 +0100957 mkdir vim82\GvimExt32
958 copy src\GvimExt\gvimext.dll vim82\GvimExt32
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +0100959
960 Next, clean the 32-bit version and build the 64-bit version, then:
961
Bram Moolenaar8024f932020-01-14 19:29:13 +0100962 mkdir vim82\GvimExt64
963 copy src\GvimExt\gvimext.dll vim82\GvimExt64
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +0100964
Bram Moolenaar8024f932020-01-14 19:29:13 +0100965 C. Copy gettext and iconv DLLs into the "vim82" directory
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +0100966 ----------------------------------------------------------
967 Get gettext and iconv DLLs from the following site:
968 https://github.com/mlocati/gettext-iconv-windows/releases
969 Both 64- and 32-bit versions are needed.
970 Download the files gettextX.X.X.X-iconvX.XX-shared-{32,64}.zip, extract
971 DLLs and place them as follows:
972
Bram Moolenaar8024f932020-01-14 19:29:13 +0100973 vim82\
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +0100974 | libintl-8.dll
975 | libiconv-2.dll
976 | libgcc_s_sjlj-1.dll (only for 32-bit)
977 |
978 + GvimExt32\
979 | libintl-8.dll
980 | libiconv-2.dll
981 | libgcc_s_sjlj-1.dll
982 |
983 ` GvimExt64\
984 libintl-8.dll
985 libiconv-2.dll
986
Bram Moolenaar8024f932020-01-14 19:29:13 +0100987 The DLLs in the "vim82" should be the same bitness with the (g)vim.exe.
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +0100988
Bram Moolenaar8024f932020-01-14 19:29:13 +0100989 D. Move the "vim82" directory into the Vim installation subdirectory
Bram Moolenaar734d9982011-07-15 13:52:04 +0200990 ---------------------------------------------------------------------
Bram Moolenaar8024f932020-01-14 19:29:13 +0100991 Move the "vim82" subdirectory into the subdirectory where you want Vim
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +0100992 to be installed. Typically, this subdirectory will be named "vim".
Bram Moolenaar8024f932020-01-14 19:29:13 +0100993 If you already have a "vim82" subdirectory in "vim", delete it first
Bram Moolenaar30e8e732019-09-27 13:08:36 +0200994 by running its uninstall.exe program.
Bram Moolenaar734d9982011-07-15 13:52:04 +0200995
Bram Moolenaar3bf8c3c2017-11-05 16:04:43 +0100996 E. Install Vim
Bram Moolenaar734d9982011-07-15 13:52:04 +0200997 ---------------
Bram Moolenaar8024f932020-01-14 19:29:13 +0100998 "cd" to your Vim installation subdirectory "vim\vim82" and run the
Bram Moolenaar734d9982011-07-15 13:52:04 +0200999 "install.exe" program. It will ask you a number of questions about
1000 how you would like to have your Vim setup. Among these are:
1001 - You can tell it to write a "_vimrc" file with your preferences in the
1002 parent directory.
1003 - It can also install an "Edit with Vim" entry in the Windows Explorer
1004 popup menu.
1005 - You can have it create batch files, so that you can run Vim from the
1006 console or in a shell. You can select one of the directories in your
Bram Moolenaar3c6f92e2016-01-02 20:26:36 +01001007 PATH or add the directory to PATH using the Windows Control Panel.
Bram Moolenaar734d9982011-07-15 13:52:04 +02001008 - Create entries for Vim on the desktop and in the Start menu.
1009
1010Happy Vimming!