Do not use this recipe with Cygwin. For building on Cygwin,
use the normal installation instructions, ../INSTALL.
+ If you have a Cygwin or MSYS port of Bash on your Path, you will be
+ better off removing it from PATH. (For details, search for "MSYS
+ sh.exe" below.)
+
1. Change to the `nt' directory (the directory of this file):
cd nt
- 2. Run configure.bat. From the COMMAND.COM/CMD.EXE command prompt:
+ 2. Run configure.bat.
+
+ 2a.If you use MSVC, set up the build environment by running the
+ SetEnv.cmd batch file from the appropriate SDK directory. (Skip
+ this step if you are using MinGW.) For example:
+
+ "C:\Program Files\Microsoft SDKs\Windows\v7.1\Bin\SetEnv.cmd" /x86 /Debug
+
+ if you are going to compile a debug version, or
+
+ "C:\Program Files\Microsoft SDKs\Windows\v7.1\Bin\SetEnv.cmd" /x86 /Release
+
+ if you are going to compile an optimized version.
+
+ 2b.From the COMMAND.COM/CMD.EXE command prompt type:
configure
- from a Unixy shell prompt:
+ From a Unixy shell prompt:
cmd /c configure.bat
or
command.com /c configure.bat
3. Run the Make utility suitable for your environment. If you build
- with the Microsoft's Visual C compiler (but see notes about using
- VC++ 8.0 and later below):
+ with the Microsoft's Visual C compiler:
nmake
* Supported development environments
To compile Emacs, you will need either Microsoft Visual C++ 2.0, or
- later up to 7.0, and nmake, or a Windows port of GCC 2.95 or later
- with MinGW and W32 API support and a port of GNU Make. You can use
- the Cygwin ports of GCC, but Emacs requires the MinGW headers and
- libraries to build (latest versions of the Cygwin toolkit, at least
- since v1.3.3, include the MinGW headers and libraries as an integral
- part).
-
- Note that building Emacs with Visual Studio 2005 (VC++ 8.0) and
- later is not supported at this time, due to changes introduced by
- Microsoft into the libraries shipped with the compiler.
+ later and nmake, or a Windows port of GCC 2.95 or later with MinGW
+ and W32 API support and a port of GNU Make. You can use the Cygwin
+ ports of GCC, but Emacs requires the MinGW headers and libraries to
+ build (latest versions of the Cygwin toolkit, at least since v1.3.3,
+ include the MinGW headers and libraries as an integral part).
The rest of this file assumes you have a working development
- environment. If you just installed such an environment, try
+ environment. If you just installed such an environment, try
building a trivial C "Hello world" program, and see if it works. If
it doesn't work, resolve that problem first! If you use Microsoft
Visual Studio .NET 2003, don't forget to run the VCVARS32.BAT batch
file from the `Bin' subdirectory of the directory where you have
- installed VS.NET.
+ installed VS.NET. With other versions of MSVC, run the SetEnv.cmd
+ batch file from the `Bin' subdirectory of the directory where you
+ have the SDK installed.
If you use the MinGW port of GCC and GNU Make to build Emacs, there
are some compatibility issues wrt Make and the shell that is run by
for example). Also see the Trouble-shooting section below if you
decide to go ahead and use Cygwin make.
- In addition, using 4NT or TCC as your shell is known to fail the build
- process, at least since 4NT version 3.01. Use CMD.EXE, the default
- Windows shell, instead. MSYS sh.exe also appears to cause various
- problems. If you have MSYS installed, try "make SHELL=cmd.exe" to
- force the use of cmd.exe instead of sh.exe.
+ In addition, using 4NT or TCC as your shell is known to fail the
+ build process, at least since 4NT version 3.01. Use CMD.EXE, the
+ default Windows shell, instead. MSYS sh.exe also appears to cause
+ various problems, e.g., it is known to cause failures in commands
+ like "cmd /c FOO" in the Makefiles, because it thinks "/c" is a
+ Unix-style file name that needs conversion to the Windows format.
+ If you have MSYS installed, try "make SHELL=cmd.exe" to force the
+ use of cmd.exe instead of the MSYS sh.exe.
sh exists no sh
absolutely sure the produced binaries will never need to be run under
a debugger.
- Because of limitations of the stock Windows command shell, certain
- characters (quotes, backslashes and equal signs) can be problematic
- and should not be used in arguments to configure. That means that
- forward slashes must be used in paths passed to the compiler and
- linker via the --cflags and --ldflags options, and that it is
- currently not possible to pass a macro like -DFOO=BAR (though -DFOO
- is perfectly valid).
+ Because of limitations of the stock Windows command shells, special
+ care is needed to pass some characters in the arguments of the
+ --cflags and --ldflags options. Backslashes should not be used in
+ file names passed to the compiler and linker via these options. Use
+ forward slashes instead. If the arguments to these two options
+ include the `=' character, like when passing a -DFOO=bar preprocessor
+ option, the argument with the `=' character should be enclosed in
+ quotes, like this:
+
+ configure --cflags "-DFOO=bar"
+
+ Support for options that include the `=' character require "command
+ extensions" to be enabled. (They are enabled by default, but your
+ system administrator could have changed that. See "cmd /?" for
+ details.) If command extensions are disabled, a warning message might
+ be displayed informing you that "using parameters that include the =
+ character by enclosing them in quotes will not be supported."
+
+ You may also use the --cflags and --ldflags options to pass
+ additional parameters to the compiler and linker, respectively; they
+ are frequently used to pass -I and -L flags to specify supplementary
+ include and library directories. If a directory name includes
+ spaces, you will need to enclose it in quotes, as follows
+ -I"C:/Program Files/GnuTLS-2.10.1/include". Note that only the
+ directory name is enclosed in quotes, not the entire argument. Also
+ note that this functionality is only supported if command extensions
+ are available. If command extensions are disabled and you attempt to
+ use this functionality you may see the following warning message
+ "Error in --cflags argument: ... Backslashes and quotes cannot be
+ used with --cflags. Please use forward slashes for filenames and
+ paths (e.g. when passing directories to -I)."
N.B. It is normal to see a few error messages output while configure
is running, when gcc support is being tested. These cannot be
For PNG images, we recommend to use versions 1.4.x and later of
libpng, because previous versions had security issues. You can find
precompiled libraries and headers on the GTK download page for
- Windows (http://www.gtk.org/download-windows.html).
+ Windows (http://www.gtk.org/download/win32.php).
Versions 1.4.0 and later of libpng are binary incompatible with
earlier versions, so Emacs will only look for libpng libraries which
`dynamic-library-alist' and the value of `libpng-version', and
download compatible DLLs if needed.
+* Optional GnuTLS support
+
+ If configure.bat finds the gnutls/gnutls.h file in the include path,
+ Emacs is built with GnuTLS support by default; to avoid that you can
+ pass the argument --without-gnutls.
+
+ In order to support GnuTLS at runtime, a GnuTLS-enabled Emacs must
+ be able to find the relevant DLLs during startup; failure to do so
+ is not an error, but GnuTLS won't be available to the running
+ session.
+
+ You can get pre-built binaries (including any required DLL and the
+ gnutls.h file) and an installer at http://josefsson.org/gnutls4win/.
+
* Experimental SVG support
SVG support is currently experimental, and not built by default.