1 Building and Installing Emacs on MS-Windows
2 using the MSYS and MinGW tools
4 Copyright (C) 2013-2014 Free Software Foundation, Inc.
5 See the end of the file for license conditions.
7 The MSYS/MinGW build described here is supported on versions of
8 Windows starting with Windows 2000 and newer. Windows 9X are not
9 supported (but the Emacs binary produced by this build will run on
12 * For the brave (a.k.a. "impatient"):
14 For those who have a working MSYS/MinGW development environment and
15 are comfortable with running Posix configure scripts, here are the
16 concise instructions for configuring and building the native Windows
17 binary of Emacs with these tools.
19 Do not use this recipe with Cygwin. For building on Cygwin, use the
20 normal installation instructions, ../INSTALL.
22 0. Start the MSYS Bash window. Everything else below is done from
23 that window's Bash prompt.
25 0a. If you are building from the development trunk (as opposed to a
26 release tarball), produce the configure script, by typing from
27 the top-level Emacs source directory:
31 1. If you want to build Emacs outside of the source tree
32 (recommended), create the build directory and chdir there.
34 2. Invoke the configure script:
36 - If you are building outside the source tree:
38 /PATH/TO/EMACS/SOURCE/TREE/configure --prefix=PREFIX ...
40 - If you are building in-place, i.e. inside the source tree:
42 ./configure --prefix=PREFIX ...
44 It is always preferable to use --prefix to configure Emacs for
45 some specific location of its installed tree; the default
46 /usr/local is not suitable for Windows (see the detailed
47 instructions for the reasons). The prefix must be absolute.
49 You can pass other options to the configure script. Here's a
50 typical example (for an in-place debug build):
52 CPPFLAGS='-DGLYPH_DEBUG=1' CFLAGS='-O0 -g3' ./configure --prefix=/d/usr/emacs --enable-checking
54 3. After the configure script finishes, it should display the
55 resulting configuration. After that, type
59 Use "make -j N" if your MSYS Make supports parallel execution;
60 the build will take significantly less time in that case. Here N
61 is the number of simultaneous parallel jobs; use the number of
62 the cores on your system.
64 4. Install the produced binaries:
68 If you want the installation tree to go to a place that is
69 different from the one specified by --prefix, say
71 make install prefix=/where/ever/you/want
75 If these short instructions somehow fail, read the rest of this
78 * Installing MinGW and MSYS
80 Make sure you carefully read the following two sections in their
81 entirety and install/configure the various packages as instructed.
82 A correct installation makes all the rest almost trivial; a botched
83 installation will likely make you miserable for quite some time.
85 There are two alternative to installing MinGW + MSYS: using the GUI
86 installer, called mingw-get, provided by the MinGW project, or
87 manual installation. The next two sections describe each one of
90 ** Installing MinGW and MSYS using mingw-get
92 A nice installer, called mingw-get, is available for those who don't
93 like to mess with manual installations. You can download it from
96 https://sourceforge.net/projects/mingw/files/Installer/mingw-get/
98 (This installer only supports packages downloaded from the MinGW
99 site; for the rest you will still need the manual method.)
101 After installing mingw-get, invoke it to install the packages that
102 are already selected by default on the "Select Components" screen of
105 After that, use "mingw-get install PACKAGE" to install the following
109 . mingw-developer-toolkit
111 (We recommend that you refrain from installing the MSYS Texinfo
112 package, which is part of msys-base, because it might produce mixed
113 EOL format when installing Info files. Instead, install the MinGW
114 port of Texinfo, see the ezwinports URL below. To uninstall the
115 MSYS Texinfo, after installing it as part of msys-base, invoke the
116 command "mingw-get remove msys-texinfo".)
118 At this point, you should be ready to configure and build Emacs in
119 its basic configuration. Skip to the "Generating the configure
120 script" section for the build instructions. If you want to build it
121 with image support and other optional libraries, read about the
122 optional libraries near the end of this document, before you start
123 the build. Also, consider installing additional MinGW packages that
124 are required/recommended, especially if you are building from the
125 repository, as described in the next section.
127 ** Installing MinGW and MSYS manually
131 You will need to install the MinGW port of GCC and Binutils, and the
132 MinGW runtime and Windows API distributions, to compile Emacs. You
133 can find these on the MinGW download/Base page:
135 https://sourceforge.net/projects/mingw/files/MinGW/Base/
137 In general, install the latest stable versions of the following
138 MinGW packages from that page: gcc, binutils, mingw-rt, w32api. You
139 only need the 'bin' and the 'dll' tarballs of each of the above.
141 MinGW packages are distributed as .tar.lzma compressed archives. To
142 install the packages manually, we recommend to use the Windows port
143 of the 'bsdtar' program to unpack the tarballs. 'bsdtar' is
144 available as part of the 'libarchive' package from here:
146 http://sourceforge.net/projects/ezwinports/files/
148 The recommended place to install these packages is a single tree
149 starting from some directory on a drive other than the system drive
150 C:. A typical example would be D:\usr, with D:\usr\bin holding the
151 binaries and DLLs (should be added to your Path environment
152 variable), D:\usr\include holding the include files, D:\usr\lib
153 holding the static and import libraries, D:\usr\share holding docs,
154 message catalogs, and package-specific subdirectories, etc.
156 Having all the headers and libraries in a single place will greatly
157 reduce the number of -I and -L flags you will have to pass to the
158 configure script (see below), as these files will be right where the
159 compiler expects them.
161 We specifically do NOT recommend installing packages below
162 "C:\Program Files" or "C:\Program Files (x86)". These directories
163 are protected on versions of Windows from Vista and on, and you will
164 have difficulties updating and maintaining your installation later,
165 due to UAC elevation prompts, file virtualization, etc. You *have*
168 Additional MinGW packages are required/recommended, especially if
169 you are building from the repository:
171 . Texinfo (needed to produce the Info manuals when building from
172 bzr, and for "make install")
174 Available from http://sourceforge.net/projects/ezwinports/files/.
176 . gzip (needed to compress files during "make install")
178 Available from http://gnuwin32.sourceforge.net/packages/gzip.htm.
180 . pkg-config (needed for building with some optional libraries,
181 such as GnuTLS and libxml2)
183 Available from http://www.gtk.org/download/win32.php
185 Each package might list other packages as prerequisites on its
186 download page (under "Runtime requirements"); download those as
187 well. (Using the mingw-get installer will fetch those prerequisites
188 automatically for you.) A missing prerequisite will manifest itself
189 by the program failing to run and presenting a pop-up dialog that
190 states the missing or incompatible DLL; be sure to find and install
193 Once you think you have MinGW installed, test the installation by
194 building a trivial "hello, world!" program, and make sure that it
195 builds without any error messages and the binary works when run.
199 You will need a reasonably full MSYS installation. MSYS is an
200 environment needed to run the Posix configure scripts and the
201 resulting Makefile's, in order to produce native Windows binaries
202 using the MinGW compiler and runtime libraries. Here's the list of
203 MSYS packages that are required:
205 . All the packages from the MSYS Base distribution, listed here:
207 https://sourceforge.net/projects/mingw/files/MSYS/Base/
209 . Additional packages listed below, from the MSYS Extension
212 https://sourceforge.net/projects/mingw/files/MSYS/Extension/
220 These should only be needed if you intend to build development
221 versions of Emacs from the repository.
223 . Additional packages (needed only if building from the
224 repository): Automake and Autoconf. They are available from
227 http://sourceforge.net/projects/ezwinports/files/automake-1.11.6-msys-bin.zip/download
228 http://sourceforge.net/projects/ezwinports/files/autoconf-2.65-msys-bin.zip/download
230 MSYS packages are distributed as .tar.lzma compressed archives. To
231 install the packages manually, we recommend to use the Windows port
232 of the 'bsdtar' program, already mentioned above.
234 If/when you are confident in your MinGW/MSYS installation, and want
235 to speed up the builds, we recommend installing a pre-release
236 version of Make from here:
238 https://sourceforge.net/projects/mingwbuilds/files/external-binary-packages/
240 These are snapshot builds of many packages, but you only need
241 make.exe from there. The advantage of this make.exe is that it
242 supports parallel builds, so you can use "make -j N" to considerably
243 speed up your builds.
245 Several users reported that MSYS 1.0.18 causes Make to hang in
246 parallel builds. If you bump into this, we suggest to downgrade to
247 MSYS 1.0.17, which doesn't have that problem.
249 For each of these packages, install the 'bin' and 'dll' tarballs of
250 their latest stable releases. If there's an 'ext' tarball (e.g.,
251 msysCORE and Coreutils have it), download and install those as well.
253 Each package might list other packages as prerequisites on its
254 download page (under "Runtime requirements"); download those as
255 well. (Using the mingw-get installer will fetch those prerequisites
256 automatically for you.) A missing prerequisite will manifest itself
257 by the program failing to run and presenting a pop-up dialog that
258 states the missing or incompatible DLL; be sure to find and install
261 MSYS packages should be installed in a separate tree from MinGW.
262 For example, use D:\MSYS or D:\usr\MSYS as the top-level directory
263 from which you unpack all of the MSYS packages.
265 Do NOT add the MSYS bin directory to your Windows Path! Only the
266 MinGW bin directory should be on Path. When you install MSYS, it
267 creates a shortcut on your desktop that invokes the MSYS Bash shell
268 in a Command Prompt window; that shell is already set up so that the
269 MSYS bin directory is on PATH ahead of any other directory. Thus,
270 Bash will find MSYS executables first, which is exactly what you
273 At this point, you are ready to build Emacs in its basic
274 configuration. If you want to build it with image support and other
275 optional libraries, read about that near the end of this document.
277 * Generating the configure script
279 If you are building a release or pretest tarball, skip this section,
280 because the configure script is already present in the tarball.
282 To build a development snapshot from the Emacs repository,
283 you will first need to generate the configure script and a few other
284 auto-generated files.
286 To generate the configure script, type this at the MSYS Bash prompt
287 from the top-level directory of the Emacs tree:
291 If successful, this command should produce the following output:
294 Checking whether you have the necessary tools...
295 (Read INSTALL.REPO for more details on building Emacs)
297 Checking for autoconf (need at least version 2.65)...
299 Checking for automake (need at least version 1.11)...
301 Your system has the required tools, running autoreconf...
302 You can now run `./configure'.
304 * Configuring Emacs for MinGW:
306 Now it's time to run the configure script. You can do that either
307 from a separate build directory that is outside of the Emacs source
308 tree (recommended), or from inside the source tree. The former is
309 recommended because it allows you to have several different builds,
310 e.g., an optimized build and an unoptimized one, of the same
311 revision of the source tree; the source tree will be left in its
312 pristine state, without any build products.
314 You invoke the configure script like this:
316 /PATH/TO/EMACS/SOURCE/TREE/configure --prefix=PREFIX ...
318 or, if you are building in-place, i.e. inside the source tree:
320 ./configure --prefix=PREFIX ...
322 Here PREFIX is the place where you eventually want to install Emacs
323 once built, e.g. /d/usr. We recommend to always use --prefix when
324 building Emacs on Windows, because the default '/usr/local' is not
325 appropriate for Windows: it will be mapped by MSYS to something like
326 C:\MSYS\local, and it will defeat the purpose of PREFIX, which is to
327 install programs in a single coherent tree resembling Posix systems.
328 Such a single-tree installation makes sure all the other programs
329 and packages ported from GNU or Unix systems will work seamlessly
330 together. Where exactly is the root of that tree on your system is
331 something only you, the user who builds Emacs, can know, and the
332 Emacs build process cannot guess, because usually there's no
333 '/usr/local' directory on any drive on Windows systems.
335 Do NOT use Windows-style x:/foo/bar file names on the configure
336 script command line; use the MSYS-style /x/foo/bar instead. Using
337 Windows-style file names was reported to cause subtle and hard to
338 figure out problems during the build. This applies both to the
339 command switches, such as --prefix=, and to the absolute file name
340 of 'configure', if you are building outside of the source tree.
342 You can pass additional options to the configure script, for the
347 As explained in the help text, you may need to tell the script what
348 are the optional flags to invoke the compiler. This is needed if
349 some of your headers and libraries, e.g., those belonging to
350 optional image libraries, are installed in places where the compiler
351 normally doesn't look for them. (Remember that advice above to
352 avoid such situations? here's is where you will start paying for
353 disregarding that recommendation.) For example, if you have libpng
354 headers in C:\emacs\libs\libpng-1.2.37-lib\include and jpeg library
355 headers in C:\emacs\libs\jpeg-6b-4-lib\include, you will need to say
358 CPPFLAGS='-I/c/emacs/libs/libpng-1.2.37-lib/include -I/c/emacs/libs/jpeg-6b-4-lib/include' ./configure --prefix=PREFIX
360 which is quite a mouth-full, especially if you have more directories
361 to specify... Perhaps you may wish to revisit your installation
364 If you have a global site-lisp directory from previous Emacs
365 installation, and you want Emacs to continue using it, specify it
366 via the --enable-locallisppath switch to 'configure', like this:
368 ./configure --prefix=PREFIX --enable-locallisppath="/d/usr/share/emacs/VERSION/site-lisp:/d/wherever/site-lisp"
370 Use the normal MSYS /d/foo/bar style to specify directories by their
373 A few frequently used options are needed when you want to produce an
374 unoptimized binary with runtime checks enabled:
376 CPPFLAGS='-DGLYPH_DEBUG=1' CFLAGS='-O0 -g3' ./configure --prefix=PREFIX --enable-checking
378 Once invoked, the configure script will run for some time, and, if
379 successful, will eventually produce a summary of the configuration
382 Configured for `i686-pc-mingw32'.
384 Where should the build process find the source code? /path/to/emacs/sources
385 What compiler should emacs be built with? gcc -std=gnu99 -O0 -g3
386 Should Emacs use the GNU version of malloc? yes
387 Should Emacs use a relocating allocator for buffers? yes
388 Should Emacs use mmap(2) for buffer allocation? no
389 What window system should Emacs use? w32
390 What toolkit should Emacs use? none
391 Where do we find X Windows header files? NONE
392 Where do we find X Windows libraries? NONE
393 Does Emacs use -lXaw3d? no
394 Does Emacs use -lXpm? yes
395 Does Emacs use -ljpeg? yes
396 Does Emacs use -ltiff? yes
397 Does Emacs use a gif library? yes
398 Does Emacs use -lpng? yes
399 Does Emacs use -lrsvg-2? no
400 Does Emacs use imagemagick? no
401 Does Emacs use -lgpm? no
402 Does Emacs use -ldbus? no
403 Does Emacs use -lgconf? no
404 Does Emacs use GSettings? no
405 Does Emacs use -lselinux? no
406 Does Emacs use -lgnutls? yes
407 Does Emacs use -lxml2? yes
408 Does Emacs use -lfreetype? no
409 Does Emacs use -lm17n-flt? no
410 Does Emacs use -lotf? no
411 Does Emacs use -lxft? no
412 Does Emacs use toolkit scroll bars? yes
414 You are almost there, hang on.
416 If the output is significantly different, or if configure finishes
417 prematurely and displays some error message, you should examine the
418 configuration log in config.log and find the reason for the failure.
420 Once you succeeded in configuring Emacs, and just want to rebuild it
421 after updating your local repository from the main repository, you
422 don't need to re-run the configure script manually, unless you want
423 to change the configure-time options. Just typing "make" will
424 re-run configure if necessary with the exact same options you
425 specified originally, and then go on to invoking Make, described
430 This is simple: just type "make" and sit back, watching the fun.
432 If you installed a snapshot build of Make, the build will be much
433 faster if you type "make -j N" instead, where N is the number of
434 independent processing units on your machine. E.g., on a core i7
435 system try using N of 6 or even 8. (If this hangs, see the notes
436 above about downgrading to MSYS 1.0.17.)
438 When Make finishes, you can install the produced binaries:
442 or, if you want the installed tree to go in a place different from
443 the configured one, type
445 make install prefix=WHEREVER
447 Congrats! You have built and installed your own Emacs!
451 The following make targets may be used by users building the source
452 distribution, or users who have checked out of the repository after
453 an initial bootstrapping.
456 Builds Emacs from the available sources and pre-compiled lisp files.
459 Installs the built programs and the auxiliary files.
462 Removes object and executable files produced by the build process in
463 the current configuration. After "make clean", you can rebuild with
464 the same configuration using make. useful when you want to be sure
465 that all of the products are built from coherent sources.
468 In addition to the files removed by make clean, this also removes
469 Makefiles and other generated files to get back to the state of a
470 freshly unpacked source distribution. After make distclean, it is
471 necessary to run the configure script followed by "make", in order
474 The following targets are intended only for use with the repository
478 Removes all the auto-generated files and all the *.elc byte-compiled
479 files, and builds Emacs from scratch. Useful when some change in
480 basic Emacs functionality makes byte compilation of updated files
483 make maintainer-clean
484 Removes everything that can be recreated, including compiled Lisp
485 files, to get back to the state of a fresh repository tree. After make
486 maintainer-clean, it is necessary to run configure and "make" or
487 "make bootstrap" to rebuild. Occasionally it may be necessary to
488 run this target after an update.
490 * Optional image library support
492 In addition to its "native" image formats (pbm and xbm), Emacs can
493 handle other image types: xpm, tiff, gif, png, jpeg and experimental
496 To build Emacs with support for them, the corresponding headers must
497 be in the include path and libraries should be where the linker
498 looks for them, when the configure script is run. If needed, this
499 can be set up using the CPPFLAGS and CFLAGS variable specified on
500 the configure command line. The configure script will report
501 whether it was able to detect the headers and libraries. If the
502 results of this testing appear to be incorrect, please look for
503 details in the file config.log: it will show the failed test
504 programs and compiler error messages that should explain what is
505 wrong. (Usually, any such failures happen because some headers are
506 missing due to bad packaging of the image support libraries.)
508 Note that any file path passed to the compiler or linker must use
509 forward slashes, or double each backslash, as that is how Bash
512 If the configure script finds the necessary headers and libraries,
513 but they are for some reason incompatible, or if you want to omit
514 support for some image library that is installed on your system for
515 some other reason, use the --without-PACKAGE option to configure,
516 such as --without-gif to omit GIF, --without-tiff to omit TIFF, etc.
517 Passing the --help option to the configure script displays all of
518 the supported --without-PACKAGE options.
520 To use the external image support, the DLLs implementing the
521 functionality must be found when Emacs first needs them, either on the
522 PATH, or in the same directory as emacs.exe. Failure to find a
523 library is not an error; the associated image format will simply be
524 unavailable. Note that once Emacs has determined that a library can
525 not be found, there's no way to force it to try again, other than
526 restarting. See the variable `dynamic-library-alist' to configure the
527 expected names of the libraries.
529 Some image libraries have dependencies on one another, or on zlib.
530 For example, tiff support depends on the jpeg library. If you did not
531 compile the libraries yourself, you must make sure that any dependency
532 is in the PATH or otherwise accessible and that the binaries are
533 compatible (for example, that they were built with the same compiler).
535 For PNG images, we recommend to use versions 1.4.x and later of
536 libpng, because previous versions had security issues. You can find
537 precompiled libraries and headers on the GTK download page for
538 Windows (http://www.gtk.org/download/win32.php for 32-bit builds and
539 http://www.gtk.org/download/win64.php for 64-bit builds). The
540 ezwinports site, http://sourceforge.net/projects/ezwinports/files/
541 also offers PNG (as well as other image libraries), which are
544 Versions 1.4.0 and later of libpng are binary incompatible with
545 earlier versions, so Emacs will only look for libpng libraries which
546 are compatible with the version it was compiled against. That
547 version is given by the value of the Lisp variable `libpng-version';
548 e.g., 10403 means version 1.4.3. The variable `dynamic-library-alist'
549 is automatically set to name only those DLL names that are known to
550 be compatible with the version given by `libpng-version'. If PNG
551 support does not work for you even though you have the support DLL
552 installed, check the name of the installed DLL against
553 `dynamic-library-alist' and the value of `libpng-version', and
554 download compatible DLLs if needed.
556 For GIF images, we recommend to use versions 5.0.0 or later of
557 giflib, as it is much enhanced wrt previous versions. You can find
558 precompiled binaries and headers for giflib on the ezwinports site,
559 http://sourceforge.net/projects/ezwinports/files/.
561 Version 5.0.0 and later of giflib are binary incompatible with
562 previous versions (the signatures of several functions have
563 changed), so Emacs will only look for giflib libraries that are
564 compatible with the version it was compiled against. Similar to
565 libpng, that version is given by the value of the Lisp variable
566 `libgif-version'; e.g., 50005 means version 5.0.5. The variable
567 `dynamic-library-alist' is automatically set to name only those DLL
568 libraries that are known to be compatible with the version given by
571 For JPEG images, you will need libjpeg 6b or later, which will be
572 called libjpeg-N.dll, jpeg62.dll, libjpeg.dll, or jpeg.dll. You can
573 find these on the ezwinports site.
575 TIFF images require libTIFF 3.0 or later, which will be called
576 libtiffN.dll or libtiff-N.dll or libtiff.dll. These can be found on
579 Pre-built versions of librsvg and its dependencies can be found in
582 1. http://sourceforge.net/projects/ezwinports/files/
584 This site includes a minimal (as much as possible for librsvg)
585 build of the library and its dependencies; it is also more
586 up-to-date with the latest upstream versions. However, it
587 currently only offers 32-bit builds. For building Emacs, you
588 need to download from this site all of the following *-bin.zip
591 librsvg, gdk-pixbuf, cairo, glib
593 The 'bin' archives on this site include both header files and the
594 libraries needed for building with librsvg and for running Emacs.
595 The librsvg archive includes all the shared libraries needed to
596 run Emacs with SVG support; the other 3 packages are required
597 because the compiler needs to see their header files when
600 2. GTK project download site for Windows (see above for 2 URLs,
601 either for 32-bit builds or 64-bit builds)
603 This is the official Windows download site of the GTK project.
604 Its builds of librsvg are fatter, but are currently the only
605 alternative for 64-bit builds. The easiest way to obtain the
606 dependencies required for building from this site is to download
607 a pre-bundled GTK+ development environment for Windows. If you
608 would nevertheless like to download only the packages that are
609 strictly required, then, as of the time of this writing, here's
610 the list of GTK+ packages you will need:
612 librsvg, pango, freetype-2.4.11, freetype-2.4.2, croco, cairo,
613 glib, gdk-pixbuf, fontconfig, libpng-1.4.x, libpng-1.5.x,
614 libffi, libxml2, zlib
616 The GTK download page provides 2 separate archives for each
617 package: a 'bin' (binary) archive with programs and DLLs, and a
618 'dev' (development) archive with header files, import libraries,
619 and pkg-config files; download and install both archives for each
620 package you need. (Sources of each package are available in a
621 separate, 3rd archive.)
623 As you see, some libraries for using this site's librsvg are
624 needed in more than one version -- this is because librsvg and
625 some of its dependencies were linked against different versions
626 of those libraries, and will look only for those DLLs when you
627 invoke SVG function. So there's a bit of "DLL hell" involved
628 here, but at least in theory this should work, as each library
629 will dynamically link only against its dependencies, even if
630 another version of the same library is already loaded. In
631 particular, at least 2 different versions of libpng will have to
632 be installed on your machine. When you install these libpng
633 versions, be sure to keep the header files and the pkg-config
634 files in sync, i.e. install both the 'bin' and 'dev' archives of
635 the same libpng version together.
637 To use librsvg at runtime, ensure that librsvg and its dependencies
638 are on your PATH, or in the same directory as the emacs.exe binary.
639 If you are downloading from the ezwinports site, you only need to
640 install a single archive, librsvg-X.Y.Z-w32-bin.zip, which includes
641 all the dependency DLLs. For the GTK project site, download the
642 'bin' archives for each of the libraries mentioned above.
644 If you think you've got all the dependencies and SVG support is
645 still not working, check your PATH for other libraries that shadow
646 the ones you downloaded. Libraries of the same name from different
647 sources may not be compatible, this problem was encountered in the
648 past, e.g., with libcroco from gnome.org.
650 If you can see etc/images/splash.svg, then you have managed to get
651 SVG support working. Congratulations for making it through DLL hell
652 to this point. For some SVG images, you'll probably see error
653 messages from Glib about failed assertions, or warnings from Pango
654 about failure to load fonts (installing the missing fonts should fix
655 the latter kind of problems). Problems have been observed in some
656 images that contain text, they seem to be a problem in the Windows
657 port of Pango, or maybe a problem with the way Cairo or librsvg is
658 using it that doesn't show up on other platforms. However, Emacs
659 should not crash due to these issues. If you eventually find the
660 SVG support too unstable to your taste, you can rebuild Emacs
661 without it by specifying the --without-rsvg switch to the configure
664 Binaries for the other image libraries can be found on the
665 ezwinports site or at the GnuWin32 project (the latter are generally
666 very old, so not recommended). Note specifically that, due to some
667 packaging snafus in the GnuWin32-supplied image libraries, you will
668 need to download _source_ packages for some of the libraries in
669 order to get the header files necessary for building Emacs with
672 * Optional GnuTLS support
674 To compile with GnuTLS, you will need pkg-config to be installed, as
675 the configure script invokes pkg-config to find out which compiler
676 switches to use for GnuTLS. See above for the URL where you can
677 find pkg-config for Windows.
679 You will also need to install the p11-kit package, which is a
680 dependency of GnuTLS, and its header files are needed for
681 compilation of programs that use GnuTLS. You can find p11-kit on
682 the same site as GnuTLS, see the URL below.
684 If the configure script finds the GnuTLS header files and libraries
685 on your system, Emacs is built with GnuTLS support by default; to
686 avoid that you can pass the argument --without-gnutls.
688 In order to support GnuTLS at runtime, a GnuTLS-enabled Emacs must
689 be able to find the relevant DLLs during startup; failure to do so
690 is not an error, but GnuTLS won't be available to the running
693 You can get pre-built binaries (including any required DLL and the
694 header files) at http://sourceforge.net/projects/ezwinports/files/.
696 * Optional libxml2 support
698 To compile with libxml2, you will need pkg-config to be installed,
699 as the configure script invokes pkg-config to find out which
700 compiler switches to use for libxml2. See above for the URL where
701 you can find pkg-config for Windows.
703 If the configure script finds the libxml2 header files and libraries
704 on your system, Emacs is built with libxml2 support by default; to
705 avoid that you can pass the argument --without-libxml2.
707 In order to support libxml2 at runtime, a libxml2-enabled Emacs must
708 be able to find the relevant DLLs during startup; failure to do so
709 is not an error, but libxml2 features won't be available to the
712 One place where you can get pre-built Windows binaries of libxml2
713 (including any required DLL and the header files) is here:
715 http://sourceforge.net/projects/ezwinports/files/
717 For runtime support of libxml2, you will also need to install the
718 libiconv "development" tarball, because the libiconv headers need to
719 be available to the compiler when you compile with libxml2 support.
720 A MinGW port of libiconv can be found on the MinGW site:
722 http://sourceforge.net/projects/mingw/files/MinGW/Base/libiconv/
724 You need the libiconv-X.Y.Z-N-mingw32-dev.tar.lzma tarball from that
727 * Experimental SVG support
729 To compile with SVG, you will need pkg-config to be installed, as
730 the configure script invokes pkg-config to find out which compiler
731 switches to use for SVG. See above for the URL where you can find
732 pkg-config for Windows.
734 SVG support is currently experimental, and not built by default.
735 Specify --with-rsvg and ensure you have all the dependencies in your
736 include path. Unless you have built a minimalist librsvg yourself
737 (untested), librsvg depends on a significant chunk of GTK+ to build,
738 plus a few Gnome libraries, libxml2, libbz2 and zlib at runtime. The
739 easiest way to obtain the dependencies required for building is to
740 download a pre-bundled GTK+ development environment for Windows.
742 To use librsvg at runtime, ensure that librsvg and its dependencies
743 are on your PATH. If you didn't build librsvg yourself, you will
744 need to check with where you downloaded it from for the
745 dependencies, as there are different build options. If it is a
746 short list, then it most likely only lists the immediate
747 dependencies of librsvg, but the dependencies themselves have
748 dependencies - so don't download individual libraries from GTK+,
749 download and install the whole thing. If you think you've got all
750 the dependencies and SVG support is still not working, check your
751 PATH for other libraries that shadow the ones you downloaded.
752 Libraries of the same name from different sources may not be
753 compatible, this problem was encountered with libbzip2 from GnuWin32
754 with libcroco from gnome.org.
756 If you can see etc/images/splash.svg, then you have managed to get
757 SVG support working. Congratulations for making it through DLL hell
758 to this point. You'll probably find that some SVG images crash
759 Emacs. Problems have been observed in some images that contain
760 text, they seem to be a problem in the Windows port of Pango, or
761 maybe a problem with the way Cairo or librsvg is using it that
762 doesn't show up on other platforms.
765 This file is part of GNU Emacs.
767 GNU Emacs is free software: you can redistribute it and/or modify
768 it under the terms of the GNU General Public License as published by
769 the Free Software Foundation, either version 3 of the License, or
770 (at your option) any later version.
772 GNU Emacs is distributed in the hope that it will be useful,
773 but WITHOUT ANY WARRANTY; without even the implied warranty of
774 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
775 GNU General Public License for more details.
777 You should have received a copy of the GNU General Public License
778 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.