BUILD.WINDOWS.txt 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130
  1. Building with Visual C++, prerequisites
  2. =======================================
  3. This document describes how to compile, build and install curl and libcurl
  4. from sources using the Visual C++ build tool. To build with VC++, you will
  5. of course have to first install VC++. The minimum required version of
  6. VC is 6 (part of Visual Studio 6). However using a more recent version is
  7. strongly recommended.
  8. VC++ is also part of the Windows Platform SDK. You do not have to install
  9. the full Visual Studio or Visual C++ if all you want is to build curl.
  10. The latest Platform SDK can be downloaded freely from:
  11. https://developer.microsoft.com/en-us/windows/downloads/sdk-archive
  12. If you are building with VC6 then you will also need the February 2003
  13. Edition of the Platform SDK which can be downloaded from:
  14. https://www.microsoft.com/en-us/download/details.aspx?id=12261
  15. If you wish to support zlib, openssl, c-ares, ssh2, you will have to download
  16. them separately and copy them to the deps directory as shown below:
  17. somedirectory\
  18. |_curl-src
  19. | |_winbuild
  20. |
  21. |_deps
  22. |_ lib
  23. |_ include
  24. |_ bin
  25. It is also possible to create the deps directory in some other random
  26. places and tell the Makefile its location using the WITH_DEVEL option.
  27. Building straight from git
  28. ==========================
  29. When you check out code git and build it, as opposed from a released source
  30. code archive, you need to first run the "buildconf.bat" batch file (present
  31. in the source code root directory) to set things up.
  32. Building with Visual C++
  33. ========================
  34. Open a Visual Studio Command prompt:
  35. Using the 'Developer Command Prompt for VS <version>' menu entry:
  36. where version is the Visual Studio version. The developer prompt at default
  37. uses the x86 mode. It is required to call Vcvarsall.bat to setup the prompt
  38. for the machine type you want, using Vcvarsall.bat.
  39. This type of command prompt may not exist in all Visual Studio versions.
  40. For more information, check:
  41. https://docs.microsoft.com/en-us/dotnet/framework/tools/developer-command-prompt-for-vs
  42. https://docs.microsoft.com/en-us/cpp/build/how-to-enable-a-64-bit-visual-cpp-toolset-on-the-command-line
  43. Using the 'VS <version> <platform> <type> Command Prompt' menu entry:
  44. where version is the Visual Studio version, platform is e.g. x64
  45. and type Native of Cross platform build. This type of command prompt
  46. may not exist in all Visual Studio versions.
  47. See also:
  48. https://msdn.microsoft.com/en-us/library/f2ccy3wt.aspx
  49. Once you are in the console, go to the winbuild directory in the Curl
  50. sources:
  51. cd curl-src\winbuild
  52. Then you can call nmake /f Makefile.vc with the desired options (see below).
  53. The builds will be in the top src directory, builds\ directory, in
  54. a directory named using the options given to the nmake call.
  55. nmake /f Makefile.vc mode=<static or dll> <options>
  56. where <options> is one or many of:
  57. VC=<6,7,8,9,10,11,12,14,15> - VC versions
  58. WITH_DEVEL=<path> - Paths for the development files (SSL, zlib, etc.)
  59. Defaults to sibbling directory deps: ../deps
  60. Libraries can be fetched at https://windows.php.net/downloads/php-sdk/deps/
  61. Uncompress them into the deps folder.
  62. WITH_SSL=<dll or static> - Enable OpenSSL support, DLL or static
  63. WITH_NGHTTP2=<dll or static> - Enable HTTP/2 support, DLL or static
  64. WITH_MBEDTLS=<dll or static> - Enable mbedTLS support, DLL or static
  65. WITH_CARES=<dll or static> - Enable c-ares support, DLL or static
  66. WITH_ZLIB=<dll or static> - Enable zlib support, DLL or static
  67. WITH_SSH2=<dll or static> - Enable libSSH2 support, DLL or static
  68. WITH_PREFIX=<dir> - Where to install the build
  69. ENABLE_SSPI=<yes or no> - Enable SSPI support, defaults to yes
  70. ENABLE_IPV6=<yes or no> - Enable IPv6, defaults to yes
  71. ENABLE_IDN=<yes or no> - Enable use of Windows IDN APIs, defaults to yes
  72. Requires Windows Vista or later
  73. ENABLE_WINSSL=<yes or no> - Enable native Windows SSL support, defaults to yes
  74. GEN_PDB=<yes or no> - Generate Program Database (debug symbols for release build)
  75. DEBUG=<yes or no> - Debug builds
  76. MACHINE=<x86 or x64> - Target architecture (default is x86)
  77. CARES_PATH=<path to cares> - Custom path for c-ares
  78. MBEDTLS_PATH=<path to mbedTLS> - Custom path for mbedTLS
  79. NGHTTP2_PATH=<path to HTTP/2> - Custom path for nghttp2
  80. SSH2_PATH=<path to libSSH2> - Custom path for libSSH2
  81. SSL_PATH=<path to OpenSSL> - Custom path for OpenSSL
  82. ZLIB_PATH=<path to zlib> - Custom path for zlib
  83. Static linking of Microsoft's C RunTime (CRT):
  84. ==============================================
  85. If you are using mode=static nmake will create and link to the static build of
  86. libcurl but *not* the static CRT. If you must you can force nmake to link in
  87. the static CRT by passing RTLIBCFG=static. Typically you shouldn't use that
  88. option, and nmake will default to the DLL CRT. RTLIBCFG is rarely used and
  89. therefore rarely tested. When passing RTLIBCFG for a configuration that was
  90. already built but not with that option, or if the option was specified
  91. differently, you must destroy the build directory containing the configuration
  92. so that nmake can build it from scratch.
  93. Building your own application with a static libcurl
  94. ===================================================
  95. When building an application that uses the static libcurl library on Windows,
  96. you must define CURL_STATICLIB. Otherwise the linker will look for dynamic
  97. import symbols.
  98. Legacy Windows and SSL
  99. ======================
  100. When you build curl using the build files in this directory the default SSL
  101. backend will be WinSSL (Windows SSPI, more specifically Schannel), the native
  102. SSL library that comes with the Windows OS. WinSSL in Windows <= XP is not able
  103. to connect to servers that no longer support the legacy handshakes and
  104. algorithms used by those versions. If you will be using curl in one of those
  105. earlier versions of Windows you should choose another SSL backend like OpenSSL.