Merge from emacs-24; up to 2014-05-26T10:21:18Z!rgm@gnu.org
[emacs.git] / nt / INSTALL
blob949a4e452cf7f8a866907651fbc2257fd8a0bcc0
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
10 Windows 9X as well).
12   Do not use this recipe with Cygwin.  For building on Cygwin, use the
13   normal installation instructions, ../INSTALL.
15 * For the brave (a.k.a. "impatient"):
17   For those who have a working MSYS/MinGW development environment and
18   are comfortable with running Posix configure scripts, here are the
19   concise instructions for configuring and building the native Windows
20   binary of Emacs with these tools:
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:
29       ./autogen.sh
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        CFLAGS='-O0 -g3' ./configure --prefix=/d/usr/emacs --enable-checking='yes,glyphs'
54   3. After the configure script finishes, it should display the
55      resulting configuration.  After that, type
57        make
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:
66        make install
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
73   That's it!
75   If these short instructions somehow fail, read the rest of this
76   file.
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 alternatives 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
88   these.
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
94   here:
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
103   its wizard.
105   After that, use "mingw-get install PACKAGE" to install the following
106   additional packages:
108    . msys-base
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
129 *** MinGW
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*
166   been warned!
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/git, and for "make install")
174      Available from http://sourceforge.net/projects/ezwinports/files/.
176    . pkg-config (invoked by the configure script to look for optional
177      packages)
179      Available from http://www.gtk.org/download/win32.php
181    . gzip (needed to compress files during "make install")
183      Available from http://gnuwin32.sourceforge.net/packages/gzip.htm.
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
191   these missing DLLs.
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.
197 *** MSYS
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
210      distribution here:
212      https://sourceforge.net/projects/mingw/files/MSYS/Extension/
214       - flex
215       - bison
216       - m4
217       - perl
218       - mktemp
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
225      here:
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   MSYS packages should be installed in a separate tree from MinGW.
235   For example, use D:\MSYS or D:\usr\MSYS as the top-level directory
236   from which you unpack all of the MSYS packages.
238   After installing Automake and Autoconf, make sure any of the *.m4
239   files you might have in your MinGW installation also exist in the
240   MSYS installation tree, in the share/aclocal directory.  Those *.m4
241   files which exist in the MinGW tree, but not in the MSYS tree should
242   be copied there.
244   If/when you are confident in your MinGW/MSYS installation, and want
245   to speed up the builds, we recommend installing a pre-release
246   version of Make from here:
248      https://sourceforge.net/projects/mingwbuilds/files/external-binary-packages/
250   These are snapshot builds of many packages, but you only need
251   make.exe from there.  The advantage of this make.exe is that it
252   supports parallel builds, so you can use "make -j N" to considerably
253   speed up your builds.
255   Several users reported that MSYS 1.0.18 causes Make to hang in
256   parallel builds.  If you bump into this, we suggest to downgrade to
257   MSYS 1.0.17, which doesn't have that problem.
259   For each of these packages, install the 'bin' and 'dll' tarballs of
260   their latest stable releases.  If there's an 'ext' tarball (e.g.,
261   msysCORE and Coreutils have it), download and install those as well.
263   Each package might list other packages as prerequisites on its
264   download page (under "Runtime requirements"); download those as
265   well.  (Using the mingw-get installer will fetch those prerequisites
266   automatically for you.)  A missing prerequisite will manifest itself
267   by the program failing to run and presenting a pop-up dialog that
268   states the missing or incompatible DLL; be sure to find and install
269   these missing DLLs.
271   Do NOT add the MSYS bin directory to your Windows Path!  Only the
272   MinGW bin directory should be on Path.  When you install MSYS, it
273   creates a shortcut on your desktop that invokes the MSYS Bash shell
274   in a Command Prompt window; that shell is already set up so that the
275   MSYS bin directory is on PATH ahead of any other directory.  Thus,
276   Bash will find MSYS executables first, which is exactly what you
277   need.
279   At this point, you are ready to build Emacs in its basic
280   configuration.  If you want to build it with image support and other
281   optional libraries, read about that near the end of this document.
283 * Generating the configure script
285   If you are building a release or pretest tarball, skip this section,
286   because the configure script is already present in the tarball.
288   To build a development snapshot from the Emacs repository,
289   you will first need to generate the configure script and a few other
290   auto-generated files.
292   To generate the configure script, type this at the MSYS Bash prompt
293   from the top-level directory of the Emacs tree:
295      ./autogen.sh
297   If successful, this command should produce the following output:
299      $ ./autogen.sh
300      Checking whether you have the necessary tools...
301      (Read INSTALL.REPO for more details on building Emacs)
303      Checking for autoconf (need at least version 2.65)...
304      ok
305      Checking for automake (need at least version 1.11)...
306      ok
307      Your system has the required tools, running autoreconf...
308      You can now run `./configure'.
310 * Configuring Emacs for MinGW:
312   Now it's time to run the configure script.  You can do that either
313   from a separate build directory that is outside of the Emacs source
314   tree (recommended), or from inside the source tree.  The former is
315   recommended because it allows you to have several different builds,
316   e.g., an optimized build and an unoptimized one, of the same
317   revision of the source tree; the source tree will be left in its
318   pristine state, without any build products.
320   You invoke the configure script like this:
322      /PATH/TO/EMACS/SOURCE/TREE/configure --prefix=PREFIX ...
324   or, if you are building in-place, i.e. inside the source tree:
326      ./configure --prefix=PREFIX ...
328   Here PREFIX is the place where you eventually want to install Emacs
329   once built, e.g. /d/usr.  We recommend to always use --prefix when
330   building Emacs on Windows, because the default '/usr/local' is not
331   appropriate for Windows: it will be mapped by MSYS to something like
332   C:\MSYS\local, and it will defeat the purpose of PREFIX, which is to
333   install programs in a single coherent tree resembling Posix systems.
334   Such a single-tree installation makes sure all the other programs
335   and packages ported from GNU or Unix systems will work seamlessly
336   together.  Where exactly is the root of that tree on your system is
337   something only you, the user who builds Emacs, can know, and the
338   Emacs build process cannot guess, because usually there's no
339   '/usr/local' directory on any drive on Windows systems.
341   Do NOT use Windows-style x:/foo/bar file names on the configure
342   script command line; use the MSYS-style /x/foo/bar instead.  Using
343   Windows-style file names was reported to cause subtle and hard to
344   figure out problems during the build.  This applies both to the
345   command switches, such as --prefix=, and to the absolute file name
346   of 'configure', if you are building outside of the source tree.
348   You can pass additional options to the configure script, for the
349   full list type
351      ./configure --help
353   As explained in the help text, you may need to tell the script what
354   are the optional flags to invoke the compiler.  This is needed if
355   some of your headers and libraries, e.g., those belonging to
356   optional image libraries, are installed in places where the compiler
357   normally doesn't look for them.  (Remember that advice above to
358   avoid such situations? here's is where you will start paying for
359   disregarding that recommendation.)  For example, if you have libpng
360   headers in C:\emacs\libs\libpng-1.2.37-lib\include and jpeg library
361   headers in C:\emacs\libs\jpeg-6b-4-lib\include, you will need to say
362   something like this:
364     CPPFLAGS='-I/c/emacs/libs/libpng-1.2.37-lib/include -I/c/emacs/libs/jpeg-6b-4-lib/include' ./configure --prefix=PREFIX
366   which is quite a mouth-full, especially if you have more directories
367   to specify...  Perhaps you may wish to revisit your installation
368   decisions now.
370   If you have a global site-lisp directory from previous Emacs
371   installation, and you want Emacs to continue using it, specify it
372   via the --enable-locallisppath switch to 'configure', like this:
374    ./configure --prefix=PREFIX --enable-locallisppath="/d/usr/share/emacs/VERSION/site-lisp:/d/wherever/site-lisp"
376   Use the normal MSYS /d/foo/bar style to specify directories by their
377   absolute file names.
379   A few frequently used options are needed when you want to produce an
380   unoptimized binary with runtime checks enabled:
382      CFLAGS='-O0 -g3' ./configure --prefix=PREFIX --enable-checking='yes,glyphs'
384   Once invoked, the configure script will run for some time, and, if
385   successful, will eventually produce a summary of the configuration
386   similar to this:
388      Configured for `i686-pc-mingw32'.
390        Where should the build process find the source code?    /path/to/emacs/sources
391        What compiler should emacs be built with?               gcc  -std=gnu99 -O0 -g3
392        Should Emacs use the GNU version of malloc?             yes
393        Should Emacs use a relocating allocator for buffers?    yes
394        Should Emacs use mmap(2) for buffer allocation?         no
395        What window system should Emacs use?                    w32
396        What toolkit should Emacs use?                          none
397        Where do we find X Windows header files?                NONE
398        Where do we find X Windows libraries?                   NONE
399        Does Emacs use -lXaw3d?                                 no
400        Does Emacs use -lXpm?                                   yes
401        Does Emacs use -ljpeg?                                  yes
402        Does Emacs use -ltiff?                                  yes
403        Does Emacs use a gif library?                           yes
404        Does Emacs use -lpng?                                   yes
405        Does Emacs use -lrsvg-2?                                no
406        Does Emacs use imagemagick?                             no
407        Does Emacs use -lgpm?                                   no
408        Does Emacs use -ldbus?                                  no
409        Does Emacs use -lgconf?                                 no
410        Does Emacs use GSettings?                               no
411        Does Emacs use -lselinux?                               no
412        Does Emacs use -lgnutls?                                yes
413        Does Emacs use -lxml2?                                  yes
414        Does Emacs use -lfreetype?                              no
415        Does Emacs use -lm17n-flt?                              no
416        Does Emacs use -lotf?                                   no
417        Does Emacs use -lxft?                                   no
418        Does Emacs use toolkit scroll bars?                     yes
420   You are almost there, hang on.
422   If the output is significantly different, or if configure finishes
423   prematurely and displays some error message, you should examine the
424   configuration log in config.log and find the reason for the failure.
426   Once you succeeded in configuring Emacs, and just want to rebuild it
427   after updating your local repository from the main repository, you
428   don't need to re-run the configure script manually, unless you want
429   to change the configure-time options.  Just typing "make" will
430   re-run configure if necessary with the exact same options you
431   specified originally, and then go on to invoking Make, described
432   below.
434 * Running Make.
436   This is simple: just type "make" and sit back, watching the fun.
438   If you  installed a snapshot build  of Make, the build  will be much
439   faster if  you type "make  -j N" instead, where  N is the  number of
440   independent processing  units on your  machine.  E.g., on a  core i7
441   system try using  N of 6 or  even 8.  (If this hangs,  see the notes
442   above about downgrading to MSYS 1.0.17.)
444   When Make finishes, you can install the produced binaries:
446     make install
448   or, if you want the installed tree to go in a place different from
449   the configured one, type
451     make install prefix=WHEREVER
453   Congrats!  You have built and installed your own Emacs!
455 * Make targets
457   The following make targets may be used by users building the source
458   distribution, or users who have checked out of the repository after
459   an initial bootstrapping.
461   make
462   Builds Emacs from the available sources and pre-compiled lisp files.
464   make install
465   Installs the built programs and the auxiliary files.
467   make clean
468   Removes object and executable files produced by the build process in
469   the current configuration.  After "make clean", you can rebuild with
470   the same configuration using make.  useful when you want to be sure
471   that all of the products are built from coherent sources.
473   make distclean
474   In addition to the files removed by make clean, this also removes
475   Makefiles and other generated files to get back to the state of a
476   freshly unpacked source distribution.  After make distclean, it is
477   necessary to run the configure script followed by "make", in order
478   to rebuild.
480   The following targets are intended only for use with the repository
481   sources.
483   make bootstrap
484   Removes all the auto-generated files and all the *.elc byte-compiled
485   files, and builds Emacs from scratch.  Useful when some change in
486   basic Emacs functionality makes byte compilation of updated files
487   fail.
489   make maintainer-clean
490   Removes everything that can be recreated, including compiled Lisp
491   files, to get back to the state of a fresh repository tree.  After make
492   maintainer-clean, it is necessary to run configure and "make" or
493   "make bootstrap" to rebuild.  Occasionally it may be necessary to
494   run this target after an update.
496 * Optional image library support
498   In addition to its "native" image formats (pbm and xbm), Emacs can
499   handle other image types: xpm, tiff, gif, png, jpeg and experimental
500   support for svg.
502   To build Emacs with support for them, the corresponding headers must
503   be in the include path and libraries should be where the linker
504   looks for them, when the configure script is run.  If needed, this
505   can be set up using the CPPFLAGS and CFLAGS variable specified on
506   the configure command line.  The configure script will report
507   whether it was able to detect the headers and libraries.  If the
508   results of this testing appear to be incorrect, please look for
509   details in the file config.log: it will show the failed test
510   programs and compiler error messages that should explain what is
511   wrong.  (Usually, any such failures happen because some headers are
512   missing due to bad packaging of the image support libraries.)
514   Note that any file path passed to the compiler or linker must use
515   forward slashes, or double each backslash, as that is how Bash
516   works.
518   If the configure script finds the necessary headers and libraries,
519   but they are for some reason incompatible, or if you want to omit
520   support for some image library that is installed on your system for
521   some other reason, use the --without-PACKAGE option to configure,
522   such as --without-gif to omit GIF, --without-tiff to omit TIFF, etc.
523   Passing the --help option to the configure script displays all of
524   the supported --without-PACKAGE options.
526   To use the external image support, the DLLs implementing the
527   functionality must be found when Emacs first needs them, either on the
528   PATH, or in the same directory as emacs.exe.  Failure to find a
529   library is not an error; the associated image format will simply be
530   unavailable.  Note that once Emacs has determined that a library can
531   not be found, there's no way to force it to try again, other than
532   restarting.  See the variable `dynamic-library-alist' to configure the
533   expected names of the libraries.
535   Some image libraries have dependencies on one another, or on zlib.
536   For example, tiff support depends on the jpeg library.  If you did not
537   compile the libraries yourself, you must make sure that any dependency
538   is in the PATH or otherwise accessible and that the binaries are
539   compatible (for example, that they were built with the same compiler).
541   For PNG images, we recommend to use versions 1.4.x and later of
542   libpng, because previous versions had security issues.  You can find
543   precompiled libraries and headers on the GTK download page for
544   Windows (http://www.gtk.org/download/win32.php for 32-bit builds and
545   http://www.gtk.org/download/win64.php for 64-bit builds).  The
546   ezwinports site, http://sourceforge.net/projects/ezwinports/files/
547   also offers PNG (as well as other image libraries), which are
548   usually newer.
550   Versions 1.4.0 and later of libpng are binary incompatible with
551   earlier versions, so Emacs will only look for libpng libraries which
552   are compatible with the version it was compiled against.  That
553   version is given by the value of the Lisp variable `libpng-version';
554   e.g., 10403 means version 1.4.3.  The variable `dynamic-library-alist'
555   is automatically set to name only those DLL names that are known to
556   be compatible with the version given by `libpng-version'.  If PNG
557   support does not work for you even though you have the support DLL
558   installed, check the name of the installed DLL against
559   `dynamic-library-alist' and the value of `libpng-version', and
560   download compatible DLLs if needed.
562   For GIF images, we recommend to use versions 5.0.0 or later of
563   giflib, as it is much enhanced wrt previous versions.  You can find
564   precompiled binaries and headers for giflib on the ezwinports site,
565   http://sourceforge.net/projects/ezwinports/files/.
567   Version 5.0.0 and later of giflib are binary incompatible with
568   previous versions (the signatures of several functions have
569   changed), so Emacs will only look for giflib libraries that are
570   compatible with the version it was compiled against.  Similar to
571   libpng, that version is given by the value of the Lisp variable
572   `libgif-version'; e.g., 50005 means version 5.0.5.  The variable
573   `dynamic-library-alist' is automatically set to name only those DLL
574   libraries that are known to be compatible with the version given by
575   `libgif-version'.
577   For JPEG images, you will need libjpeg 6b or later, which will be
578   called libjpeg-N.dll, jpeg62.dll, libjpeg.dll, or jpeg.dll.  You can
579   find these on the ezwinports site.
581   TIFF images require libTIFF 3.0 or later, which will be called
582   libtiffN.dll or libtiff-N.dll or libtiff.dll.  These can be found on
583   the ezwinports site.
585   Pre-built versions of librsvg and its dependencies can be found in
586   one of these places:
588   1. http://sourceforge.net/projects/ezwinports/files/
590      This site includes a minimal (as much as possible for librsvg)
591      build of the library and its dependencies; it is also more
592      up-to-date with the latest upstream versions.  However, it
593      currently only offers 32-bit builds.  For building Emacs, you
594      need to download from this site all of the following *-bin.zip
595      archives:
597        librsvg, gdk-pixbuf, cairo, glib
599      The 'bin' archives on this site include both header files and the
600      libraries needed for building with librsvg and for running Emacs.
601      The librsvg archive includes all the shared libraries needed to
602      run Emacs with SVG support; the other 3 packages are required
603      because the compiler needs to see their header files when
604      building Emacs.
606   2. GTK project download site for Windows (see above for 2 URLs,
607      either for 32-bit builds or 64-bit builds)
609      This is the official Windows download site of the GTK project.
610      Its builds of librsvg are fatter, but are currently the only
611      alternative for 64-bit builds.  The easiest way to obtain the
612      dependencies required for building from this site is to download
613      a pre-bundled GTK+ development environment for Windows.  If you
614      would nevertheless like to download only the packages that are
615      strictly required, then, as of the time of this writing, here's
616      the list of GTK+ packages you will need:
618         librsvg, pango, freetype-2.4.11, freetype-2.4.2, croco, cairo,
619         glib, gdk-pixbuf, fontconfig, libpng-1.4.x, libpng-1.5.x,
620         libffi, libxml2, zlib
622      The GTK download page provides 2 separate archives for each
623      package: a 'bin' (binary) archive with programs and DLLs, and a
624      'dev' (development) archive with header files, import libraries,
625      and pkg-config files; download and install both archives for each
626      package you need.  (Sources of each package are available in a
627      separate, 3rd archive.)
629      As you see, some libraries for using this site's librsvg are
630      needed in more than one version -- this is because librsvg and
631      some of its dependencies were linked against different versions
632      of those libraries, and will look only for those DLLs when you
633      invoke SVG function.  So there's a bit of "DLL hell" involved
634      here, but at least in theory this should work, as each library
635      will dynamically link only against its dependencies, even if
636      another version of the same library is already loaded.  In
637      particular, at least 2 different versions of libpng will have to
638      be installed on your machine.  When you install these libpng
639      versions, be sure to keep the header files and the pkg-config
640      files in sync, i.e. install both the 'bin' and 'dev' archives of
641      the same libpng version together.
643   To use librsvg at runtime, ensure that librsvg and its dependencies
644   are on your PATH, or in the same directory as the emacs.exe binary.
645   If you are downloading from the ezwinports site, you only need to
646   install a single archive, librsvg-X.Y.Z-w32-bin.zip, which includes
647   all the dependency DLLs.  For the GTK project site, download the
648   'bin' archives for each of the libraries mentioned above.
650   If you think you've got all the dependencies and SVG support is
651   still not working, check your PATH for other libraries that shadow
652   the ones you downloaded.  Libraries of the same name from different
653   sources may not be compatible, this problem was encountered in the
654   past, e.g., with libcroco from gnome.org.
656   If you can see etc/images/splash.svg, then you have managed to get
657   SVG support working.  Congratulations for making it through DLL hell
658   to this point.  For some SVG images, you'll probably see error
659   messages from Glib about failed assertions, or warnings from Pango
660   about failure to load fonts (installing the missing fonts should fix
661   the latter kind of problems).  Problems have been observed in some
662   images that contain text, they seem to be a problem in the Windows
663   port of Pango, or maybe a problem with the way Cairo or librsvg is
664   using it that doesn't show up on other platforms.  However, Emacs
665   should not crash due to these issues.  If you eventually find the
666   SVG support too unstable to your taste, you can rebuild Emacs
667   without it by specifying the --without-rsvg switch to the configure
668   script.
670   Binaries for the other image libraries can be found on the
671   ezwinports site or at the GnuWin32 project (the latter are generally
672   very old, so not recommended).  Note specifically that, due to some
673   packaging snafus in the GnuWin32-supplied image libraries, you will
674   need to download _source_ packages for some of the libraries in
675   order to get the header files necessary for building Emacs with
676   image support.
678 * Optional GnuTLS support
680   To compile with GnuTLS, you will need pkg-config to be installed, as
681   the configure script invokes pkg-config to find out which compiler
682   switches to use for GnuTLS.  See above for the URL where you can
683   find pkg-config for Windows.
685   You will also need to install the p11-kit package, which is a
686   dependency of GnuTLS, and its header files are needed for
687   compilation of programs that use GnuTLS.  You can find p11-kit on
688   the same site as GnuTLS, see the URL below.
690   If the configure script finds the GnuTLS header files and libraries
691   on your system, Emacs is built with GnuTLS support by default; to
692   avoid that you can pass the argument --without-gnutls.
694   In order to support GnuTLS at runtime, a GnuTLS-enabled Emacs must
695   be able to find the relevant DLLs during startup; failure to do so
696   is not an error, but GnuTLS won't be available to the running
697   session.
699   You can get pre-built binaries (including any required DLL and the
700   header files) at http://sourceforge.net/projects/ezwinports/files/.
702 * Optional libxml2 support
704   To compile with libxml2, you will need pkg-config to be installed,
705   as the configure script invokes pkg-config to find out which
706   compiler switches to use for libxml2.  See above for the URL where
707   you can find pkg-config for Windows.
709   If the configure script finds the libxml2 header files and libraries
710   on your system, Emacs is built with libxml2 support by default; to
711   avoid that you can pass the argument --without-libxml2.
713   In order to support libxml2 at runtime, a libxml2-enabled Emacs must
714   be able to find the relevant DLLs during startup; failure to do so
715   is not an error, but libxml2 features won't be available to the
716   running session.
718   One place where you can get pre-built Windows binaries of libxml2
719   (including any required DLL and the header files) is here:
721      http://sourceforge.net/projects/ezwinports/files/
723   For runtime support of libxml2, you will also need to install the
724   libiconv "development" tarball, because the libiconv headers need to
725   be available to the compiler when you compile with libxml2 support.
726   A MinGW port of libiconv can be found on the MinGW site:
728    http://sourceforge.net/projects/mingw/files/MinGW/Base/libiconv/
730   You need the libiconv-X.Y.Z-N-mingw32-dev.tar.lzma tarball from that
731   site.
734 This file is part of GNU Emacs.
736 GNU Emacs is free software: you can redistribute it and/or modify
737 it under the terms of the GNU General Public License as published by
738 the Free Software Foundation, either version 3 of the License, or
739 (at your option) any later version.
741 GNU Emacs is distributed in the hope that it will be useful,
742 but WITHOUT ANY WARRANTY; without even the implied warranty of
743 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
744 GNU General Public License for more details.
746 You should have received a copy of the GNU General Public License
747 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.