Merge from trunk.
[bpt/emacs.git] / nt / INSTALL.MSYS
1 Building and Installing Emacs on MS-Windows
2 using the MSYS and MinGW tools
3
4 Copyright (C) 2013 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 * For the brave (a.k.a. "impatient"):
13
14 For those who have a working MSYS/MinGW development environment and
15 are comfortable with running Posix configure scripts, here are the
16 concise instructions for configuring and building the native Windows
17 binary of Emacs with these tools.
18
19 Do not use this recipe with Cygwin. For building on Cygwin, use the
20 normal installation instructions, ../INSTALL.
21
22 Do not use these instructions if you don't have MSYS installed; for
23 that, see the file INSTALL in this directory.
24
25 0. Start the MSYS Bash window. Everything else below is done from
26 that window's Bash prompt.
27
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:
31
32 ./autogen.sh
33
34 1. If you want to build Emacs outside of the source tree
35 (recommended), create the build directory and chdir there.
36
37 2. Invoke the MSYS-specific configure script:
38
39 - If you are building outside the source tree:
40
41 /PATH/TO/EMACS/SOURCE/TREE/nt/msysconfig.sh --prefix=PREFIX ...
42
43 - If you are building in-place, i.e. inside the source tree:
44
45 ./nt/msysconfig.sh --prefix=PREFIX ...
46
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.
50
51 You can pass other options to the configure script. Here's a
52 typical example (for an in-place debug build):
53
54 CPPFLAGS='-DGLYPH_DEBUG=1' CFLAGS='-O0 -g3' ./nt/msysconfig.sh --prefix=d:/usr/emacs --enable-checking
55
56 3. After the configure script finishes, it should display the
57 resulting configuration. After that, type
58
59 make
60
61 Use "make -j N" if your MSYS Make supports parallel execution;
62 the build will take significantly less time in that case. Here N
63 is the number of simultaneous parallel jobs; use the number of
64 the cores on your system.
65
66 4. Install the produced binaries:
67
68 make install
69
70 If you want the installation tree to go to a place that is
71 different from the one specified by --prefix, say
72
73 make install prefix=/where/ever/you/want
74
75 That's it!
76
77 If these short instructions somehow fail, read the rest of this
78 file.
79
80 * Installing MinGW and MSYS
81
82 Make sure you carefully read the following two sections in their
83 entirety and install/configure the various packages as instructed.
84 A correct installation makes all the rest almost trivial; a botched
85 installation will likely make you miserable for quite some time.
86
87 There are two alternative to installing MinGW + MSYS: using the GUI
88 installer, called mingw-get, provided by the MinGW project, or
89 manual installation. The next two sections describe each one of
90 these.
91
92 ** Installing MinGW and MSYS using mingw-get
93
94 A nice GUI installer, called mingw-get, is available for those who
95 don't like to mess with manual installations. You can download it
96 from here:
97
98 https://sourceforge.net/projects/mingw/files/Installer/mingw-get/
99
100 (This installer only supports packages downloaded from the MinGW
101 site; for the rest you will still need the manual method.)
102
103 After installing mingw-get, invoke it install the packages that are
104 already selected by default on the "Select Components" screen of its
105 wizard.
106
107 After that, use "ming-get install PACKAGE" to install the following
108 additional packages:
109
110 . msys-base
111 . mingw-developer-toolkit
112 . msys-automake
113
114 At this point, you should be ready to configure and build Emacs in
115 its basic configuration. Skip to the "Generating the configure
116 script" section for the build instructions. If you want to build it
117 with image support and other optional libraries, read about the
118 optional libraries near the end of this document, before you start
119 the build.
120
121 ** Installing MinGW and MSYS manually
122
123 *** MinGW
124
125 You will need to install the MinGW port of GCC and Binutils, and the
126 MinGW runtime and Windows API distributions, to compile Emacs. You
127 can find these on the MinGW download/Base page:
128
129 https://sourceforge.net/projects/mingw/files/MinGW/Base/
130
131 In general, install the latest stable versions of the following
132 MinGW packages from that page: gcc, binutils, mingw-rt, w32api. You
133 only need the 'bin' and the 'dll' tarballs of each of the above.
134
135 MinGW packages are distributed as .tar.lzma compressed archives. To
136 install the packages manually, we recommend to use the Windows port
137 of the 'bsdtar' program to unpack the tarballs. 'bsdtar' is
138 available as part of the 'libarchive' package from here:
139
140 http://sourceforge.net/projects/ezwinports/files/
141
142 The recommended place to install these packages is a single tree
143 starting from some directory on a drive other than the system drive
144 C:. A typical example would be D:\usr, with D:\usr\bin holding the
145 binaries and DLLs (should be added to your Path environment
146 variable), D:\usr\include holding the include files, D:\usr\lib
147 holding the static and import libraries, D:\usr\share holding docs,
148 message catalogs, and package-specific subdirectories, etc.
149
150 Having all the headers and libraries in a single place will greatly
151 reduce the number of -I and -L flags you will have to pass to the
152 configure script (see below), as these files will be right where the
153 compiler expects them.
154
155 We specifically do NOT recommend installing packages below
156 "C:\Program Files" or "C:\Program Files (x86)". These directories
157 are protected on versions of Windows from Vista and on, and you will
158 have difficulties updating and maintaining your installation later,
159 due to UAC elevation prompts, file virtualization, etc. You *have*
160 been warned!
161
162 Additional MinGW packages are required/recommended, especially if
163 you are building from the Bazaar repository:
164
165 . Texinfo (needed to produce the Info manuals when building from bzr)
166
167 Available from http://sourceforge.net/projects/ezwinports/files/.
168
169 . gzip (needed to compress files during "make install")
170
171 Available from http://gnuwin32.sourceforge.net/packages/gzip.htm.
172
173 . pkg-config (needed for building with some optional libraries,
174 such as GnuTLS and libxml2)
175
176 Available from http://www.gtk.org/download/win32.php
177
178 Each package might list other packages as prerequisites on its
179 download page (under "Runtime requirements"); download those as
180 well. (Using the GUI installer mingw-get will fetch those
181 prerequisites automatically for you.) A missing prerequisite will
182 manifest itself by the program failing to run and presenting a
183 pop-up dialog that states the missing or incompatible DLL; be sure
184 to find and install these missing DLLs.
185
186 Once you think you have MinGW installed, test the installation by
187 building a trivial "hello, world!" program, and make sure that it
188 builds without any error messages and the binary works when run.
189
190 *** Installing MSYS
191
192 You will also need a reasonably full MSYS installation. MSYS is an
193 environment needed to run the Posix configure scripts and the
194 resulting Makefile's, in order to produce native Windows binaries
195 using the MinGW compiler and runtime libraries. Here's the list of
196 MSYS packages that are required:
197
198 . All the packages from the MSYS Base distribution, listed here:
199
200 https://sourceforge.net/projects/mingw/files/MSYS/Base/
201
202 . Additional packages listed below, from the MSYS Extension
203 distribution here:
204
205 https://sourceforge.net/projects/mingw/files/MSYS/Extension/
206
207 - flex
208 - bison
209 - m4
210 - perl
211 - mktemp
212
213 These should only be needed if you intend to build development
214 versions of Emacs from the Bazaar repository.
215
216 . Additional packages (needed only if building from the Bazaar
217 repository): Automake and Autoconf. They are available from
218 here:
219
220 http://sourceforge.net/projects/ezwinports/files/automake-1.11.6-msys-bin.zip/download
221 http://sourceforge.net/projects/ezwinports/files/autoconf-2.65-msys-bin.zip/download
222
223 MSYS packages are distributed as .tar.lzma compressed archives. To
224 install the packages manually, we recommend to use the Windows port
225 of the 'bsdtar' program, already mentioned above.
226
227 If/when you are confident in your MinGW/MSYS installation, and want
228 to speed up the builds, we recommend installing a pre-release
229 version of Make from here:
230
231 https://sourceforge.net/projects/mingwbuilds/files/external-binary-packages/
232
233 These are snapshot builds of many packages, but you only need
234 make.exe from there. The advantage of this make.exe is that it
235 supports parallel builds, so you can use "make -j N" to considerably
236 speed up your builds
237
238 For each of these packages, install the 'bin' and 'dll' tarballs of
239 their latest stable releases. If there's an 'ext' tarball (e.g.,
240 msysCORE and Coreutils have it), download and install those as well.
241
242 Each package might list other packages as prerequisites on its
243 download page (under "Runtime requirements"); download those as
244 well. (Using the GUI installer mingw-get will fetch those
245 prerequisites automatically for you.) A missing prerequisite will
246 manifest itself by the program failing to run and presenting a
247 pop-up dialog that states the missing or incompatible DLL; be sure
248 to find and install these missing DLLs.
249
250 MSYS packages should be installed in a separate tree from MinGW.
251 For example, use D:\MSYS or D:\usr\MSYS as the top-level directory
252 from which you unpack all of the MSYS packages.
253
254 Do NOT add the MSYS bin directory to your Windows Path! Only the
255 MinGW bin directory should be on Path. When you install MSYS, it
256 creates a shortcut on your desktop that invokes the MSYS Bash shell
257 in a Command Prompt window; that shell is already set up so that the
258 MSYS bin directory is on PATH ahead of any other directory. Thus,
259 Bash will find MSYS executables first, which is exactly what you
260 need.
261
262 At this point, you are ready to build Emacs in its basic
263 configuration. If you want to build it with image support and other
264 optional libraries, read about that near the end of this document.
265
266 * Generating the configure script
267
268 If you are building a release or pretest tarball, skip this section,
269 because the configure script is already present in the tarball.
270
271 To build a development snapshot from the Emacs Bazaar repository,
272 you will first need to generate the configure script and a few other
273 auto-generated files. (If this step, described below, somehow
274 fails, you can use the files in the autogen/ directory instead, but
275 they might be outdated, and, most importantly, you are well advised
276 not to disregard any failures in your local build procedures, as
277 these are likely to be symptoms of incorrect installation that will
278 bite you down the road.)
279
280 To generate the configure script, type this at the MSYS Bash prompt
281 from the top-level directory of the Emacs tree:
282
283 ./autogen.sh
284
285 If successful, this command should produce the following output:
286
287 $ ./autogen.sh
288 Checking whether you have the necessary tools...
289 (Read INSTALL.BZR for more details on building Emacs)
290
291 Checking for autoconf (need at least version 2.65)...
292 ok
293 Checking for automake (need at least version 1.11)...
294 ok
295 Your system has the required tools, running autoreconf...
296 You can now run `./configure'.
297
298 * Configuring Emacs for MinGW:
299
300 Now it's time to run the configure script. You can do that either
301 from a separate build directory that is outside of the Emacs source
302 tree (recommended), or from inside the source tree. The former is
303 recommended because it allows you to have several different builds,
304 e.g., an optimized build and an unoptimized one, of the same
305 revision of the source tree; the source tree will be left in its
306 pristine state, without any build products.
307
308 You invoke the configure script like this:
309
310 /PATH/TO/EMACS/SOURCE/TREE/nt/msysconfig.sh --prefix=PREFIX ...
311
312 or, if you are building in-place, i.e. inside the source tree:
313
314 ./nt/msysconfig.sh --prefix=PREFIX ...
315
316 Here PREFIX is the place where you eventually want to install Emacs
317 once built, e.g. d:/usr.
318
319 You can pass additional options to the configure script, for the
320 full list type
321
322 ./nt/msysconfig.sh --help
323
324 As explained in the help text, you may need to tell the script what
325 are the optional flags to invoke the compiler. This is needed if
326 some of your headers and libraries, e.g., those belonging to
327 optional image libraries, are installed in places where the compiler
328 normally doesn't look for them. (Remember that advice above to
329 avoid such situations? here's is where you will start paying for
330 disregarding that recommendation.) For example, if you have libpng
331 headers in C:\emacs\libs\libpng-1.2.37-lib\include and jpeg library
332 headers in C:\emacs\libs\jpeg-6b-4-lib\include, you will need to say
333 something like this:
334
335 CPPFLAGS='-Ic:/emacs/libs/libpng-1.2.37-lib/include -Ic:/emacs/libs/jpeg-6b-4-lib/include' ./nt/msysconfig.sh --prefix=PREFIX
336
337 which is quite a mouth-full, especially if you have more directories
338 to specify... Perhaps you may wish to revisit your installation
339 decisions now.
340
341 A few frequently used options are needed when you want to produce an
342 unoptimized binary with runtime checks enabled:
343
344 CPPFLAGS='-DGLYPH_DEBUG=1' CFLAGS='-O0 -g3' ./nt/msysconfig.sh --prefix=PREFIX --enable-checking
345
346 Once invoked, the configure script will run for some time, and, if
347 successful, will eventually produce a summary of the configuration
348 like this:
349
350 Configured for `i686-pc-mingw32'.
351
352 Where should the build process find the source code? /path/to/emacs/sources
353 What compiler should emacs be built with? gcc -std=gnu99 -O0 -g3
354 Should Emacs use the GNU version of malloc? yes
355 Should Emacs use a relocating allocator for buffers? yes
356 Should Emacs use mmap(2) for buffer allocation? no
357 What window system should Emacs use? w32
358 What toolkit should Emacs use? none
359 Where do we find X Windows header files? NONE
360 Where do we find X Windows libraries? NONE
361 Does Emacs use -lXaw3d? no
362 Does Emacs use -lXpm? yes
363 Does Emacs use -ljpeg? yes
364 Does Emacs use -ltiff? yes
365 Does Emacs use a gif library? yes
366 Does Emacs use -lpng? yes
367 Does Emacs use -lrsvg-2? no
368 Does Emacs use imagemagick? no
369 Does Emacs use -lgpm? no
370 Does Emacs use -ldbus? no
371 Does Emacs use -lgconf? no
372 Does Emacs use GSettings? no
373 Does Emacs use -lselinux? no
374 Does Emacs use -lgnutls? yes
375 Does Emacs use -lxml2? yes
376 Does Emacs use -lfreetype? no
377 Does Emacs use -lm17n-flt? no
378 Does Emacs use -lotf? no
379 Does Emacs use -lxft? no
380 Does Emacs use toolkit scroll bars? yes
381
382 You are almost there, hang on.
383
384 If the output is significantly different, or if configure finishes
385 prematurely and displays some error message, you should examine the
386 configuration log in config.log and find the reason for the failure.
387
388 Once you succeeded in configuring Emacs, and just want to rebuild it
389 after updating your local repository from the main repository, you
390 don't need to re-run the configure script manually, unless you want
391 to change the configure-time options. Just typing "make" will
392 re-run configure if necessary with the exact same options you
393 specified originally, and then go on to invoking Make, described
394 below.
395
396 * Running Make.
397
398 This is simple: just type "make" and sit back, watching the fun.
399
400 If you installed a snapshot build of Make, the build will be much
401 faster if you type "make -j N" instead, where N is the number of
402 independent processing units on your machine. E.g., on a core i7
403 system try using N of 6 or even 8.
404
405 When Make finishes, you can install the produced binaries:
406
407 make install
408
409 or, if you want the installed tree to go in a place different from
410 the configured one, type
411
412 make install prefix=WHEREVER
413
414 Congrats! You have built and installed your own Emacs!
415
416 * Make targets
417
418 The following make targets may be used by users building the source
419 distribution, or users who have checked out of Bazaar after
420 an initial bootstrapping.
421
422 make
423 Builds Emacs from the available sources and pre-compiled lisp files.
424
425 make install
426 Installs the built programs and the auxiliary files.
427
428 make clean
429 Removes object and executable files produced by the build process in
430 the current configuration. After "make clean", you can rebuild with
431 the same configuration using make. useful when you want to be sure
432 that all of the products are built from coherent sources.
433
434 make distclean
435 In addition to the files removed by make clean, this also removes
436 Makefiles and other generated files to get back to the state of a
437 freshly unpacked source distribution. After make distclean, it is
438 necessary to run the configure script followed by "make", in order
439 to rebuild.
440
441 The following targets are intended only for use with the Bazaar sources.
442
443 make bootstrap
444 Removes all the auto-generated files and all the *.elc byte-compiled
445 files, and builds Emacs from scratch. Useful when some change in
446 basic Emacs functionality makes byte compilation of updated files
447 fail.
448
449 make maintainer-clean
450 Removes everything that can be recreated, including compiled Lisp
451 files, to get back to the state of a fresh Bazaar tree. After make
452 maintainer-clean, it is necessary to run configure and "make" or
453 "make bootstrap" to rebuild. Occasionally it may be necessary to
454 run this target after an update.
455
456 * Optional image library support
457
458 In addition to its "native" image formats (pbm and xbm), Emacs can
459 handle other image types: xpm, tiff, gif, png, jpeg and experimental
460 support for svg.
461
462 To build Emacs with support for them, the corresponding headers must
463 be in the include path when the configure script is run. This is be
464 set up using the CPPFLAGS and CFLAGS variable specified on the
465 configure command line. The configure script will report whether it
466 was able to detect the headers. If the results of this testing
467 appear to be incorrect, please look for details in the file
468 config.log: it will show the failed test programs and compiler error
469 messages that should explain what is wrong. (Usually, any such
470 failures happen because some headers are missing due to bad
471 packaging of the image support libraries.)
472
473 Note that any file path passed to the compiler or linker must use
474 forward slashes, or double each backslash, as that is how Bash
475 works.
476
477 If the configure script finds the necessary headers, but they are
478 for some reason incompatible, or if you want to omit support for
479 some image library that is installed on your system for some other
480 reason, use the --without-PACKAGE option to configure, such as
481 --without-gif to omit GIF, --without-tiff to omit TIFF, etc.
482 Passing the --help option to the configure script displays all of
483 the supported --without-PACKAGE options.
484
485 To use the external image support, the DLLs implementing the
486 functionality must be found when Emacs first needs them, either on the
487 PATH, or in the same directory as emacs.exe. Failure to find a
488 library is not an error; the associated image format will simply be
489 unavailable. Note that once Emacs has determined that a library can
490 not be found, there's no way to force it to try again, other than
491 restarting. See the variable `dynamic-library-alist' to configure the
492 expected names of the libraries.
493
494 Some image libraries have dependencies on one another, or on zlib.
495 For example, tiff support depends on the jpeg library. If you did not
496 compile the libraries yourself, you must make sure that any dependency
497 is in the PATH or otherwise accessible and that the binaries are
498 compatible (for example, that they were built with the same compiler).
499
500 Binaries for the image libraries (among many others) can be found at
501 the GnuWin32 project. PNG, JPEG and TIFF libraries are also
502 included with GTK, which is installed along with other Free Software
503 that requires it. Note specifically that, due to some packaging
504 snafus in the GnuWin32-supplied image libraries, you will need to
505 download _source_ packages for some of the libraries in order to get
506 the header files necessary for building Emacs with image support.
507
508 For PNG images, we recommend to use versions 1.4.x and later of
509 libpng, because previous versions had security issues. You can find
510 precompiled libraries and headers on the GTK download page for
511 Windows (http://www.gtk.org/download/win32.php).
512
513 Versions 1.4.0 and later of libpng are binary incompatible with
514 earlier versions, so Emacs will only look for libpng libraries which
515 are compatible with the version it was compiled against. That
516 version is given by the value of the Lisp variable `libpng-version';
517 e.g., 10403 means version 1.4.3. The variable `dynamic-library-alist'
518 is automatically set to name only those DLL names that are known to
519 be compatible with the version given by `libpng-version'. If PNG
520 support does not work for you even though you have the support DLL
521 installed, check the name of the installed DLL against
522 `dynamic-library-alist' and the value of `libpng-version', and
523 download compatible DLLs if needed.
524
525 * Optional GnuTLS support
526
527 To compile with GnuTLS, you will need pkg-config to be installed, as
528 the configure script invokes pkg-config to find out which compiler
529 switches to use for GnuTLS. See above for the URL where you can
530 find pkg-config for Windows.
531
532 If the configure script finds the gnutls/gnutls.h file in the
533 include path, Emacs is built with GnuTLS support by default; to
534 avoid that you can pass the argument --without-gnutls.
535
536 In order to support GnuTLS at runtime, a GnuTLS-enabled Emacs must
537 be able to find the relevant DLLs during startup; failure to do so
538 is not an error, but GnuTLS won't be available to the running
539 session.
540
541 You can get pre-built binaries (including any required DLL and the
542 header files) at http://sourceforge.net/projects/ezwinports/files/.
543
544 * Optional libxml2 support
545
546 To compile with libxml2, you will need pkg-config to be installed,
547 as the configure script invokes pkg-config to find out which
548 compiler switches to use for libxml2. See above for the URL where
549 you can find pkg-config for Windows.
550
551 If the configure script finds the libxml/HTMLparser.h file in the
552 include path, Emacs is built with libxml2 support by default; to
553 avoid that you can pass the argument --without-libxml2.
554
555 In order to support libxml2 at runtime, a libxml2-enabled Emacs must
556 be able to find the relevant DLLs during startup; failure to do so
557 is not an error, but libxml2 features won't be available to the
558 running session.
559
560 One place where you can get pre-built Windows binaries of libxml2
561 (including any required DLL and the header files) is here:
562
563 http://sourceforge.net/projects/ezwinports/files/
564
565 For runtime support of libxml2, you will also need to install the
566 libiconv "development" tarball, because the libiconv headers need to
567 be available to the compiler when you compile with libxml2 support.
568 A MinGW port of libiconv can be found on the MinGW site:
569
570 http://sourceforge.net/projects/mingw/files/MinGW/Base/libiconv/
571
572 You need the libiconv-X.Y.Z-N-mingw32-dev.tar.lzma tarball from that
573 site.
574
575 * Experimental SVG support
576
577 To compile with SVG, you will need pkg-config to be installed, as
578 the configure script invokes pkg-config to find out which compiler
579 switches to use for SVG. See above for the URL where you can find
580 pkg-config for Windows.
581
582 SVG support is currently experimental, and not built by default.
583 Specify --with-rsvg and ensure you have all the dependencies in your
584 include path. Unless you have built a minimalist librsvg yourself
585 (untested), librsvg depends on a significant chunk of GTK+ to build,
586 plus a few Gnome libraries, libxml2, libbz2 and zlib at runtime. The
587 easiest way to obtain the dependencies required for building is to
588 download a pre-bundled GTK+ development environment for Windows.
589
590 To use librsvg at runtime, ensure that librsvg and its dependencies
591 are on your PATH. If you didn't build librsvg yourself, you will
592 need to check with where you downloaded it from for the
593 dependencies, as there are different build options. If it is a
594 short list, then it most likely only lists the immediate
595 dependencies of librsvg, but the dependencies themselves have
596 dependencies - so don't download individual libraries from GTK+,
597 download and install the whole thing. If you think you've got all
598 the dependencies and SVG support is still not working, check your
599 PATH for other libraries that shadow the ones you downloaded.
600 Libraries of the same name from different sources may not be
601 compatible, this problem was encountered with libbzip2 from GnuWin32
602 with libcroco from gnome.org.
603
604 If you can see etc/images/splash.svg, then you have managed to get
605 SVG support working. Congratulations for making it through DLL hell
606 to this point. You'll probably find that some SVG images crash
607 Emacs. Problems have been observed in some images that contain
608 text, they seem to be a problem in the Windows port of Pango, or
609 maybe a problem with the way Cairo or librsvg is using it that
610 doesn't show up on other platforms.
611
612 \f
613 This file is part of GNU Emacs.
614
615 GNU Emacs is free software: you can redistribute it and/or modify
616 it under the terms of the GNU General Public License as published by
617 the Free Software Foundation, either version 3 of the License, or
618 (at your option) any later version.
619
620 GNU Emacs is distributed in the hope that it will be useful,
621 but WITHOUT ANY WARRANTY; without even the implied warranty of
622 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
623 GNU General Public License for more details.
624
625 You should have received a copy of the GNU General Public License
626 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.