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