Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 1 | INSTALLpc.txt - Installation of Vim on PC |
| 2 | |
| 3 | This file contains instructions for compiling Vim. If you already have an |
| 4 | executable version of Vim, you don't need this. |
| 5 | |
Bram Moolenaar | a87f8fd | 2018-09-18 22:58:41 +0200 | [diff] [blame] | 6 | You can find the latest here: https://github.com/vim/vim-win32-installer |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 7 | This page also has links to install support for interfaces such as Perl, |
| 8 | Python, Lua, etc. |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 9 | |
| 10 | The file "feature.h" can be edited to match your preferences. You can skip |
| 11 | this, then you will get the default behavior as is documented, which should |
| 12 | be fine for most people. |
| 13 | |
Bram Moolenaar | 02cfac8 | 2016-04-21 14:34:58 +0200 | [diff] [blame] | 14 | This document assumes that you are building Vim for Win32 or later (Windows |
| 15 | XP/2003/Vista/7/8/10). There are also instructions for pre-XP systems, but |
| 16 | they might no longer work. |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 17 | |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 18 | The recommended way is to build a 32 bit Vim, also on 64 bit systems. You can |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 19 | build a 64 bit Vim if you like, the executable will be bigger and Vim won't be |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 20 | any faster, but you can edit files larger than 2 Gbyte. |
| 21 | |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 22 | |
| 23 | Contents: |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 24 | 1. Microsoft Visual C++ |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 25 | 2. Using MSYS2 with MinGW |
| 26 | 3. Using MinGW |
| 27 | 4. Cygwin |
| 28 | 5. Borland |
| 29 | 6. Cross compiling for Win32 from a Linux machine |
| 30 | 7. Building with Python support |
| 31 | 8. Building with Python3 support |
| 32 | 9. Building with Racket or MzScheme support |
| 33 | 10. Building with Lua support |
| 34 | 11. Building with Perl support |
| 35 | 12. Building with Ruby support |
| 36 | 13. Building with Tcl support |
| 37 | 14. Building with Terminal support |
| 38 | 15. Building with DirectX (DirectWrite) support |
| 39 | 16. Windows 3.1 |
| 40 | 17. MS-DOS |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 41 | |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 42 | 18. Installing after building from sources |
Bram Moolenaar | 734d998 | 2011-07-15 13:52:04 +0200 | [diff] [blame] | 43 | |
| 44 | |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 45 | The currently recommended way (that means it has been verified to work) is |
| 46 | using the "Visual Studio Community 2015" installation. This includes the SDK |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 47 | needed to target Windows XP. But not older Windows versions (95, 98), see |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 48 | |msvc-2008-express| below for that |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 49 | |
| 50 | |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 51 | 1. Microsoft Visual C++ |
| 52 | ======================= |
| 53 | |
Bram Moolenaar | 73f4439 | 2017-10-07 18:38:43 +0200 | [diff] [blame] | 54 | We do not provide download links, since Microsoft keeps changing them. You |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 55 | can search for "Visual Studio Community 2015", for example. You will need to |
Bram Moolenaar | 73f4439 | 2017-10-07 18:38:43 +0200 | [diff] [blame] | 56 | create a Microsoft account (it's free). |
| 57 | |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 58 | When installing "Visual Studio Community 2015 with Update 3" make sure to |
| 59 | select "custom" and check "Windows XP Support for C++" and all checkboxes |
| 60 | under "Universal Windows App Development Tools" |
| 61 | |
Bram Moolenaar | 73f4439 | 2017-10-07 18:38:43 +0200 | [diff] [blame] | 62 | |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 63 | Visual Studio |
| 64 | ------------- |
| 65 | |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 66 | Building with Visual Studio (VS 98, VS .NET, VS .NET 2003, VS 2005, VS 2008, |
| 67 | VS2010, VS2012, VS2013 and VS2015) is straightforward. (These instructions |
| 68 | should also work for VS 4 and VS 5.) |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 69 | |
Bram Moolenaar | 73f4439 | 2017-10-07 18:38:43 +0200 | [diff] [blame] | 70 | Using VS C++ 2008 Express is recommended if you need the binary to run on |
| 71 | Windows 95 or 97, see |msvc-2008-express| below. |
Bram Moolenaar | 97cc238 | 2012-10-03 21:46:54 +0200 | [diff] [blame] | 72 | |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 73 | To build Vim from the command line with MSVC, use Make_mvc.mak. |
| 74 | Visual Studio installed a batch file called vcvars32.bat, which you must |
| 75 | run to set up paths for nmake and MSVC. |
| 76 | |
Bram Moolenaar | c9b4b05 | 2006-04-30 18:54:39 +0000 | [diff] [blame] | 77 | nmake -f Make_mvc.mak console Win32 SDK or Microsoft Visual C++ |
| 78 | nmake -f Make_mvc.mak GUI=yes GUI Microsoft Visual C++ |
| 79 | nmake -f Make_mvc.mak OLE=yes OLE Microsoft Visual C++ |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 80 | nmake -f Make_mvc.mak PERL=C:\Perl PYTHON=C:\Python etc. |
Bram Moolenaar | c9b4b05 | 2006-04-30 18:54:39 +0000 | [diff] [blame] | 81 | Perl, Python, etc. |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 82 | |
| 83 | Make_mvc.mak allows a Vim to be built with various different features and |
| 84 | debug support. Debugging with MS Devstudio is provided by Make_dvc.mak. |
| 85 | For a description of the use of Make_dvc.mak, look in Make_mvc.mak. |
| 86 | |
| 87 | For compiling Gvim with IME support on far-east Windows, add IME=yes |
| 88 | to the parameters you pass to Make_mvc.mak. |
| 89 | |
| 90 | To build Vim from within the Visual Studio IDE, open the Make_ivc.mak project. |
| 91 | (Note: Make_ivc.mak is not as rich as Make_mvc.mak, which allows for |
| 92 | far more configuration.) Make_ivc.mak can also be built with nmake. |
| 93 | |
| 94 | nmake -f Make_ivc.mak CFG="Vim - Win32 Release gvim" |
Bram Moolenaar | c9b4b05 | 2006-04-30 18:54:39 +0000 | [diff] [blame] | 95 | GUI Microsoft Visual C++ 4.x or later |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 96 | nmake -f Make_ivc.mak CFG="Vim - Win32 Release gvim OLE" |
Bram Moolenaar | c9b4b05 | 2006-04-30 18:54:39 +0000 | [diff] [blame] | 97 | OLE Microsoft Visual C++ 4.x or later |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 98 | |
| 99 | See the specific files for comments and options. |
| 100 | |
| 101 | These files have been supplied by George V. Reilly, Ben Singer, Ken Scott and |
| 102 | Ron Aaron; they have been tested. |
| 103 | |
| 104 | |
Bram Moolenaar | 02cfac8 | 2016-04-21 14:34:58 +0200 | [diff] [blame] | 105 | Visual C++ 2008 Express Edition *msvc-2008-express* |
| 106 | ------------------------------- |
| 107 | |
| 108 | Visual C++ 2008 Express Edition can be downloaded for free from: |
| 109 | http://www.microsoft.com/express/downloads/ |
| 110 | This includes the IDE and the debugger. |
| 111 | |
| 112 | To set the environment execute the msvc2008.bat script. You can then build |
| 113 | Vim with Make_mvc.mak. |
| 114 | |
| 115 | For building 64 bit binaries you also need to install the SDK: |
| 116 | "Microsoft Windows SDK for Windows 7 and .NET Framework 3.5 SP1" |
| 117 | You don't need the examples and documentation. |
| 118 | |
| 119 | If you get an error that Win32.mak can't be found, you have to set the |
| 120 | variable SDK_INCLUDE_DIR. For example, on Windows 10, installation of MSVC |
| 121 | puts include files in the following directory: |
| 122 | set SDK_INCLUDE_DIR=C:\Program Files\Microsoft SDKs\Windows\v6.0A\Include |
| 123 | |
| 124 | |
| 125 | Visual C++ 2010 Express Edition *msvc-2010-express* |
| 126 | ------------------------------- |
| 127 | |
| 128 | Visual C++ 2010 Express Edition can be downloaded for free from: |
| 129 | http://www.microsoft.com/express/vc/Default.aspx |
| 130 | This includes the IDE and the debugger. |
| 131 | |
| 132 | To set the environment execute the msvc2010.bat script. You can then build |
| 133 | Vim with Make_mvc.mak. |
| 134 | |
| 135 | |
Bram Moolenaar | 73f4439 | 2017-10-07 18:38:43 +0200 | [diff] [blame] | 136 | Targeting Windows XP with MSVC 2012 and later *new-msvc-windows-xp* |
| 137 | --------------------------------------------- |
Bram Moolenaar | 02cfac8 | 2016-04-21 14:34:58 +0200 | [diff] [blame] | 138 | |
| 139 | Beginning with Visual C++ 2012, Microsoft changed the behavior of LINK.EXE |
| 140 | so that it targets Windows 6.0 (Vista) by default. In order to override |
| 141 | this, the target Windows version number needs to be passed to LINK like |
| 142 | follows: |
| 143 | LINK ... /subsystem:console,5.01 |
| 144 | |
| 145 | Make_mvc.mak now supports a macro SUBSYSTEM_VER to pass the Windows version. |
Bram Moolenaar | 73f4439 | 2017-10-07 18:38:43 +0200 | [diff] [blame] | 146 | Use lines like follows to target Windows XP x86 (assuming using Visual C++ |
| 147 | 2012 under 64-bit Windows): |
Bram Moolenaar | 02cfac8 | 2016-04-21 14:34:58 +0200 | [diff] [blame] | 148 | set WinSdk71=%ProgramFiles(x86)%\Microsoft SDKs\Windows\v7.1A |
Bram Moolenaar | 02cfac8 | 2016-04-21 14:34:58 +0200 | [diff] [blame] | 149 | set INCLUDE=%WinSdk71%\Include;%INCLUDE% |
| 150 | set LIB=%WinSdk71%\Lib;%LIB% |
Bram Moolenaar | 02cfac8 | 2016-04-21 14:34:58 +0200 | [diff] [blame] | 151 | set CL=/D_USING_V110_SDK71_ |
| 152 | nmake -f Make_mvc.mak ... WINVER=0x0501 SUBSYSTEM_VER=5.01 |
| 153 | |
Bram Moolenaar | 73f4439 | 2017-10-07 18:38:43 +0200 | [diff] [blame] | 154 | To target Windows XP x64 instead of x86, you need to change the settings of |
| 155 | LIB and SUBSYSTEM_VER: |
| 156 | ... |
| 157 | set LIB=%WinSdk71%\Lib\x64;%LIB% |
| 158 | ... |
| 159 | nmake -f Make_mvc.mak ... WINVER=0x0501 SUBSYSTEM_VER=5.02 |
| 160 | |
| 161 | If you use Visual C++ 2015 (either Express or Community Edition), executing |
| 162 | msvc2015.bat will set them automatically. For x86 builds run this without |
| 163 | options: |
| 164 | msvc2015 |
| 165 | For x64 builds run this with the "x86_amd64" option: |
| 166 | msvc2015 x86_amd64 |
Bram Moolenaar | a87f8fd | 2018-09-18 22:58:41 +0200 | [diff] [blame] | 167 | This enables x86_x64 cross compiler. This works on any editions including |
| 168 | Express edition. |
| 169 | If you use Community (or Professional) edition, you can enable the x64 native |
| 170 | compiler by using the "x64" option: |
| 171 | msvc2015 x64 |
Bram Moolenaar | 73f4439 | 2017-10-07 18:38:43 +0200 | [diff] [blame] | 172 | |
Bram Moolenaar | 02cfac8 | 2016-04-21 14:34:58 +0200 | [diff] [blame] | 173 | The following Visual C++ team blog can serve as a reference page: |
| 174 | http://blogs.msdn.com/b/vcblog/archive/2012/10/08/windows-xp-targeting-with-c-in-visual-studio-2012.aspx |
| 175 | |
| 176 | |
Bram Moolenaar | 577fadf | 2019-04-04 20:32:24 +0200 | [diff] [blame^] | 177 | Cross compile support for Windows on ARM64 |
| 178 | ------------------------------------------ |
| 179 | |
| 180 | This depends on VS2017 with the optional ARM64 compiler and SDK |
| 181 | installed. Use "vcvarsall.bat x64_arm64" as the build environment. |
| 182 | |
| 183 | The ARM64 support was provided by Leendert van Doorn. |
| 184 | |
| 185 | |
Bram Moolenaar | 02cfac8 | 2016-04-21 14:34:58 +0200 | [diff] [blame] | 186 | OLDER VERSIONS |
| 187 | |
| 188 | The minimal supported version is Windows XP. Building with older compilers |
| 189 | might still work, but these instructions might be outdated. |
| 190 | |
| 191 | If you need the executable to run on Windows 98 or ME, use the 2003 one |
| 192 | |msvc-2003-toolkit|. |
| 193 | |
Bram Moolenaar | c236c16 | 2008-07-13 17:41:49 +0000 | [diff] [blame] | 194 | Visual C++ Toolkit 2003 *msvc-2003-toolkit* |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 195 | ----------------------- |
| 196 | |
Bram Moolenaar | c236c16 | 2008-07-13 17:41:49 +0000 | [diff] [blame] | 197 | You could download the Microsoft Visual C++ Toolkit 2003 from |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 198 | http://msdn.microsoft.com/visualc/vctoolkit2003/ |
Bram Moolenaar | a87f8fd | 2018-09-18 22:58:41 +0200 | [diff] [blame] | 199 | Unfortunately this URL is no longer valid. Unofficial downloads appear to be |
Bram Moolenaar | c236c16 | 2008-07-13 17:41:49 +0000 | [diff] [blame] | 200 | available from links mentioned on these pages (use at your own risk): |
| 201 | http://www.filewatcher.com/m/VCToolkitSetup.exe.32952488.0.0.html |
| 202 | http://feargame.net/wiki/index.php?title=Building_Source_with_the_VC2003_Toolkit |
| 203 | |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 204 | This contains the command-line tools (compiler, linker, CRT headers, |
| 205 | and libraries) for Visual Studio .NET 2003, but not the Visual Studio IDE. |
| 206 | To compile and debug Vim with the VC2003 Toolkit, you will also need |
| 207 | |ms-platform-sdk|, |dotnet-1.1-redist|, |dotnet-1.1-sdk|, |
| 208 | and |windbg-download|. |
| 209 | |
Bram Moolenaar | 0fde290 | 2008-03-16 13:54:13 +0000 | [diff] [blame] | 210 | It's easier to download Visual C++ 2008 Express Edition, |msvc-2008-express|, |
| 211 | which is freely available in perpetuity. |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 212 | |
| 213 | The free Code::Blocks IDE works with the VC2003 Toolkit, as described at |
| 214 | http://wiki.codeblocks.org/index.php?title=Integrating_Microsoft_Visual_Toolkit_2003_with_Code::Blocks_IDE |
| 215 | (This site also takes you through configuring a number of other |
| 216 | free C compilers for Win32.) |
| 217 | |
| 218 | To compile Vim using the VC2003 Toolkit and Make_mvc.mak, you must first |
| 219 | execute the following commands in a cmd.exe window (the msvcsetup.bat batch |
| 220 | file can be used): |
Bram Moolenaar | c9b4b05 | 2006-04-30 18:54:39 +0000 | [diff] [blame] | 221 | |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 222 | set PATH=%SystemRoot%\Microsoft.NET\Framework\v1.1.4322;%PATH% |
| 223 | call "%VCToolkitInstallDir%vcvars32.bat" |
| 224 | set MSVCVer=7.1 |
| 225 | call "%ProgramFiles%\Microsoft Platform SDK\SetEnv.Cmd" |
| 226 | set LIB=%ProgramFiles%\Microsoft Visual Studio .NET 2003\Vc7\lib;%LIB% |
| 227 | |
| 228 | Now you can build Vim with Make_mvc.mak. |
| 229 | |
| 230 | |
Bram Moolenaar | c9b4b05 | 2006-04-30 18:54:39 +0000 | [diff] [blame] | 231 | Getting the Windows Platform SDK *ms-platform-sdk* |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 232 | |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 233 | You will also need a copy of the Windows Platform SDK. Specifically, you need |
| 234 | the Windows Core SDK subset of the Platform SDK, which contains the Windows |
| 235 | headers and libraries. You need to search for it, Microsoft keeps changing |
| 236 | the URL. |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 237 | |
| 238 | |
| 239 | Getting the .NET Framework 1.1 Runtime *dotnet-1.1-redist* |
| 240 | |
| 241 | You need the .NET Framework 1.1 Redistributable Package from |
| 242 | http://www.microsoft.com/downloads/details.aspx?familyid=262d25e3-f589-4842-8157-034d1e7cf3a3 |
| 243 | or from Windows Update: |
| 244 | http://windowsupdate.microsoft.com/ |
| 245 | This is needed to install |dotnet-1.1-sdk|. It also contains cvtres.exe, |
| 246 | which is needed to link Vim. |
| 247 | |
| 248 | |
Bram Moolenaar | c9b4b05 | 2006-04-30 18:54:39 +0000 | [diff] [blame] | 249 | Getting the .NET Framework 1.1 SDK *dotnet-1.1-sdk* |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 250 | |
| 251 | You need the .NET Framework 1.1 SDK from |
| 252 | http://www.microsoft.com/downloads/details.aspx?familyid=9b3a2ca6-3647-4070-9f41-a333c6b9181d |
| 253 | This contains some additional libraries needed to compile Vim, |
| 254 | such as msvcrt.lib. You must install |dotnet-1.1-redist| before |
| 255 | installing the .NET 1.1 SDK. |
| 256 | |
| 257 | |
Bram Moolenaar | c9b4b05 | 2006-04-30 18:54:39 +0000 | [diff] [blame] | 258 | Getting the WinDbg debugger *windbg-download* |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 259 | |
| 260 | The Debugging Tools for Windows can be downloaded from |
| 261 | http://www.microsoft.com/whdc/devtools/debugging/default.mspx |
| 262 | This includes the WinDbg debugger, which you will want if you ever need |
| 263 | to debug Vim itself. An earlier version of the Debugging Tools |
| 264 | is also available through the Platform SDK, |ms-platform-sdk|. |
| 265 | |
| 266 | |
Bram Moolenaar | 98385dc | 2008-06-20 14:52:32 +0000 | [diff] [blame] | 267 | Visual C++ 2005 Express Edition *msvc-2005-express* |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 268 | ------------------------------- |
| 269 | |
Bram Moolenaar | fc1421e | 2006-04-20 22:17:20 +0000 | [diff] [blame] | 270 | Visual C++ 2005 Express Edition can be downloaded for free from: |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 271 | http://msdn.microsoft.com/vstudio/express/visualC/default.aspx |
| 272 | This includes the IDE and the debugger. You will also need |
| 273 | |ms-platform-sdk|. You can build Vim with Make_mvc.mak. |
| 274 | |
| 275 | Instructions for integrating the Platform SDK into VC Express: |
| 276 | http://msdn.microsoft.com/vstudio/express/visualc/usingpsdk/default.aspx |
| 277 | |
| 278 | |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 279 | 2. MSYS2 with MinGW |
| 280 | =================== |
Bram Moolenaar | ce2f2e0 | 2014-08-22 18:12:57 +0200 | [diff] [blame] | 281 | |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 282 | 2.1. Setup the basic msys2 environment |
| 283 | |
| 284 | Go to the official page of MSYS2: https://www.msys2.org |
| 285 | Download an installer: |
| 286 | |
| 287 | * msys2-x86_64-YYYYMMDD.exe for 64-bit Windows |
| 288 | (Even if you want to build 32-bit Vim) |
| 289 | * msys2-i686-YYYYMMDD.exe for 32-bit Windows |
| 290 | |
| 291 | Execute the installer and follow the instructions to update basic packages. |
| 292 | At the end keep the checkbox checked to run msys2 now. If needed, you can |
Bram Moolenaar | a87f8fd | 2018-09-18 22:58:41 +0200 | [diff] [blame] | 293 | open the window from the start menu, MSYS2 64 bit / MSYS2 MSYS. |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 294 | |
| 295 | Execute: |
| 296 | $ pacman -Syu |
Bram Moolenaar | a87f8fd | 2018-09-18 22:58:41 +0200 | [diff] [blame] | 297 | |
| 298 | And restart MSYS2 console (select "MSYS2 MSYS" icon from the Start Menu). |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 299 | Then execute: |
| 300 | $ pacman -Su |
| 301 | |
| 302 | If pacman complains that `catgets` and `libcatgets` conflict with another |
| 303 | package, select `y` to remove them. |
| 304 | |
| 305 | |
| 306 | 2.2. Install additional packages for building Vim |
| 307 | |
| 308 | The following package groups are required for building Vim: |
| 309 | |
| 310 | * base-devel |
| 311 | * mingw-w64-i686-toolchain (for building 32-bit Vim) |
| 312 | * mingw-w64-x86_64-toolchain (for building 64-bit Vim) |
| 313 | |
Bram Moolenaar | a87f8fd | 2018-09-18 22:58:41 +0200 | [diff] [blame] | 314 | (These groups also include some useful packages which are not used by Vim.) |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 315 | Use the following command to install them: |
| 316 | |
| 317 | $ pacman -S base-devel mingw-w64-i686-toolchain mingw-w64-x86_64-toolchain |
| 318 | |
| 319 | Or you can use the `pacboy` command to avoid long package names: |
| 320 | |
| 321 | $ pacboy -S base-devel: toolchain:m |
| 322 | |
Bram Moolenaar | a87f8fd | 2018-09-18 22:58:41 +0200 | [diff] [blame] | 323 | The suffix ":" means that it disables the package name translation. |
| 324 | The suffix ":m" means both i686 and x86_64. You can also use the ":i" suffix |
| 325 | to install only i686, and the ":x" suffix to install only x86_64. |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 326 | (See `pacboy help` for the help.) |
| 327 | |
Bram Moolenaar | a87f8fd | 2018-09-18 22:58:41 +0200 | [diff] [blame] | 328 | See also the pacman page in ArchWiki for the general usage of pacman: |
| 329 | https://wiki.archlinux.org/index.php/pacman |
| 330 | |
| 331 | MSYS2 has its own git package, and you can also install it via pacman: |
| 332 | |
| 333 | $ pacman -S git |
| 334 | |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 335 | |
| 336 | 2.3. Keep the build environment up-to-date |
| 337 | |
| 338 | After you have installed the build environment, you may want to keep it |
| 339 | up-to-date (E.g. always use the latest GCC). |
| 340 | In that case, you just need to execute the command: |
| 341 | $ pacman -Syu |
| 342 | |
| 343 | |
Bram Moolenaar | a87f8fd | 2018-09-18 22:58:41 +0200 | [diff] [blame] | 344 | 2.4. Build Vim |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 345 | |
| 346 | Select one of the following icon from the Start Menu: |
| 347 | |
| 348 | * MSYS2 MinGW 32-bit (To build 32-bit versions of Vim) |
| 349 | * MSYS2 MinGW 64-bit (To build 64-bit versions of Vim) |
| 350 | |
| 351 | Go to the source directory of Vim, then execute the make command. E.g.: |
| 352 | |
| 353 | make -f Make_ming.mak |
| 354 | make -f Make_ming.mak GUI=no |
| 355 | make -f Make_ming.mak GUI=no DEBUG=yes |
| 356 | |
Bram Moolenaar | a87f8fd | 2018-09-18 22:58:41 +0200 | [diff] [blame] | 357 | NOTE: you can't execute vim.exe in the MSYS2 console, open a normal Windows |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 358 | console for that. You need to set $PATH to be able to build there, e.g.: |
| 359 | |
| 360 | set PATH=c:\msys64\mingw32\bin;c:\msys64\usr\bin;%PATH% |
| 361 | |
Bram Moolenaar | a87f8fd | 2018-09-18 22:58:41 +0200 | [diff] [blame] | 362 | This command is in msys32.bat. Or for the 64 bit compiler use msys64.bat: |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 363 | |
| 364 | set PATH=c:\msys64\mingw64\bin;c:\msys64\usr\bin;%PATH% |
| 365 | |
| 366 | If you have msys64 in another location you will need to adjust the paths for |
| 367 | that. |
| 368 | |
| 369 | |
| 370 | 3. MinGW |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 371 | ======== |
| 372 | |
| 373 | (written by Ron Aaron: <ronaharon@yahoo.com>) |
| 374 | |
| 375 | This is about how to produce a Win32 binary of gvim with MinGW. |
| 376 | |
| 377 | First, you need to get the 'mingw32' compiler, which is free for the download |
| 378 | at: |
| 379 | |
| 380 | http://www.mingw.org/ |
| 381 | |
Bram Moolenaar | 4f7e821 | 2014-11-05 13:53:32 +0100 | [diff] [blame] | 382 | or you can use 'MinGW-w64' compiler. |
| 383 | |
| 384 | http://mingw-w64.sourceforge.net/ |
| 385 | |
Bram Moolenaar | 3c6f92e | 2016-01-02 20:26:36 +0100 | [diff] [blame] | 386 | Or a compiler provided on msys2: |
| 387 | |
| 388 | https://msys2.github.io/ |
| 389 | |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 390 | Once you have downloaded the compiler binaries, unpack them on your hard disk |
| 391 | somewhere, and put them on your PATH. If you are on Win95/98 you can edit |
| 392 | your AUTOEXEC.BAT file with a line like: |
| 393 | |
Bram Moolenaar | 4f7e821 | 2014-11-05 13:53:32 +0100 | [diff] [blame] | 394 | set PATH=C:\MinGW\bin;%PATH% |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 395 | |
| 396 | or on NT/2000/XP, go to the Control Panel, (Performance and Maintenance), |
Bram Moolenaar | 3c6f92e | 2016-01-02 20:26:36 +0100 | [diff] [blame] | 397 | System, Advanced, and edit the environment from there. If you use msys2 |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 398 | compilers, set your installed paths (normally one of the following): |
Bram Moolenaar | 3c6f92e | 2016-01-02 20:26:36 +0100 | [diff] [blame] | 399 | |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 400 | C:\msys32\mingw32\bin (32-bit msys2, targeting 32-bit builds) |
| 401 | C:\msys64\mingw32\bin (64-bit msys2, targeting 32-bit builds) |
| 402 | C:\msys64\mingw64\bin (64-bit msys2, targeting 64-bit builds) |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 403 | |
| 404 | Test if gcc is on your path. From a CMD (or COMMAND on '95/98) window: |
| 405 | |
| 406 | C:\> gcc --version |
Bram Moolenaar | 4f7e821 | 2014-11-05 13:53:32 +0100 | [diff] [blame] | 407 | gcc (GCC) 4.8.1 |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 408 | |
Bram Moolenaar | 4f7e821 | 2014-11-05 13:53:32 +0100 | [diff] [blame] | 409 | C:\> mingw32-make --version |
| 410 | GNU Make 3.82.90 (...etc...) |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 411 | |
| 412 | Now you are ready to rock 'n' roll. Unpack the vim sources (look on |
| 413 | www.vim.org for exactly which version of the vim files you need). |
| 414 | |
| 415 | Change directory to 'vim\src': |
| 416 | |
| 417 | C:\> cd vim\src |
| 418 | C:\VIM\SRC> |
| 419 | |
| 420 | and you type: |
| 421 | |
Bram Moolenaar | 4f7e821 | 2014-11-05 13:53:32 +0100 | [diff] [blame] | 422 | mingw32-make -f Make_ming.mak gvim.exe |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 423 | |
| 424 | After churning for a while, you will end up with 'gvim.exe' in the 'vim\src' |
| 425 | directory. |
| 426 | |
| 427 | You should not need to do *any* editing of any files to get vim compiled this |
| 428 | way. If, for some reason, you want the console-mode-only version of vim (this |
Bram Moolenaar | 5e3dae8 | 2010-03-02 16:19:40 +0100 | [diff] [blame] | 429 | is NOT recommended on Win32, especially on '95/'98!!!), you can use: |
Bram Moolenaar | d8e21d3 | 2010-01-06 21:16:31 +0100 | [diff] [blame] | 430 | |
Bram Moolenaar | 4f7e821 | 2014-11-05 13:53:32 +0100 | [diff] [blame] | 431 | mingw32-make -f Make_ming.mak GUI=no vim.exe |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 432 | |
| 433 | If you are dismayed by how big the EXE is, I strongly recommend you get 'UPX' |
| 434 | (also free!) and compress the file (typical compression is 50%). UPX can be |
| 435 | found at |
| 436 | http://www.upx.org/ |
| 437 | |
Bram Moolenaar | 9185627 | 2012-02-29 16:56:39 +0100 | [diff] [blame] | 438 | As of 2011, UPX still does not support compressing 64-bit EXE's; if you have |
| 439 | built a 64-bit vim then an alternative to UPX is 'MPRESS'. MPRESS can be found |
| 440 | at: |
| 441 | http://www.matcode.com/mpress.htm |
| 442 | |
| 443 | |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 444 | ADDITION: NLS support with MinGW |
| 445 | |
| 446 | (by Eduardo F. Amatria <eferna1@platea.pntic.mec.es>) |
| 447 | |
| 448 | If you want National Language Support, read the file src/po/README_mingw.txt. |
| 449 | You need to uncomment lines in Make_ming.mak to have NLS defined. |
| 450 | |
| 451 | |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 452 | 4. Cygwin |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 453 | ========= |
| 454 | |
| 455 | Use Make_cyg.mak with Cygwin's GCC. See |
| 456 | http://users.skynet.be/antoine.mechelynck/vim/compile.htm |
| 457 | |
Bram Moolenaar | 4f7e821 | 2014-11-05 13:53:32 +0100 | [diff] [blame] | 458 | With Cygnus gcc you should use the Unix Makefile instead (you need to get the |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 459 | Unix archive then). Then you get a Cygwin application (feels like Vim is |
Bram Moolenaar | 48f80c2 | 2010-02-24 15:08:27 +0100 | [diff] [blame] | 460 | running on Unix), while with Make_cyg.mak you get a Windows application (like |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 461 | with the other makefiles). |
| 462 | |
| 463 | |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 464 | 5. Borland |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 465 | =========== |
| 466 | |
| 467 | Use Make_bc5.mak with Borland C++ 5.x. See |
| 468 | http://users.skynet.be/antoine.mechelynck/vim/compile.htm |
| 469 | |
| 470 | |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 471 | 6. Cross compiling for Win32 from a Linux machine |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 472 | ================================================= |
| 473 | |
| 474 | [Update of 1) needs to be verified] |
| 475 | |
| 476 | If you like, you can compile the 'mingw' Win32 version from the comfort of |
| 477 | your Linux (or other unix) box. To do this, you need to follow a few steps: |
| 478 | 1) Install the mingw32 cross-compiler. See |
Bram Moolenaar | d8e21d3 | 2010-01-06 21:16:31 +0100 | [diff] [blame] | 479 | http://www.mingw.org/wiki/LinuxCrossMinGW |
Bram Moolenaar | c9b4b05 | 2006-04-30 18:54:39 +0000 | [diff] [blame] | 480 | http://www.libsdl.org/extras/win32/cross/README.txt |
Bram Moolenaar | a7241f5 | 2008-06-24 20:39:31 +0000 | [diff] [blame] | 481 | 2) Get and unpack both the Unix sources and the extra archive |
Bram Moolenaar | 4f7e821 | 2014-11-05 13:53:32 +0100 | [diff] [blame] | 482 | 3) in 'Make_cyg_ming.mak', set 'CROSS' to 'yes' instead of 'no'. |
| 483 | Make further changes to 'Make_cyg_ming.mak' and 'Make_ming.mak' as you |
| 484 | wish. If your cross-compiler prefix differs from the predefined value, |
Bram Moolenaar | d8e21d3 | 2010-01-06 21:16:31 +0100 | [diff] [blame] | 485 | set 'CROSS_COMPILE' corresponding. |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 486 | 4) make -f Make_ming.mak gvim.exe |
| 487 | |
| 488 | Now you have created the Windows binary from your Linux box! Have fun... |
| 489 | |
| 490 | |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 491 | 7. Building with Python support |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 492 | =============================== |
| 493 | |
Bram Moolenaar | 97cc238 | 2012-10-03 21:46:54 +0200 | [diff] [blame] | 494 | For building with MSVC 2008 the "Windows Installer" from www.python.org |
| 495 | works fine. |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 496 | |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 497 | When building, you need to set the following variables at least: |
| 498 | |
| 499 | PYTHON: Where Python is installed. E.g. C:\Python27 |
| 500 | DYNAMIC_PYTHON: Whether dynamic linking is used. Usually, set to yes. |
| 501 | PYTHON_VER: Python version. E.g. 27 for Python 2.7.X. |
| 502 | |
| 503 | E.g. When using MSVC (as one line): |
| 504 | |
| 505 | nmake -f Make_mvc.mak |
| 506 | PYTHON=C:\Python27 DYNAMIC_PYTHON=yes PYTHON_VER=27 |
| 507 | |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 508 | When using MinGW and link with the official Python (as one line): |
| 509 | |
| 510 | mingw32-make -f Make_ming.mak |
| 511 | PYTHON=C:/Python27 DYNAMIC_PYTHON=yes PYTHON_VER=27 |
| 512 | |
| 513 | When using msys2 and link with Python2 bundled with msys2 (as one line): |
| 514 | |
| 515 | mingw32-make -f Make_ming.mak PYTHON=c:/msys64/mingw64 |
| 516 | PYTHON_HOME=c:/msys64/mingw64 |
| 517 | PYTHONINC=-Ic:/msys64/mingw64/include/python2.7 |
| 518 | DYNAMIC_PYTHON=yes |
| 519 | PYTHON_VER=27 |
| 520 | DYNAMIC_PYTHON_DLL=libpython2.7.dll |
| 521 | STATIC_STDCPLUS=yes |
| 522 | |
| 523 | (This is for 64-bit builds. For 32-bit builds, replace mingw64 with mingw32.) |
| 524 | (STATIC_STDCPLUS is optional. Set to yes if you don't want to require |
| 525 | libstdc++-6.dll.) |
| 526 | |
| 527 | |
Bram Moolenaar | 97cc238 | 2012-10-03 21:46:54 +0200 | [diff] [blame] | 528 | (rest written by Ron Aaron: <ronaharon@yahoo.com>) |
| 529 | |
| 530 | Building with the mingw32 compiler, and the ActiveState ActivePython: |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 531 | http://www.ActiveState.com/Products/ActivePython/ |
| 532 | |
| 533 | After installing the ActivePython, you will have to create a 'mingw32' |
| 534 | 'libpython20.a' to link with: |
Bram Moolenaar | 3c6f92e | 2016-01-02 20:26:36 +0100 | [diff] [blame] | 535 | cd $PYTHON/libs |
| 536 | pexports python20.dll > python20.def |
| 537 | dlltool -d python20.def -l libpython20.a |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 538 | |
| 539 | Once that is done, edit the 'Make_ming.mak' so the PYTHON variable points to |
| 540 | the root of the Python installation (C:\Python20, for example). If you are |
| 541 | cross-compiling on Linux with the mingw32 setup, you need to also convert all |
| 542 | the 'Include' files to *unix* line-endings. This bash command will do it |
| 543 | easily: |
Bram Moolenaar | 3c6f92e | 2016-01-02 20:26:36 +0100 | [diff] [blame] | 544 | for fil in *.h ; do vim -e -c 'set ff=unix|w|q' $fil |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 545 | |
| 546 | Now just do: |
Bram Moolenaar | 3c6f92e | 2016-01-02 20:26:36 +0100 | [diff] [blame] | 547 | make -f Make_ming.mak gvim.exe |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 548 | |
Bram Moolenaar | 3c6f92e | 2016-01-02 20:26:36 +0100 | [diff] [blame] | 549 | You will end up with a Python-enabled, Win32 version. Enjoy! |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 550 | |
| 551 | |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 552 | 8. Building with Python3 support |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 553 | ================================ |
| 554 | |
| 555 | For building with MSVC 2008 the "Windows Installer" from www.python.org |
Bram Moolenaar | 59eb016 | 2017-12-10 18:17:44 +0100 | [diff] [blame] | 556 | works fine. Python 3.6 is recommended. |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 557 | |
| 558 | When building, you need to set the following variables at least: |
| 559 | |
Bram Moolenaar | 59eb016 | 2017-12-10 18:17:44 +0100 | [diff] [blame] | 560 | PYTHON3: Where Python3 is installed. E.g. C:\Python36 |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 561 | DYNAMIC_PYTHON3: Whether dynamic linking is used. Usually, set to yes. |
Bram Moolenaar | 59eb016 | 2017-12-10 18:17:44 +0100 | [diff] [blame] | 562 | PYTHON3_VER: Python3 version. E.g. 36 for Python 3.6.X. |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 563 | |
| 564 | E.g. When using MSVC (as one line): |
| 565 | |
| 566 | nmake -f Make_mvc.mak |
Bram Moolenaar | 59eb016 | 2017-12-10 18:17:44 +0100 | [diff] [blame] | 567 | PYTHON3=C:\Python36 DYNAMIC_PYTHON3=yes PYTHON3_VER=36 |
| 568 | |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 569 | When using MinGW and link with the official Python3 (as one line): |
| 570 | |
| 571 | mingw32-make -f Make_ming.mak |
| 572 | PYTHON3=C:/Python36 DYNAMIC_PYTHON3=yes PYTHON3_VER=36 |
Bram Moolenaar | 59eb016 | 2017-12-10 18:17:44 +0100 | [diff] [blame] | 573 | |
| 574 | When using msys2 and link with Python3 bundled with msys2 (as one line): |
| 575 | |
| 576 | mingw32-make -f Make_ming.mak PYTHON3=c:/msys64/mingw64 |
| 577 | PYTHON3_HOME=c:/msys64/mingw64 |
| 578 | PYTHON3INC=-Ic:/msys64/mingw64/include/python3.6m |
| 579 | DYNAMIC_PYTHON3=yes |
| 580 | PYTHON3_VER=36 |
| 581 | DYNAMIC_PYTHON3_DLL=libpython3.6m.dll |
| 582 | STATIC_STDCPLUS=yes |
| 583 | |
| 584 | (This is for 64-bit builds. For 32-bit builds, replace mingw64 with mingw32.) |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 585 | (STATIC_STDCPLUS is optional. Set to yes if you don't want to require |
| 586 | libstdc++-6.dll.) |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 587 | |
| 588 | |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 589 | 9. Building with Racket or MzScheme support |
Bram Moolenaar | 4e640bd | 2016-01-16 16:20:38 +0100 | [diff] [blame] | 590 | ======================================== |
| 591 | |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 592 | 1) Building with Racket support (newest) |
Bram Moolenaar | 4e640bd | 2016-01-16 16:20:38 +0100 | [diff] [blame] | 593 | |
| 594 | MzScheme and PLT Scheme names have been rebranded as Racket. Vim with Racket |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 595 | support can be built with either MSVC or MinGW (or Cygwin). |
| 596 | Get it from https://download.racket-lang.org/ |
Bram Moolenaar | 4e640bd | 2016-01-16 16:20:38 +0100 | [diff] [blame] | 597 | |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 598 | Copy lib/libracket{version}.dll to your Windows system directory. The system |
| 599 | directory depends on your Windows bitness and Vim bitness: |
| 600 | 32-bit Vim on 32-bit Windows: C:\Windows\System32 |
| 601 | 32-bit Vim on 64-bit Windows: C:\Windows\SysWOW64 |
| 602 | 64-bit Vim on 64-bit Windows: C:\Windows\System32 |
| 603 | |
| 604 | For building you need to set the following variables: |
Bram Moolenaar | 4e640bd | 2016-01-16 16:20:38 +0100 | [diff] [blame] | 605 | |
| 606 | MZSCHEME: Where Racket is installed. |
| 607 | E.g. C:\Program Files (x86)\Racket |
| 608 | DYNAMIC_MZSCHEME: Whether dynamic linking is used. Usually, set to yes. |
Bram Moolenaar | f55e4c8 | 2017-08-01 20:44:53 +0200 | [diff] [blame] | 609 | MZSCHEME_VER: Racket DLL version which is used for the file name. |
Bram Moolenaar | 73f4439 | 2017-10-07 18:38:43 +0200 | [diff] [blame] | 610 | See below for a list of MZSCHEME_VER. |
Bram Moolenaar | f55e4c8 | 2017-08-01 20:44:53 +0200 | [diff] [blame] | 611 | The DLL can be found under the lib directory. E.g. |
| 612 | C:\Program Files (x86)\Racket\lib\libracket3m_XXXXXX.dll |
Bram Moolenaar | 4e640bd | 2016-01-16 16:20:38 +0100 | [diff] [blame] | 613 | MZSCHEME_COLLECTS: (Optional) Path of the collects directory used at |
| 614 | runtime. Default: $(MZSCHEME)\collects |
| 615 | User can override this with the PLTCOLLECTS environment |
| 616 | variable. |
| 617 | |
Bram Moolenaar | 73f4439 | 2017-10-07 18:38:43 +0200 | [diff] [blame] | 618 | List of MZSCHEME_VER (incomplete): |
| 619 | |
| 620 | Racket ver. | MZSCHEME_VER |
| 621 | ========================== |
| 622 | 6.3 | 3m_9z0ds0 |
| 623 | 6.6 | 3m_a0solc |
| 624 | 6.8 | 3m_a1zjsw |
| 625 | 6.10 | 3m_a36fs8 |
| 626 | |
| 627 | |
Bram Moolenaar | 4e640bd | 2016-01-16 16:20:38 +0100 | [diff] [blame] | 628 | E.g. When using MSVC (as one line): |
| 629 | |
| 630 | nmake -f Make_mvc.mak |
| 631 | MZSCHEME="C:\Program Files (x86)\Racket" DYNAMIC_MZSCHEME=yes |
| 632 | MZSCHEME_VER=3m_9z0ds0 |
| 633 | |
| 634 | Or when using MinGW (as one line): |
| 635 | |
| 636 | mingw32-make -f Make_ming.mak |
| 637 | MZSCHEME='C:/Program\ Files\ (x86)/Racket' DYNAMIC_MZSCHEME=yes |
| 638 | MZSCHEME_VER=3m_9z0ds0 |
| 639 | |
| 640 | Spaces should be escaped with '\'. |
| 641 | |
| 642 | |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 643 | 2) Building with MzScheme support (older) |
| 644 | |
| 645 | (written by Sergey Khorev <sergey.khorev@gmail.com>) |
| 646 | |
| 647 | Vim with MzScheme (http://www.plt-scheme.org/software/mzscheme) support can |
| 648 | be built with either MSVC, or MinGW, or Cygwin. Supported versions are 205 and |
| 649 | above (including 299 and 30x series). |
| 650 | |
| 651 | The MSVC build is quite straightforward. Simply invoke (in one line) |
| 652 | nmake -fMake_mvc.mak MZSCHEME=<Path-to-MzScheme> |
| 653 | [MZSCHEME_VER=<MzScheme-version>] [DYNAMIC_MZSCHEME=<yes or no>] |
| 654 | where <MzScheme-version> is the last seven characters from MzScheme dll name |
| 655 | (libmzschXXXXXXX.dll). |
| 656 | If DYNAMIC_MZSCHEME=yes, resulting executable will not depend on MzScheme |
| 657 | DLL's, but will load them in runtime on demand. |
| 658 | |
| 659 | Building dynamic MzScheme support on MinGW and Cygwin is similar. Take into |
| 660 | account that <Path-to-MzScheme> should contain slashes rather than backslashes |
| 661 | (e.g. d:/Develop/MzScheme) |
| 662 | |
| 663 | "Static" MzScheme support (Vim executable will depend on MzScheme DLLs |
| 664 | explicitly) on MinGW and Cygwin requires additional step. |
| 665 | |
| 666 | libmzschXXXXXXX.dll and libmzgcXXXXXXX.dll should be copied from |
| 667 | %WINDOWS%\System32 to other location (either build directory, some temporary |
| 668 | dir or even MzScheme home). |
| 669 | |
| 670 | Pass that path as MZSCHEME_DLLS parameter for Make. E.g., |
| 671 | make -f Make_cyg.mak MZSCHEME=d:/Develop/MzScheme MZSCHEME_VER=209_000 |
| 672 | MZSCHEME_DLLS=c:/Temp DYNAMIC_MZSCHEME=no |
| 673 | |
| 674 | After a successful build, these dlls can be freely removed, leaving them in |
| 675 | %WINDOWS%\System32 only. |
| 676 | |
| 677 | |
| 678 | |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 679 | 10. Building with Lua support |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 680 | ============================ |
| 681 | |
Bram Moolenaar | 4e640bd | 2016-01-16 16:20:38 +0100 | [diff] [blame] | 682 | Vim with Lua support can be built with either MSVC or MinGW (or maybe Cygwin). |
| 683 | You can use binaries from LuaBinaries: http://luabinaries.sourceforge.net/ |
| 684 | This also applies to when you get a Vim executable and don't build yourself, |
| 685 | do the part up to "Build". |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 686 | |
| 687 | 1) Download and install LuaBinaries |
Bram Moolenaar | 4e640bd | 2016-01-16 16:20:38 +0100 | [diff] [blame] | 688 | |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 689 | Go to the Download page of LuaBinaries: |
Bram Moolenaar | 4e640bd | 2016-01-16 16:20:38 +0100 | [diff] [blame] | 690 | http://luabinaries.sourceforge.net/download.html |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 691 | |
| 692 | Download lua-X.Y.Z_Win32_dllw4_lib.zip for x86 or |
Bram Moolenaar | 4e640bd | 2016-01-16 16:20:38 +0100 | [diff] [blame] | 693 | lua-X.Y.Z_Win64_dllw4_lib.zip for x64. You can use them both for MSVC and |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 694 | MinGW. |
| 695 | |
| 696 | Unpack it to a working directory. E.g. C:\projects\lua53. |
| 697 | Lua's header files will be installed under the include directory. |
| 698 | |
Bram Moolenaar | 4e640bd | 2016-01-16 16:20:38 +0100 | [diff] [blame] | 699 | Copy luaXY.dll to your Windows system directory. The system directory depends |
| 700 | on your Windows bitness and Vim bitness: |
| 701 | 32-bit Vim on 32-bit Windows: C:\Windows\System32 |
| 702 | 32-bit Vim on 64-bit Windows: C:\Windows\SysWOW64 |
| 703 | 64-bit Vim on 64-bit Windows: C:\Windows\System32 |
| 704 | |
| 705 | Or another option is copying luaXY.dll to the directory where gvim.exe |
| 706 | (or vim.exe) is. |
| 707 | |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 708 | |
| 709 | 2) Build |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 710 | |
Bram Moolenaar | 4e640bd | 2016-01-16 16:20:38 +0100 | [diff] [blame] | 711 | You need to set LUA, DYNAMIC_LUA and LUA_VER. |
| 712 | |
| 713 | LUA: Where Lua's header files are installed. E.g. C:\projects\lua53. |
| 714 | DYNAMIC_LUA: Whether dynamic linking is used. Set to yes. |
| 715 | LUA_VER: Lua version. E.g. 53 for Lua 5.3.X. |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 716 | |
| 717 | E.g. When using MSVC (as one line): |
| 718 | |
| 719 | nmake -f Make_mvc.mak |
| 720 | LUA=C:\projects\lua53 DYNAMIC_LUA=yes LUA_VER=53 |
| 721 | |
| 722 | Or when using MinGW (as one line): |
| 723 | |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 724 | mingw32-make -f Make_ming.mak |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 725 | LUA=C:/projects/lua53 DYNAMIC_LUA=yes LUA_VER=53 |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 726 | |
Bram Moolenaar | 4e640bd | 2016-01-16 16:20:38 +0100 | [diff] [blame] | 727 | |
| 728 | Or when using Cygwin (as one line) (untested): |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 729 | |
| 730 | make -f Make_cyg.mak |
| 731 | LUA=/cygdrive/c/projects/lua53 DYNAMIC_LUA=yes LUA_VER=53 |
| 732 | |
| 733 | |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 734 | 11. Building with Perl support |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 735 | ============================== |
| 736 | |
| 737 | Vim with Perl support can be built with either MSVC or MinGW (or Cygwin). |
| 738 | You can use binaries from ActiveState (ActivePerl) or Strawberry Perl. |
| 739 | |
| 740 | http://www.activestate.com/activeperl |
| 741 | http://strawberryperl.com/ |
| 742 | |
| 743 | When building, you need to set the following variables: |
| 744 | |
| 745 | PERL: Where perl is installed. E.g. C:\Perl, C:\Strawberry\perl |
| 746 | DYNAMIC_PERL: Whether dynamic linking is used. Usually, set to yes. |
| 747 | PERL_VER: Perl version. E.g. 522 for Perl 5.22.X. |
| 748 | |
| 749 | E.g. When using MSVC (as one line): |
| 750 | |
| 751 | nmake -f Make_mvc.mak |
| 752 | PERL=C:\Perl DYNAMIC_PERL=yes PERL_VER=522 |
| 753 | |
| 754 | Or when using MinGW (as one line): |
| 755 | |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 756 | mingw32-make -f Make_ming.mak |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 757 | PERL=C:/Perl DYNAMIC_PERL=yes PERL_VER=522 |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 758 | |
| 759 | |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 760 | 12. Building with Ruby support |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 761 | ============================== |
| 762 | |
| 763 | Vim with Ruby support can be built with either MSVC or MinGW (or Cygwin). |
| 764 | Ruby doesn't provide the official Windows binaries. The most widely used |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 765 | Windows binaries might be RubyInstaller. Currently Ruby 2.4 is recommended. |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 766 | |
| 767 | http://rubyinstaller.org/ |
| 768 | |
| 769 | If you use MinGW you can easily build with RubyInstaller, but if you use MSVC |
| 770 | you need some tricks described below. |
| 771 | (Another binary distribution is ActiveScriptRuby: |
| 772 | http://www.artonx.org/data/asr/) |
| 773 | |
| 774 | When building, you need to set the following variables at least: |
| 775 | |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 776 | RUBY: Where ruby is installed. E.g. C:\Ruby24 |
Bram Moolenaar | 6384c5d | 2016-09-06 22:06:35 +0200 | [diff] [blame] | 777 | DYNAMIC_RUBY: Whether dynamic linking is used. Usually, set to yes. |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 778 | RUBY_VER: Ruby version. E.g. 24 for Ruby 2.4.X. |
Bram Moolenaar | 6384c5d | 2016-09-06 22:06:35 +0200 | [diff] [blame] | 779 | RUBY_API_VER_LONG: Ruby API version in a long format. |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 780 | E.g. 2.4.0 for Ruby 2.4.X. |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 781 | |
| 782 | Ruby version vs. Ruby API version: |
| 783 | |
| 784 | Ruby ver. | Ruby API ver. |
| 785 | ========================= |
| 786 | 1.8.X | 1.8 |
| 787 | 1.9.[1-3] | 1.9.1 |
| 788 | 2.0.0 | 2.0.0 |
| 789 | 2.X.Y | 2.X.0 |
| 790 | |
| 791 | (Ruby 1.9.0 is excluded from the table because it is an unstable version.) |
| 792 | |
| 793 | |
| 794 | A) Using MSVC |
| 795 | |
| 796 | If you want to link with ruby, normally you must use the same compiler as |
| 797 | which was used to build the ruby binary. RubyInstaller is built with MinGW, |
| 798 | so normally you cannot use MSVC for building Vim if you want to link with |
Bram Moolenaar | 02cfac8 | 2016-04-21 14:34:58 +0200 | [diff] [blame] | 799 | RubyInstaller. If you use a different compiler, there are mainly two problems: |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 800 | config.h and Ruby's DLL name. Here are the steps for working around them: |
| 801 | |
| 802 | 1) Download and Install RubyInstaller. |
| 803 | You can install RubyInstaller with the default options and directory. |
| 804 | E.g.: |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 805 | C:\Ruby24 (32-bit) or C:\Ruby24-x64 (64-bit) |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 806 | |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 807 | Ruby 2.4.X is used in this example. |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 808 | |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 809 | 2) Download Ruby 2.4.X's source code and generate config.h: |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 810 | |
| 811 | cd C:\projects |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 812 | git clone https://github.com/ruby/ruby.git -b ruby_2_4 |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 813 | cd ruby |
| 814 | win32\configure.bat |
| 815 | nmake .config.h.time |
| 816 | |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 817 | Note that ruby_2_4 is the branch name for Ruby 2.4.X's source code. |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 818 | There is no need to build whole Ruby, just config.h is needed. |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 819 | If you use 32-bit MSVC 2015, the config.h is generated in the |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 820 | .ext\include\i386-mswin32_140 directory. |
Bram Moolenaar | 59eb016 | 2017-12-10 18:17:44 +0100 | [diff] [blame] | 821 | If you use 64-bit MSVC 2015, the config.h is generated in the |
| 822 | .ext\include\x64-mswin64_140 directory. |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 823 | |
| 824 | 3) Install the generated config.h. |
| 825 | |
Bram Moolenaar | 59eb016 | 2017-12-10 18:17:44 +0100 | [diff] [blame] | 826 | For 32-bit version: |
| 827 | |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 828 | xcopy /s .ext\include C:\Ruby24\include\ruby-2.4.0 |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 829 | |
Bram Moolenaar | 59eb016 | 2017-12-10 18:17:44 +0100 | [diff] [blame] | 830 | For 64-bit version: |
| 831 | |
| 832 | xcopy /s .ext\include C:\Ruby24-x64\include\ruby-2.4.0 |
| 833 | |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 834 | Note that 2.4.0 is Ruby API version of Ruby 2.4.X. |
| 835 | You may need to close the console and reopen it to pick up the new $PATH. |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 836 | |
| 837 | 4) Build Vim. Note that you need to adjust some variables (as one line): |
| 838 | |
Bram Moolenaar | 59eb016 | 2017-12-10 18:17:44 +0100 | [diff] [blame] | 839 | For 32-bit version: |
| 840 | |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 841 | nmake -f Make_mvc.mak |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 842 | RUBY=C:\Ruby24 DYNAMIC_RUBY=yes RUBY_VER=24 RUBY_API_VER_LONG=2.4.0 |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 843 | RUBY_MSVCRT_NAME=msvcrt |
Bram Moolenaar | 02cfac8 | 2016-04-21 14:34:58 +0200 | [diff] [blame] | 844 | WINVER=0x501 |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 845 | |
Bram Moolenaar | 59eb016 | 2017-12-10 18:17:44 +0100 | [diff] [blame] | 846 | For 64-bit version, replace RUBY=C:\Ruby24 with RUBY=C:\Ruby24-x64. |
| 847 | |
Bram Moolenaar | 02cfac8 | 2016-04-21 14:34:58 +0200 | [diff] [blame] | 848 | If you set WINVER explicitly, it must be set to >=0x500, when building |
| 849 | with Ruby 2.1 or later. (Default is 0x501.) |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 850 | When using this trick, you also need to set RUBY_MSVCRT_NAME to msvcrt |
| 851 | which is used for the Ruby's DLL name. |
| 852 | |
| 853 | B) Using MinGW |
| 854 | |
| 855 | Using MinGW is easier than using MSVC when linking with RubyInstaller. |
| 856 | After you install RubyInstaller, just type this (as one line): |
| 857 | |
| 858 | mingw32-make -f Make_ming.mak |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 859 | RUBY=C:/Ruby24 DYNAMIC_RUBY=yes RUBY_VER=24 RUBY_API_VER_LONG=2.4.0 |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 860 | WINVER=0x600 |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 861 | |
Bram Moolenaar | 59eb016 | 2017-12-10 18:17:44 +0100 | [diff] [blame] | 862 | For 64-bit version, replace RUBY=C:/Ruby24 with RUBY=C:/Ruby24-x64. |
Bram Moolenaar | 02cfac8 | 2016-04-21 14:34:58 +0200 | [diff] [blame] | 863 | If you set WINVER explicitly, it must be set to >=0x500, when building with |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 864 | Ruby 2.1 or later. (Default is 0x600.) |
Bram Moolenaar | 02cfac8 | 2016-04-21 14:34:58 +0200 | [diff] [blame] | 865 | |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 866 | |
| 867 | |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 868 | 13. Building with Tcl support |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 869 | ============================= |
| 870 | |
| 871 | Vim with Tcl support can be built with either MSVC or MinGW (or Cygwin). |
| 872 | You can use binaries from ActiveState (ActiveTcl). |
| 873 | |
| 874 | http://www.activestate.com/activetcl |
| 875 | |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 876 | Alternatively, you can use the binaries provided by IronTcl from |
| 877 | |
| 878 | https://www.irontcl.com/ |
| 879 | |
| 880 | They might lack behind the latest version a bit, but should provide 64bit |
| 881 | and 32bit versions even if ActiveTcl does not provide them anymore. |
| 882 | |
| 883 | For building with MSVC 2015 use version 8.6.6 or later. |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 884 | When building, you need to set the following variables: |
| 885 | |
| 886 | TCL: Where tcl is installed. E.g. C:\Tcl86 |
| 887 | DYNAMIC_TCL: Whether dynamic linking is used. Usually, set to yes. |
| 888 | TCL_VER: Tcl version in a short format. E.g. 86 for Tcl 8.6.X. |
| 889 | TCL_VER_LONG: Tcl version in a long format. E.g. 8.6 for Tcl 8.6.X. |
| 890 | |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 891 | Sometimes the Tcl dll name changes. E.g. ActiveTcl 8.6.4 comes with tcl86.dll, |
| 892 | but ActiveTcl 8.6.6 comes with tcl86t.dll. You can set the dll name by setting |
| 893 | the TCL_DLL variable: |
| 894 | TCL_DLL=tcl86t.dll |
| 895 | |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 896 | E.g. When using MSVC (as one line): |
| 897 | |
| 898 | nmake -f Make_mvc.mak |
| 899 | TCL=C:\Tcl86 DYNAMIC_TCL=yes TCL_VER=86 TCL_VER_LONG=8.6 |
| 900 | |
| 901 | Or when using MinGW (as one line): |
| 902 | |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 903 | mingw32-make -f Make_ming.mak |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 904 | TCL=C:/Tcl86 DYNAMIC_TCL=yes TCL_VER=86 TCL_VER_LONG=8.6 |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 905 | |
| 906 | |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 907 | 14. Building with Terminal support |
Bram Moolenaar | 8f84c3a | 2017-07-22 16:14:44 +0200 | [diff] [blame] | 908 | ================================== |
| 909 | |
Bram Moolenaar | 8a77306 | 2017-07-24 22:29:21 +0200 | [diff] [blame] | 910 | Vim with Terminal support can be built with either MSVC, MinGW or Cygwin. |
Bram Moolenaar | 2aeaf3f | 2017-07-23 17:11:15 +0200 | [diff] [blame] | 911 | This uses the included libvterm and winpty. No extra header files or |
Bram Moolenaar | 8a77306 | 2017-07-24 22:29:21 +0200 | [diff] [blame] | 912 | libraries are needed for building. Just set TERMINAL to yes. |
Bram Moolenaar | 2aeaf3f | 2017-07-23 17:11:15 +0200 | [diff] [blame] | 913 | |
Bram Moolenaar | 8a77306 | 2017-07-24 22:29:21 +0200 | [diff] [blame] | 914 | E.g. When using MSVC: |
Bram Moolenaar | 8f84c3a | 2017-07-22 16:14:44 +0200 | [diff] [blame] | 915 | |
Bram Moolenaar | 8a77306 | 2017-07-24 22:29:21 +0200 | [diff] [blame] | 916 | nmake -f Make_mvc.mak TERMINAL=yes |
Bram Moolenaar | 8f84c3a | 2017-07-22 16:14:44 +0200 | [diff] [blame] | 917 | |
Bram Moolenaar | 7f88b65 | 2017-12-14 13:15:19 +0100 | [diff] [blame] | 918 | Or when using MinGW: |
Bram Moolenaar | 8f84c3a | 2017-07-22 16:14:44 +0200 | [diff] [blame] | 919 | |
Bram Moolenaar | 18cfa94 | 2017-10-08 17:58:44 +0200 | [diff] [blame] | 920 | mingw32-make -f Make_ming.mak TERMINAL=yes |
Bram Moolenaar | 8f84c3a | 2017-07-22 16:14:44 +0200 | [diff] [blame] | 921 | |
| 922 | |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 923 | 15. Building with DirectX (DirectWrite) support |
Bram Moolenaar | 7f88b65 | 2017-12-14 13:15:19 +0100 | [diff] [blame] | 924 | =============================================== |
| 925 | |
| 926 | Vim with DirectX (DirectWrite) support can be built with either MSVC or MinGW. |
| 927 | This requires dwrite_2.h and some other header files which come with Windows |
| 928 | SDK 8.1 or later (or MinGW-w64), if you want to enable color emoji support. |
| 929 | This also requires MBYTE=yes which is enabled by default. |
| 930 | |
| 931 | A) Using MSVC |
| 932 | |
| 933 | If you use MSVC 2013 or later, Windows SDK 8.1 or later is used by default. |
| 934 | You just need to specify DIRECTX=yes: |
| 935 | |
| 936 | nmake -f Make_mvc.mak DIRECTX=yes |
| 937 | |
| 938 | If you use MSVC 2012 or earlier, the required header files are not available |
| 939 | by default. However, you can use the header files from newer SDKs with older |
| 940 | compilers. E.g.: |
| 941 | |
| 942 | set "INCLUDE=%INCLUDE%;C:\Program Files (x86)\Windows Kits\8.1\Include\um" |
| 943 | nmake -f Make_mvc.mak DIRECTX=yes |
| 944 | |
| 945 | If you don't need color emoji support, only dwrite.h is required. You can use |
| 946 | older compilers (e.g. VC2010) without Windows SDK 8.1. E.g.: |
| 947 | |
| 948 | nmake -f Make_mvc.mak DIRECTX=yes COLOR_EMOJI=no |
| 949 | |
| 950 | B) Using MinGW-w64 |
| 951 | |
| 952 | Just set DIRECTX to yes: |
| 953 | |
| 954 | mingw32-make -f Make_ming.mak DIRECTX=yes |
| 955 | |
| 956 | |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 957 | 16. Windows 3.1x |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 958 | ================ |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 959 | |
Bram Moolenaar | 6e722e2 | 2016-02-26 19:58:58 +0100 | [diff] [blame] | 960 | The Windows 3.1x support was removed in patch 7.4.1364. |
Bram Moolenaar | 362e1a3 | 2006-03-06 23:29:24 +0000 | [diff] [blame] | 961 | |
| 962 | |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 963 | 17. MS-DOS |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 964 | ========== |
Bram Moolenaar | 071d427 | 2004-06-13 20:20:40 +0000 | [diff] [blame] | 965 | |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 966 | The MS-DOS support was removed in patch 7.4.1399. Only very old Vim versions |
| 967 | work on MS-DOS because of the limited amount of memory available. |
Bram Moolenaar | 734d998 | 2011-07-15 13:52:04 +0200 | [diff] [blame] | 968 | |
| 969 | |
Bram Moolenaar | 304925e | 2018-06-30 16:27:02 +0200 | [diff] [blame] | 970 | 18. Installing after building from sources |
Bram Moolenaar | 734d998 | 2011-07-15 13:52:04 +0200 | [diff] [blame] | 971 | ========================================== |
| 972 | |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 973 | [provided by Michael Soyka, updated by Ken Takata] |
Bram Moolenaar | 734d998 | 2011-07-15 13:52:04 +0200 | [diff] [blame] | 974 | |
| 975 | After you've built the Vim binaries as described above, you're ready to |
| 976 | install Vim on your system. However, if you've obtained the Vim sources |
Bram Moolenaar | 30a8947 | 2016-01-10 14:35:58 +0100 | [diff] [blame] | 977 | using Git, Mercurial or by downloading them as a unix tar file, you must |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 978 | first create a "vim81" directory. If you instead downloaded the sources as |
Bram Moolenaar | 734d998 | 2011-07-15 13:52:04 +0200 | [diff] [blame] | 979 | zip files, you can skip this setup as the zip archives already have the |
Bram Moolenaar | 3c6f92e | 2016-01-02 20:26:36 +0100 | [diff] [blame] | 980 | correct directory structure. |
Bram Moolenaar | 734d998 | 2011-07-15 13:52:04 +0200 | [diff] [blame] | 981 | |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 982 | A. Create a Vim "runtime" subdirectory named "vim81" |
Bram Moolenaar | 734d998 | 2011-07-15 13:52:04 +0200 | [diff] [blame] | 983 | ----------------------------------------------------- |
Bram Moolenaar | 3c6f92e | 2016-01-02 20:26:36 +0100 | [diff] [blame] | 984 | If you obtained your Vim sources as zip files, you can skip this step. |
Bram Moolenaar | 734d998 | 2011-07-15 13:52:04 +0200 | [diff] [blame] | 985 | Otherwise, continue reading. |
| 986 | |
| 987 | Go to the directory that contains the Vim "src" and "runtime" |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 988 | directories and create a new subdirectory named "vim81". |
Bram Moolenaar | 3c6f92e | 2016-01-02 20:26:36 +0100 | [diff] [blame] | 989 | |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 990 | Copy the "runtime" files into "vim81": |
| 991 | copy runtime\* vim81 |
Bram Moolenaar | 734d998 | 2011-07-15 13:52:04 +0200 | [diff] [blame] | 992 | |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 993 | B. Copy the new binaries into the "vim81" directory |
Bram Moolenaar | 734d998 | 2011-07-15 13:52:04 +0200 | [diff] [blame] | 994 | ---------------------------------------------------- |
| 995 | Regardless of how you installed the Vim sources, you need to copy the |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 996 | new binaries you created above into "vim81": |
Bram Moolenaar | 734d998 | 2011-07-15 13:52:04 +0200 | [diff] [blame] | 997 | |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 998 | copy src\*.exe vim81 |
| 999 | copy src\tee\tee.exe vim81 |
| 1000 | copy src\xxd\xxd.exe vim81 |
Bram Moolenaar | 734d998 | 2011-07-15 13:52:04 +0200 | [diff] [blame] | 1001 | |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 1002 | To install the "Edit with Vim" popup menu, you need both 32-bit and 64-bit |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 1003 | versions of gvimext.dll. They should be copied to "vim81\GvimExt32" and |
| 1004 | "vim81\GvimExt64" respectively. |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 1005 | First, build the 32-bit version, then: |
| 1006 | |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 1007 | mkdir vim81\GvimExt32 |
| 1008 | copy src\GvimExt\gvimext.dll vim81\GvimExt32 |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 1009 | |
| 1010 | Next, clean the 32-bit version and build the 64-bit version, then: |
| 1011 | |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 1012 | mkdir vim81\GvimExt64 |
| 1013 | copy src\GvimExt\gvimext.dll vim81\GvimExt64 |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 1014 | |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 1015 | C. Copy gettext and iconv DLLs into the "vim81" directory |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 1016 | ---------------------------------------------------------- |
| 1017 | Get gettext and iconv DLLs from the following site: |
| 1018 | https://github.com/mlocati/gettext-iconv-windows/releases |
| 1019 | Both 64- and 32-bit versions are needed. |
| 1020 | Download the files gettextX.X.X.X-iconvX.XX-shared-{32,64}.zip, extract |
| 1021 | DLLs and place them as follows: |
| 1022 | |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 1023 | vim81\ |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 1024 | | libintl-8.dll |
| 1025 | | libiconv-2.dll |
| 1026 | | libgcc_s_sjlj-1.dll (only for 32-bit) |
| 1027 | | |
| 1028 | + GvimExt32\ |
| 1029 | | libintl-8.dll |
| 1030 | | libiconv-2.dll |
| 1031 | | libgcc_s_sjlj-1.dll |
| 1032 | | |
| 1033 | ` GvimExt64\ |
| 1034 | libintl-8.dll |
| 1035 | libiconv-2.dll |
| 1036 | |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 1037 | The DLLs in the "vim81" should be the same bitness with the (g)vim.exe. |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 1038 | |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 1039 | D. Move the "vim81" directory into the Vim installation subdirectory |
Bram Moolenaar | 734d998 | 2011-07-15 13:52:04 +0200 | [diff] [blame] | 1040 | --------------------------------------------------------------------- |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 1041 | Move the "vim81" subdirectory into the subdirectory where you want Vim |
Bram Moolenaar | 3c6f92e | 2016-01-02 20:26:36 +0100 | [diff] [blame] | 1042 | to be installed. Typically, this subdirectory will be named "vim". |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 1043 | If you already have a "vim81" subdirectory in "vim", delete it first |
Bram Moolenaar | 3c6f92e | 2016-01-02 20:26:36 +0100 | [diff] [blame] | 1044 | by running its uninstal.exe program. |
Bram Moolenaar | 734d998 | 2011-07-15 13:52:04 +0200 | [diff] [blame] | 1045 | |
Bram Moolenaar | 3bf8c3c | 2017-11-05 16:04:43 +0100 | [diff] [blame] | 1046 | E. Install Vim |
Bram Moolenaar | 734d998 | 2011-07-15 13:52:04 +0200 | [diff] [blame] | 1047 | --------------- |
Bram Moolenaar | ba7e186 | 2019-01-09 23:02:43 +0100 | [diff] [blame] | 1048 | "cd" to your Vim installation subdirectory "vim\vim81" and run the |
Bram Moolenaar | 734d998 | 2011-07-15 13:52:04 +0200 | [diff] [blame] | 1049 | "install.exe" program. It will ask you a number of questions about |
| 1050 | how you would like to have your Vim setup. Among these are: |
| 1051 | - You can tell it to write a "_vimrc" file with your preferences in the |
| 1052 | parent directory. |
| 1053 | - It can also install an "Edit with Vim" entry in the Windows Explorer |
| 1054 | popup menu. |
| 1055 | - You can have it create batch files, so that you can run Vim from the |
| 1056 | console or in a shell. You can select one of the directories in your |
Bram Moolenaar | 3c6f92e | 2016-01-02 20:26:36 +0100 | [diff] [blame] | 1057 | PATH or add the directory to PATH using the Windows Control Panel. |
Bram Moolenaar | 734d998 | 2011-07-15 13:52:04 +0200 | [diff] [blame] | 1058 | - Create entries for Vim on the desktop and in the Start menu. |
| 1059 | |
| 1060 | Happy Vimming! |