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