1 Building and Installing Emacs on MS-Windows
2 using the MSYS and MinGW tools
4 Copyright (C) 2013-2018 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 XP and newer. Building on Windows 2000
9 and Windows 9X is not supported (but the Emacs binary produced by this
10 build will run on Windows 9X and newer systems).
12 Do not use this recipe with Cygwin. For building on Cygwin, use the
13 normal installation instructions, ../INSTALL.
15 For building Emacs using the MinGW64/MSYS2 toolchain, see the
16 instructions in the file INSTALL.W64 in this directory.
18 * For the brave (a.k.a. "impatient"):
20 For those who have a working MSYS/MinGW development environment and
21 are comfortable with running Posix configure scripts, here are the
22 concise instructions for configuring and building the native Windows
23 binary of Emacs with these tools:
25 0. Start the MSYS Bash window. Everything else below is done from
26 that window's Bash prompt.
28 0a. If you are building from the development trunk (as opposed to a
29 release tarball), produce the configure script, by typing from
30 the top-level Emacs source directory:
34 1. If you want to build Emacs outside of the source tree
35 (recommended), create the build directory and chdir there.
37 2. Invoke the configure script:
39 - If you are building outside the source tree:
41 /PATH/TO/EMACS/SOURCE/TREE/configure --prefix=PREFIX ...
43 - If you are building in-place, i.e. inside the source tree:
45 ./configure --prefix=PREFIX ...
47 It is always preferable to use --prefix to configure Emacs for
48 some specific location of its installed tree; the default
49 /usr/local is not suitable for Windows (see the detailed
50 instructions for the reasons). The prefix must be absolute.
52 You can pass other options to the configure script. Here's a
53 typical example (for an in-place debug build):
55 CFLAGS='-O0 -g3' ./configure --prefix=/d/usr/emacs --enable-checking='yes,glyphs'
57 3. After the configure script finishes, it should display the
58 resulting configuration. After that, type
62 Use "make -j N" if your MSYS Make supports parallel execution;
63 the build will take significantly less time in that case. Here N
64 is the number of simultaneous parallel jobs; use the number of
65 the cores on your system.
67 4. Install the produced binaries:
71 If you want the installation tree to go to a place that is
72 different from the one specified by --prefix, say
74 make install prefix=/where/ever/you/want
78 If these short instructions somehow fail, read the rest of this
81 * Installing Git for Windows
83 Skip this section if you already have Git installed and configured,
84 or if you are building from the release tarball, not from the
85 development repository.
87 Git for Windows is available from this download page:
89 https://github.com/git-for-windows/git/releases
91 That page offers both 32-bit and 64-bit installations; pick the one
92 suitable for your OS. In general, we recommend to install a 64-bit
93 Git if you have a 64-bit Windows system; the 32-bit Git will run on
94 64-bit Windows just fine, but might run into memory problems where
97 During Git installation, be sure to select the "Checkout as-is,
98 commit as-is" option from the "Configure line ending conversions"
99 dialog. Otherwise, Git will convert text files to DOS-style CRLF
100 end-of-line (EOL) format, which will cause subtle problems when
101 building Emacs, because MSYS tools (see below) used to build Emacs
102 use binary file I/O that preserves the CR characters that get in the
103 way of some text-processing tools, like 'makeinfo' and the commands
104 invoked by the autogen.sh script.
106 If you already have Git installed and configured with some other EOL
107 conversion option, you will need to reconfigure it, removing the
108 following variables from all of your .gitconfig files:
114 If you cloned the Emacs directory before changing these config
115 variables, you will have to delete the repository and re-clone it
118 The instructions for cloning the Emacs repository can be found on
119 the Emacs's Savannah project page:
121 https://savannah.gnu.org/projects/emacs
123 * Installing MinGW and MSYS
125 Make sure you carefully read the following two sections in their
126 entirety and install/configure the various packages as instructed.
127 A correct installation makes all the rest almost trivial; a botched
128 installation will likely make you miserable for quite some time.
130 There are two alternatives to installing MinGW + MSYS: using the GUI
131 installer, called mingw-get, provided by the MinGW project, or
132 manual installation. The next two sections describe each one of
135 ** Installing MinGW and MSYS using mingw-get
137 A nice installer, called mingw-get, is available for those who don't
138 like to mess with manual installations. You can download it from
141 https://sourceforge.net/projects/mingw/files/Installer/mingw-get/
143 (This installer only supports packages downloaded from the MinGW
144 site; for the rest you will still need the manual method.)
146 After installing mingw-get, invoke it to install the packages that
147 are already selected by default on the "Select Components" screen of
150 After that, use "mingw-get install PACKAGE" to install the following
154 . mingw-developer-toolkit
156 When the installation ends, perform the post-installation steps
157 described on this page of the MinGW site:
159 http://www.mingw.org/wiki/Getting_Started
161 in the "After Installing You Should ..." section. These steps are
162 important for making your installation complete, and in particular
163 will produce a desktop shortcut for running the MSYS Bash shell,
164 from which you will configure and build Emacs. Once you've made the
165 shortcut, double-click on it to open the MSYS Bash shell window,
166 where you will proceed with the rest of these instructions.
168 In addition, we suggest to modify your system-wide Path variable to
169 include the 'bin' subdirectory of your top-level MinGW installation
170 directory, the one you specified to mingw-get ("C:\MinGW" by
171 default). This will allow you to invoke the MinGW development
172 tools, like GCC, from the Windows cmd.exe shell windows or from
173 other Windows programs (including Emacs, after you build and install
176 (We recommend that you refrain from installing the MSYS Texinfo
177 package, which is part of msys-base, because it might produce mixed
178 EOL format when installing Info files. Instead, install the MinGW
179 port of Texinfo, see the ezwinports URL below. To uninstall the
180 MSYS Texinfo, after installing it as part of msys-base, invoke the
181 command "mingw-get remove msys-texinfo", or mark "msys-texinfo" for
182 removal in the mingw-get GUI, then select Installation->Apply Changes.)
184 (Similarly, we recommend to refrain from installing the MinGW
185 Autoconf package; instead, install its MSYS build available from the
186 ezwinports site, see below.)
188 At this point, you should be ready to configure and build Emacs in
189 its basic configuration. Skip to the "Generating the configure
190 script" section for the build instructions. If you want to build it
191 with image support and other optional libraries, read about the
192 optional libraries near the end of this document, before you start
193 the build. Also, consider installing additional MinGW packages that
194 are required/recommended, especially if you are building from the
195 development repository, as described in the next section.
197 ** Installing MinGW and MSYS manually
201 You will need to install the MinGW port of GCC and Binutils, and the
202 MinGW runtime and Windows API distributions, to compile Emacs. You
203 can find these on the MinGW download/Base page:
205 https://sourceforge.net/projects/mingw/files/MinGW/Base/
207 In general, install the latest stable versions of the following
208 MinGW packages from that page: gcc, binutils, mingw-rt, w32api. You
209 only need the 'bin' and the 'dll' tarballs of each of the above.
211 MinGW packages are distributed as .tar.lzma compressed archives. To
212 install the packages manually, we recommend to use the Windows port
213 of the 'bsdtar' program to unpack the tarballs. 'bsdtar' is
214 available as part of the 'libarchive' package from here:
216 http://sourceforge.net/projects/ezwinports/files/
218 The recommended place to install these packages is a single tree
219 starting from some directory on a drive other than the system drive
220 C:. A typical example would be D:\usr, with D:\usr\bin holding the
221 binaries and DLLs (should be added to your Path environment
222 variable), D:\usr\include holding the include files, D:\usr\lib
223 holding the static and import libraries, D:\usr\share holding docs,
224 message catalogs, and package-specific subdirectories, etc.
226 Having all the headers and libraries in a single place will greatly
227 reduce the number of -I and -L flags you will have to pass to the
228 configure script (see below), as these files will be right where the
229 compiler expects them.
231 We specifically do NOT recommend installing packages below
232 "C:\Program Files" or "C:\Program Files (x86)". These directories
233 are protected on versions of Windows from Vista and on, and you will
234 have difficulties updating and maintaining your installation later,
235 due to UAC elevation prompts, file virtualization, etc. You *have*
238 Additional MinGW packages are required/recommended, especially if
239 you are building from the development repository:
241 . Texinfo (needed to produce the Info manuals when building from
242 the repository, and for "make install")
244 Available from http://sourceforge.net/projects/ezwinports/files/.
246 . pkg-config (invoked by the configure script to look for optional
249 Available from http://sourceforge.net/projects/ezwinports/files/.
251 . gzip (needed to compress files during "make install")
253 Available from http://gnuwin32.sourceforge.net/packages/gzip.htm.
255 Each package might list other packages as prerequisites on its
256 download page (under "Runtime requirements"); download those as
257 well. (Using the mingw-get installer will fetch those prerequisites
258 automatically for you.) A missing prerequisite will manifest itself
259 by the program failing to run and presenting a pop-up dialog that
260 states the missing or incompatible DLL; be sure to find and install
263 Once you think you have MinGW installed, test the installation by
264 building a trivial "hello, world!" program, and make sure that it
265 builds without any error messages and the binary works when run.
269 You will need a reasonably full MSYS installation. MSYS is an
270 environment needed to run the Posix configure scripts and the
271 resulting Makefile's, in order to produce native Windows binaries
272 using the MinGW compiler and runtime libraries. Here's the list of
273 MSYS packages that are required:
275 . All the packages from the MSYS Base distribution, listed here:
277 https://sourceforge.net/projects/mingw/files/MSYS/Base/
279 . Additional packages listed below, from the MSYS Extension
282 https://sourceforge.net/projects/mingw/files/MSYS/Extension/
290 These should only be needed if you intend to build development
291 versions of Emacs from the repository.
293 . Additional package (needed only if building from the repository):
294 Autoconf. It is available from here:
296 http://sourceforge.net/projects/ezwinports/files/autoconf-2.65-msys-bin.zip/download
298 MSYS packages are distributed as .tar.lzma compressed archives. To
299 install the packages manually, we recommend to use the Windows port
300 of the 'bsdtar' program, already mentioned above.
302 MSYS packages should be installed in a separate tree from MinGW.
303 For example, use D:\MSYS or D:\usr\MSYS as the top-level directory
304 from which you unpack all of the MSYS packages.
306 After installing Autoconf, make sure any of the *.m4 files you might
307 have in your MinGW installation also exist in the MSYS installation
308 tree, in the share/aclocal directory. Those *.m4 files which exist
309 in the MinGW tree, but not in the MSYS tree should be copied there.
311 If/when you are confident in your MinGW/MSYS installation, and want
312 to speed up the builds, we recommend installing a pre-release
313 version of Make from here:
315 https://sourceforge.net/projects/mingwbuilds/files/external-binary-packages/
317 These are snapshot builds of many packages, but you only need
318 make.exe from there. The advantage of this make.exe is that it
319 supports parallel builds, so you can use "make -j N" to considerably
320 speed up your builds.
322 Several users reported that MSYS 1.0.18 causes Make to hang in
323 parallel builds. If you bump into this, we suggest to downgrade to
324 MSYS 1.0.17, which doesn't have that problem.
326 For each of these packages, install the 'bin' and 'dll' tarballs of
327 their latest stable releases. If there's an 'ext' tarball (e.g.,
328 msysCORE and Coreutils have it), download and install those as well.
330 Each package might list other packages as prerequisites on its
331 download page (under "Runtime requirements"); download those as
332 well. (Using the mingw-get installer will fetch those prerequisites
333 automatically for you.) A missing prerequisite will manifest itself
334 by the program failing to run and presenting a pop-up dialog that
335 states the missing or incompatible DLL; be sure to find and install
338 Do NOT add the MSYS bin directory to your Windows Path! Only the
339 MinGW bin directory should be on Path. When you install MSYS, it
340 creates a shortcut on your desktop that invokes the MSYS Bash shell
341 in a Command Prompt window; that shell is already set up so that the
342 MSYS bin directory is on PATH ahead of any other directory. Thus,
343 Bash will find MSYS executables first, which is exactly what you
346 * Starting the MSYS Bash shell
348 For most reliable and predictable results, we recommend to start
349 Bash by clicking the "MSYS" icon on your desktop. That icon is
350 created when you install MSYS, and using it is the official way of
351 running the MSYS tools.
353 For other methods of starting the shell, make sure Bash is invoked
354 with the "--login" command-line switch.
356 When the shell window opens and you get the shell prompt, change to
357 the directory where you intend to build Emacs.
359 At this point, you are ready to build Emacs in its basic
360 configuration. If you want to build it with image support and other
361 optional libraries, read about that near the end of this document.
363 * Generating the configure script
365 If you are building a release or pretest tarball, skip this section,
366 because the configure script is already present in the tarball.
368 To build a development snapshot from the Emacs repository,
369 you will first need to generate the configure script and a few other
370 auto-generated files.
372 To generate the configure script, type this at the MSYS Bash prompt
373 from the top-level directory of the Emacs source tree:
377 If successful, this command should produce the following output:
380 Checking whether you have the necessary tools...
381 (Read INSTALL.REPO for more details on building Emacs)
382 Checking for autoconf (need at least version 2.65) ... ok
383 Your system has the required tools.
384 Building aclocal.m4 ...
385 Running 'autoreconf -fi -I m4' ...
386 You can now run './configure'.
388 If the script fails because it cannot find Git, you will need to
389 arrange for the MSYS Bash's PATH to include the Git's 'bin'
390 subdirectory, where there's the git.exe executable.
392 * Configuring Emacs for MinGW:
394 Now it's time to run the configure script. You can do that either
395 from a separate build directory that is outside of the Emacs source
396 tree (recommended), or from inside the source tree. The former is
397 recommended because it allows you to have several different builds,
398 e.g., an optimized build and an unoptimized one, of the same
399 revision of the source tree; the source tree will be left in its
400 pristine state, without any build products.
402 You invoke the configure script like this:
404 /PATH/TO/EMACS/SOURCE/TREE/configure --prefix=PREFIX ...
406 or, if you are building in-place, i.e. inside the source tree:
408 ./configure --prefix=PREFIX ...
410 Here PREFIX is the place where you eventually want to install Emacs
411 once built, e.g. /d/usr. We recommend to always use --prefix when
412 building Emacs on Windows, because the default '/usr/local' is not
413 appropriate for Windows: it will be mapped by MSYS to something like
414 C:\MSYS\local, and it will defeat the purpose of PREFIX, which is to
415 install programs in a single coherent tree resembling Posix systems.
416 Such a single-tree installation makes sure all the other programs
417 and packages ported from GNU or Unix systems will work seamlessly
418 together. Where exactly is the root of that tree on your system is
419 something only you, the user who builds Emacs, can know, and the
420 Emacs build process cannot guess, because usually there's no
421 '/usr/local' directory on any drive on Windows systems.
423 Do NOT use Windows-style x:/foo/bar file names on the configure
424 script command line; use the MSYS-style /x/foo/bar instead. Using
425 Windows-style file names was reported to cause subtle and hard to
426 figure out problems during the build. This applies both to the
427 command switches, such as --prefix=, and to the absolute file name
428 of 'configure', if you are building outside of the source tree.
430 You can pass additional options to the configure script, for the
435 As explained in the help text, you may need to tell the script what
436 are the optional flags to invoke the compiler. This is needed if
437 some of your headers and libraries, e.g., those belonging to
438 optional image libraries, are installed in places where the compiler
439 normally doesn't look for them. (Remember that advice above to
440 avoid such situations? here's is where you will start paying for
441 disregarding that recommendation.) For example, if you have libpng
442 headers in C:\emacs\libs\libpng-1.2.37-lib\include and jpeg library
443 headers in C:\emacs\libs\jpeg-6b-4-lib\include, you will need to say
446 CPPFLAGS='-I/c/emacs/libs/libpng-1.2.37-lib/include -I/c/emacs/libs/jpeg-6b-4-lib/include' ./configure --prefix=PREFIX
448 which is quite a mouth-full, especially if you have more directories
449 to specify... Perhaps you may wish to revisit your installation
452 If you have a global site-lisp directory from previous Emacs
453 installation, and you want Emacs to continue using it, specify it
454 via the --enable-locallisppath switch to 'configure', like this:
456 ./configure --prefix=PREFIX --enable-locallisppath="/d/usr/share/emacs/VERSION/site-lisp:/d/wherever/site-lisp"
458 Use the normal MSYS /d/foo/bar style to specify directories by their
461 A few frequently used options are needed when you want to produce an
462 unoptimized binary with runtime checks enabled:
464 CFLAGS='-O0 -g3' ./configure --prefix=PREFIX --enable-checking='yes,glyphs'
466 Once invoked, the configure script will run for some time, and, if
467 successful, will eventually produce a summary of the configuration
470 Configured for 'i686-pc-mingw32'.
472 Where should the build process find the source code? /path/to/emacs/sources
473 What compiler should emacs be built with? gcc -std=gnu99 -O0 -g3
474 Should Emacs use the GNU version of malloc? no
475 (The GNU allocators don't work with this system configuration.)
476 Should Emacs use a relocating allocator for buffers? no
477 Should Emacs use mmap(2) for buffer allocation? yes
478 What window system should Emacs use? w32
479 What toolkit should Emacs use? none
480 Where do we find X Windows header files? NONE
481 Where do we find X Windows libraries? NONE
482 Does Emacs use -lXaw3d? no
483 Does Emacs use -lXpm? yes
484 Does Emacs use -ljpeg? yes
485 Does Emacs use -ltiff? yes
486 Does Emacs use a gif library? yes
487 Does Emacs use a png library? yes
488 Does Emacs use -lrsvg-2? yes
489 Does Emacs use cairo? no
490 Does Emacs use -llcms2? yes
491 Does Emacs use imagemagick? no
492 Does Emacs support sound? no
493 Does Emacs use -lgpm? no
494 Does Emacs use -ldbus? no
495 Does Emacs use -lgconf? no
496 Does Emacs use GSettings? no
497 Does Emacs use a file notification library? yes (w32)
498 Does Emacs use access control lists? yes
499 Does Emacs use -lselinux? no
500 Does Emacs use -lgnutls? yes
501 Does Emacs use -lxml2? yes
502 Does Emacs use -lfreetype? no
503 Does Emacs use -lm17n-flt? no
504 Does Emacs use -lotf? no
505 Does Emacs use -lxft? no
506 Does Emacs directly use zlib? yes
507 Does Emacs use toolkit scroll bars? yes
509 You are almost there, hang on.
511 If the output is significantly different, or if configure finishes
512 prematurely and displays some error message, you should examine the
513 configuration log in config.log and find the reason for the failure.
515 Once you succeeded in configuring Emacs, and just want to rebuild it
516 after updating your local repository from the main repository, you
517 don't need to re-run the configure script manually, unless you want
518 to change the configure-time options. Just typing "make" will
519 re-run configure if necessary with the exact same options you
520 specified originally, and then go on to invoking Make, described
525 This is simple: just type "make" and sit back, watching the fun.
527 If you installed a snapshot build of Make, the build will be much
528 faster if you type "make -j N" instead, where N is the number of
529 independent processing units on your machine. E.g., on a core i7
530 system try using N of 6 or even 8. (If this hangs, see the notes
531 above about downgrading to MSYS 1.0.17.)
533 When Make finishes, you can install the produced binaries:
537 or, if you want the installed tree to go in a place different from
538 the configured one, type
540 make install prefix=WHEREVER
542 Congrats! You have built and installed your own Emacs!
546 The following make targets may be used by users building the source
547 distribution, or users who have checked out of the repository after
548 an initial bootstrapping.
551 Builds Emacs from the available sources and pre-compiled lisp files.
554 Installs the built programs and the auxiliary files.
557 Removes object and executable files produced by the build process in
558 the current configuration. After "make clean", you can rebuild with
559 the same configuration using make. useful when you want to be sure
560 that all of the products are built from coherent sources.
563 In addition to the files removed by make clean, this also removes
564 Makefiles and other generated files to get back to the state of a
565 freshly unpacked source distribution. After make distclean, it is
566 necessary to run the configure script followed by "make", in order
569 The following targets are intended only for use with the repository
573 Removes all the auto-generated files and all the *.elc byte-compiled
574 files, and builds Emacs from scratch. Useful when some change in
575 basic Emacs functionality makes byte compilation of updated files
578 make maintainer-clean
579 Removes everything that can be recreated, including compiled Lisp
580 files, to get back to the state of a fresh repository tree. After make
581 maintainer-clean, it is necessary to run configure and "make" or
582 "make bootstrap" to rebuild. Occasionally it may be necessary to
583 run this target after an update.
585 * Optional image library support
587 In addition to its "native" image formats (pbm and xbm), Emacs can
588 handle other image types: xpm, tiff, gif, png, jpeg and experimental
591 To build Emacs with support for them, the corresponding headers must
592 be in the include path and libraries should be where the linker
593 looks for them, when the configure script is run. If needed, this
594 can be set up using the CPPFLAGS and CFLAGS variable specified on
595 the configure command line. The configure script will report
596 whether it was able to detect the headers and libraries. If the
597 results of this testing appear to be incorrect, please look for
598 details in the file config.log: it will show the failed test
599 programs and compiler error messages that should explain what is
600 wrong. (Usually, any such failures happen because some headers are
601 missing due to bad packaging of the image support libraries.)
603 Note that any file path passed to the compiler or linker must use
604 forward slashes, or double each backslash, as that is how Bash
607 If the configure script finds the necessary headers and libraries,
608 but they are for some reason incompatible, or if you want to omit
609 support for some image library that is installed on your system for
610 some other reason, use the --without-PACKAGE option to configure,
611 such as --without-gif to omit GIF, --without-tiff to omit TIFF, etc.
612 Passing the --help option to the configure script displays all of
613 the supported --without-PACKAGE options.
615 To use the external image support, the DLLs implementing the
616 functionality must be found when Emacs first needs them, either on the
617 PATH, or in the same directory as emacs.exe. Failure to find a
618 library is not an error; the associated image format will simply be
619 unavailable. Note that once Emacs has determined that a library can
620 not be found, there's no way to force it to try again, other than
621 restarting. See the variable `dynamic-library-alist' to configure the
622 expected names of the libraries.
624 Some image libraries have dependencies on one another, or on zlib.
625 For example, tiff support depends on the jpeg library. If you did not
626 compile the libraries yourself, you must make sure that any dependency
627 is in the PATH or otherwise accessible and that the binaries are
628 compatible (for example, that they were built with the same compiler).
630 To support XPM images (required for color tool-bar icons), you will
631 need the libXpm library. It is available from the ezwinports site,
632 http://sourceforge.net/projects/ezwinports/files/ and from
633 https://ftp.gnu.org/gnu/emacs/windows/.
635 For PNG images, we recommend to use versions 1.4.x and later of
636 libpng, because previous versions had security issues. You can find
637 precompiled libraries and headers on the ezwinports site and on
640 Versions 1.4.0 and later of libpng are binary incompatible with
641 earlier versions, so Emacs will only look for libpng libraries which
642 are compatible with the version it was compiled against. That
643 version is given by the value of the Lisp variable `libpng-version';
644 e.g., 10403 means version 1.4.3. The variable `dynamic-library-alist'
645 is automatically set to name only those DLL names that are known to
646 be compatible with the version given by `libpng-version'. If PNG
647 support does not work for you even though you have the support DLL
648 installed, check the name of the installed DLL against
649 `dynamic-library-alist' and the value of `libpng-version', and
650 download compatible DLLs if needed.
652 For GIF images, we recommend to use versions 5.0.0 or later of
653 giflib, as it is much enhanced wrt previous versions. You can find
654 precompiled binaries and headers for giflib on the ezwinports site,
655 http://sourceforge.net/projects/ezwinports/files/ and on
656 https://ftp.gnu.org/gnu/emacs/windows/.
658 Version 5.0.0 and later of giflib are binary incompatible with
659 previous versions (the signatures of several functions have
660 changed), so Emacs will only look for giflib libraries that are
661 compatible with the version it was compiled against. Similar to
662 libpng, that version is given by the value of the Lisp variable
663 `libgif-version'; e.g., 50005 means version 5.0.5. The variable
664 `dynamic-library-alist' is automatically set to name only those DLL
665 libraries that are known to be compatible with the version given by
668 For JPEG images, you will need libjpeg 6b or later, which will be
669 called libjpeg-N.dll, jpeg62.dll, libjpeg.dll, or jpeg.dll. You can
670 find these on the ezwinports site and on ftp.gnu.org.
672 TIFF images require libTIFF 3.0 or later, which will be called
673 libtiffN.dll or libtiff-N.dll or libtiff.dll. These can be found on
676 Pre-built versions of librsvg and its dependencies can be found
679 http://sourceforge.net/projects/ezwinports/files/
681 This site includes a minimal (as much as possible for librsvg)
682 build of the library and its dependencies; it is also more
683 up-to-date with the latest upstream versions. However, it
684 currently only offers 32-bit builds. For building Emacs, you need
685 to download from this site all of the following *-bin.zip
688 librsvg, gdk-pixbuf, cairo, glib
690 The 'bin' archives on this site include both header files and the
691 libraries needed for building with librsvg and for running Emacs.
692 The librsvg archive includes all the shared libraries needed to
693 run Emacs with SVG support; the other 3 packages are required
694 because the compiler needs to see their header files when building
697 https://ftp.gnu.org/gnu/emacs/windows/
699 More fat ports, from the MSYS2 project.
701 To use librsvg at runtime, ensure that librsvg and its dependencies
702 are on your PATH, or in the same directory as the emacs.exe binary.
703 If you are downloading from the ezwinports site, you only need to
704 install a single archive, librsvg-X.Y.Z-w32-bin.zip, which includes
705 all the dependency DLLs.
707 If you think you've got all the dependencies and SVG support is
708 still not working, check your PATH for other libraries that shadow
709 the ones you downloaded. Libraries of the same name from different
710 sources may not be compatible, this problem was encountered in the
711 past, e.g., with libcroco from gnome.org.
713 If you can see etc/images/splash.svg, then you have managed to get
714 SVG support working. Congratulations for making it through DLL hell
715 to this point. For some SVG images, you'll probably see error
716 messages from Glib about failed assertions, or warnings from Pango
717 about failure to load fonts (installing the missing fonts should fix
718 the latter kind of problems). Problems have been observed in some
719 images that contain text, they seem to be a problem in the Windows
720 port of Pango, or maybe a problem with the way Cairo or librsvg is
721 using it that doesn't show up on other platforms. However, Emacs
722 should not crash due to these issues. If you eventually find the
723 SVG support too unstable to your taste, you can rebuild Emacs
724 without it by specifying the --without-rsvg switch to the configure
727 Binaries for the other image libraries can be found on the
728 ezwinports site or at the GnuWin32 project (the latter are generally
729 very old, so not recommended). Note specifically that, due to some
730 packaging snafus in the GnuWin32-supplied image libraries, you will
731 need to download _source_ packages for some of the libraries in
732 order to get the header files necessary for building Emacs with
735 * Optional GnuTLS support
737 To compile with GnuTLS, you will need pkg-config to be installed, as
738 the configure script invokes pkg-config to find out which compiler
739 switches to use for GnuTLS. See above for the URL where you can
740 find pkg-config for Windows.
742 You will also need to install the p11-kit package, which is a
743 dependency of GnuTLS, and its header files are needed for
744 compilation of programs that use GnuTLS. You can find p11-kit on
745 the same site as GnuTLS, see the URL below.
747 If the configure script finds the GnuTLS header files and libraries
748 on your system, Emacs is built with GnuTLS support by default; to
749 avoid that you can pass the argument --without-gnutls.
751 In order to support GnuTLS at runtime, a GnuTLS-enabled Emacs must
752 be able to find the relevant DLLs during startup; failure to do so
753 is not an error, but GnuTLS won't be available to the running
756 You can get pre-built binaries (including any required DLL and the
757 header files) at http://sourceforge.net/projects/ezwinports/files/
758 and on https://ftp.gnu.org/gnu/emacs/windows/.
760 * Optional libxml2 support
762 To compile with libxml2, you will need pkg-config to be installed,
763 as the configure script invokes pkg-config to find out which
764 compiler switches to use for libxml2. See above for the URL where
765 you can find pkg-config for Windows.
767 If the configure script finds the libxml2 header files and libraries
768 on your system, Emacs is built with libxml2 support by default; to
769 avoid that you can pass the argument --without-libxml2.
771 In order to support libxml2 at runtime, a libxml2-enabled Emacs must
772 be able to find the relevant DLLs during startup; failure to do so
773 is not an error, but libxml2 features won't be available to the
776 One place where you can get pre-built Windows binaries of libxml2
777 (including any required DLL and the header files) is here:
779 http://sourceforge.net/projects/ezwinports/files/
780 https://ftp.gnu.org/gnu/emacs/windows/
782 For runtime support of libxml2, you will also need to install the
783 libiconv "development" tarball, because the libiconv headers need to
784 be available to the compiler when you compile with libxml2 support.
785 A MinGW port of libiconv can be found on the MinGW site:
787 http://sourceforge.net/projects/mingw/files/MinGW/Base/libiconv/
789 You need the libiconv-X.Y.Z-N-mingw32-dev.tar.lzma tarball from that
792 * Optional support for decompressing text
794 Emacs can decompress text if compiled with the zlib library.
795 Prebuilt binaries of zlib DLL (for 32-bit builds of Emacs) are
796 available from the ezwinports site and on ftp.gnu.org; see above for
799 (This library is also a prerequisite for several image libraries, so
800 you may already have it; look for zlib1.dll or libz-1.dll.)
802 * Optional support for lcms2 library
804 Emacs can expose some capabilities of the Little CMS color
805 management engine to Lisp programs using the lcms2 library.
806 Prebuilt binaries of lcms2 DLL (for 32-bit builds of Emacs) are
807 available from the ezwinports site and from the MSYS2 project.
810 This file is part of GNU Emacs.
812 GNU Emacs is free software: you can redistribute it and/or modify
813 it under the terms of the GNU General Public License as published by
814 the Free Software Foundation, either version 3 of the License, or
815 (at your option) any later version.
817 GNU Emacs is distributed in the hope that it will be useful,
818 but WITHOUT ANY WARRANTY; without even the implied warranty of
819 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
820 GNU General Public License for more details.
822 You should have received a copy of the GNU General Public License
823 along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.