INSTALL 36.1 KB
Newer Older
1 2
		    Building and Installing Emacs on MS-Windows
                          using the MSYS and MinGW tools
Dave Love's avatar
#  
Dave Love committed
3

Paul Eggert's avatar
Paul Eggert committed
4
  Copyright (C) 2013-2020 Free Software Foundation, Inc.
5
  See the end of the file for license conditions.
Andrew Innes's avatar
Andrew Innes committed
6

7
The MSYS/MinGW build described here is supported on versions of
8 9 10
Windows starting with Windows XP and newer.  Building on Windows 2000
and Windows 9X is not supported (but the Emacs binary produced by this
build will run on Windows 9X and newer systems).
11

Eli Zaretskii's avatar
Eli Zaretskii committed
12 13 14
  Do not use this recipe with Cygwin.  For building on Cygwin, use the
  normal installation instructions, ../INSTALL.

15 16 17
  For building Emacs using the MinGW64/MSYS2 toolchain, see the
  instructions in the file INSTALL.W64 in this directory.

18
* For the brave (a.k.a. "impatient"):
19

20 21 22
  For those who have a working MSYS/MinGW development environment and
  are comfortable with running Posix configure scripts, here are the
  concise instructions for configuring and building the native Windows
Eli Zaretskii's avatar
Eli Zaretskii committed
23
  binary of Emacs with these tools:
24

25 26
  0. Start the MSYS Bash window.  Everything else below is done from
     that window's Bash prompt.
27

28 29 30
  0a. If you are building from the development trunk (as opposed to a
      release tarball), produce the configure script, by typing from
      the top-level Emacs source directory:
31

32
      ./autogen.sh
33

34 35
  1. If you want to build Emacs outside of the source tree
     (recommended), create the build directory and chdir there.
36

Dani Moncayo's avatar
Dani Moncayo committed
37
  2. Invoke the configure script:
38

39
      - If you are building outside the source tree:
40

Dani Moncayo's avatar
Dani Moncayo committed
41
        /PATH/TO/EMACS/SOURCE/TREE/configure --prefix=PREFIX ...
42

43
      - If you are building in-place, i.e. inside the source tree:
44

Dani Moncayo's avatar
Dani Moncayo committed
45
        ./configure --prefix=PREFIX ...
46

47 48 49
     It is always preferable to use --prefix to configure Emacs for
     some specific location of its installed tree; the default
     /usr/local is not suitable for Windows (see the detailed
50
     instructions for the reasons).  The prefix must be absolute.
51

52 53
     You can pass other options to the configure script.  Here's a
     typical example (for an in-place debug build):
54

55 56
       ./configure --prefix=/d/usr/emacs --enable-checking='yes,glyphs' \
         CFLAGS='-O0 -g3'
57

58 59
  3. After the configure script finishes, it should display the
     resulting configuration.  After that, type
60

61
       make
62

63 64 65 66
     Use "make -j N" if your MSYS Make supports parallel execution;
     the build will take significantly less time in that case.  Here N
     is the number of simultaneous parallel jobs; use the number of
     the cores on your system.
67

68
  4. Install the produced binaries:
69

70
       make install
71

72 73
     If you want the installation tree to go to a place that is
     different from the one specified by --prefix, say
74

75
       make install prefix=/where/ever/you/want
76

77
  That's it!
78

79 80
  If these short instructions somehow fail, read the rest of this
  file.
81

82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
* Installing Git for Windows

  Skip this section if you already have Git installed and configured,
  or if you are building from the release tarball, not from the
  development repository.

  Git for Windows is available from this download page:

    https://github.com/git-for-windows/git/releases

  That page offers both 32-bit and 64-bit installations; pick the one
  suitable for your OS.  In general, we recommend to install a 64-bit
  Git if you have a 64-bit Windows system; the 32-bit Git will run on
  64-bit Windows just fine, but might run into memory problems where
  the 64-bit Git won't.

  During Git installation, be sure to select the "Checkout as-is,
  commit as-is" option from the "Configure line ending conversions"
  dialog.  Otherwise, Git will convert text files to DOS-style CRLF
  end-of-line (EOL) format, which will cause subtle problems when
  building Emacs, because MSYS tools (see below) used to build Emacs
  use binary file I/O that preserves the CR characters that get in the
  way of some text-processing tools, like 'makeinfo' and the commands
  invoked by the autogen.sh script.

  If you already have Git installed and configured with some other EOL
  conversion option, you will need to reconfigure it, removing the
  following variables from all of your .gitconfig files:

    core.eol
    core.safecrlf
    core.autocrlf

  If you cloned the Emacs directory before changing these config
  variables, you will have to delete the repository and re-clone it
  after the change.

  The instructions for cloning the Emacs repository can be found on
  the Emacs's Savannah project page:

    https://savannah.gnu.org/projects/emacs

124
* Installing MinGW and MSYS
125

126 127 128 129
  Make sure you carefully read the following two sections in their
  entirety and install/configure the various packages as instructed.
  A correct installation makes all the rest almost trivial; a botched
  installation will likely make you miserable for quite some time.
130

Eli Zaretskii's avatar
Eli Zaretskii committed
131
  There are two alternatives to installing MinGW + MSYS: using the GUI
132 133 134
  installer, called mingw-get, provided by the MinGW project, or
  manual installation.  The next two sections describe each one of
  these.
135

136
** Installing MinGW and MSYS using mingw-get
137

138 139 140
  A nice installer, called mingw-get, is available for those who don't
  like to mess with manual installations.  You can download it from
  here:
141

142
    https://sourceforge.net/projects/mingw/files/Installer/mingw-get/
143

144 145
  (This installer only supports packages downloaded from the MinGW
  site; for the rest you will still need the manual method.)
146

147 148 149
  After installing mingw-get, invoke it to install the packages that
  are already selected by default on the "Select Components" screen of
  its wizard.
150

151 152
  After that, use "mingw-get install PACKAGE" to install the following
  additional packages:
153

154 155
   . msys-base
   . mingw-developer-toolkit
156

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
  When the installation ends, perform the post-installation steps
  described on this page of the MinGW site:

    http://www.mingw.org/wiki/Getting_Started

  in the "After Installing You Should ..." section.  These steps are
  important for making your installation complete, and in particular
  will produce a desktop shortcut for running the MSYS Bash shell,
  from which you will configure and build Emacs.  Once you've made the
  shortcut, double-click on it to open the MSYS Bash shell window,
  where you will proceed with the rest of these instructions.

  In addition, we suggest to modify your system-wide Path variable to
  include the 'bin' subdirectory of your top-level MinGW installation
  directory, the one you specified to mingw-get ("C:\MinGW" by
  default).  This will allow you to invoke the MinGW development
  tools, like GCC, from the Windows cmd.exe shell windows or from
  other Windows programs (including Emacs, after you build and install
  it).

177 178 179 180 181
  (We recommend that you refrain from installing the MSYS Texinfo
  package, which is part of msys-base, because it might produce mixed
  EOL format when installing Info files.  Instead, install the MinGW
  port of Texinfo, see the ezwinports URL below.  To uninstall the
  MSYS Texinfo, after installing it as part of msys-base, invoke the
182 183
  command "mingw-get remove msys-texinfo", or mark "msys-texinfo" for
  removal in the mingw-get GUI, then select Installation->Apply Changes.)
184

185
  (Similarly, we recommend to refrain from installing the MinGW
186 187
  Autoconf package; instead, install its MSYS build available from the
  ezwinports site, see below.)
188

189 190 191 192 193 194 195
  At this point, you should be ready to configure and build Emacs in
  its basic configuration.  Skip to the "Generating the configure
  script" section for the build instructions.  If you want to build it
  with image support and other optional libraries, read about the
  optional libraries near the end of this document, before you start
  the build.  Also, consider installing additional MinGW packages that
  are required/recommended, especially if you are building from the
196
  development repository, as described in the next section.
197

198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
** Installing MinGW and MSYS manually

*** MinGW

  You will need to install the MinGW port of GCC and Binutils, and the
  MinGW runtime and Windows API distributions, to compile Emacs.  You
  can find these on the MinGW download/Base page:

    https://sourceforge.net/projects/mingw/files/MinGW/Base/

  In general, install the latest stable versions of the following
  MinGW packages from that page: gcc, binutils, mingw-rt, w32api.  You
  only need the 'bin' and the 'dll' tarballs of each of the above.

  MinGW packages are distributed as .tar.lzma compressed archives.  To
  install the packages manually, we recommend to use the Windows port
  of the 'bsdtar' program to unpack the tarballs.  'bsdtar' is
  available as part of the 'libarchive' package from here:
Eli Zaretskii's avatar
Eli Zaretskii committed
216

Eli Zaretskii's avatar
Eli Zaretskii committed
217 218
    http://sourceforge.net/projects/ezwinports/files/

219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
  The recommended place to install these packages is a single tree
  starting from some directory on a drive other than the system drive
  C:.  A typical example would be D:\usr, with D:\usr\bin holding the
  binaries and DLLs (should be added to your Path environment
  variable), D:\usr\include holding the include files, D:\usr\lib
  holding the static and import libraries, D:\usr\share holding docs,
  message catalogs, and package-specific subdirectories, etc.

  Having all the headers and libraries in a single place will greatly
  reduce the number of -I and -L flags you will have to pass to the
  configure script (see below), as these files will be right where the
  compiler expects them.

  We specifically do NOT recommend installing packages below
  "C:\Program Files" or "C:\Program Files (x86)".  These directories
  are protected on versions of Windows from Vista and on, and you will
  have difficulties updating and maintaining your installation later,
  due to UAC elevation prompts, file virtualization, etc.  You *have*
  been warned!

  Additional MinGW packages are required/recommended, especially if
240
  you are building from the development repository:
241 242

   . Texinfo (needed to produce the Info manuals when building from
243
     the repository, and for "make install")
244 245 246

     Available from http://sourceforge.net/projects/ezwinports/files/.

247
   . pkg-config (invoked by the configure script to look for optional
248
     packages)
249

250
     Available from http://sourceforge.net/projects/ezwinports/files/.
251

252
   . gzip (needed to compress files during "make install")
253

254
     Available from http://gnuwin32.sourceforge.net/packages/gzip.htm.
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291

  Each package might list other packages as prerequisites on its
  download page (under "Runtime requirements"); download those as
  well.  (Using the mingw-get installer will fetch those prerequisites
  automatically for you.)  A missing prerequisite will manifest itself
  by the program failing to run and presenting a pop-up dialog that
  states the missing or incompatible DLL; be sure to find and install
  these missing DLLs.

  Once you think you have MinGW installed, test the installation by
  building a trivial "hello, world!" program, and make sure that it
  builds without any error messages and the binary works when run.

*** MSYS

  You will need a reasonably full MSYS installation.  MSYS is an
  environment needed to run the Posix configure scripts and the
  resulting Makefile's, in order to produce native Windows binaries
  using the MinGW compiler and runtime libraries.  Here's the list of
  MSYS packages that are required:

   . All the packages from the MSYS Base distribution, listed here:

     https://sourceforge.net/projects/mingw/files/MSYS/Base/

   . Additional packages listed below, from the MSYS Extension
     distribution here:

     https://sourceforge.net/projects/mingw/files/MSYS/Extension/

      - flex
      - bison
      - m4
      - perl
      - mktemp

     These should only be needed if you intend to build development
292
     versions of Emacs from the repository.
293

294 295
   . Additional package (needed only if building from the repository):
     Autoconf.  It is available from here:
296 297 298 299 300 301 302

       http://sourceforge.net/projects/ezwinports/files/autoconf-2.65-msys-bin.zip/download

  MSYS packages are distributed as .tar.lzma compressed archives.  To
  install the packages manually, we recommend to use the Windows port
  of the 'bsdtar' program, already mentioned above.

303 304 305 306
  MSYS packages should be installed in a separate tree from MinGW.
  For example, use D:\MSYS or D:\usr\MSYS as the top-level directory
  from which you unpack all of the MSYS packages.

307 308 309 310
  After installing Autoconf, make sure any of the *.m4 files you might
  have in your MinGW installation also exist in the MSYS installation
  tree, in the share/aclocal directory.  Those *.m4 files which exist
  in the MinGW tree, but not in the MSYS tree should be copied there.
311

312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
  If/when you are confident in your MinGW/MSYS installation, and want
  to speed up the builds, we recommend installing a pre-release
  version of Make from here:

     https://sourceforge.net/projects/mingwbuilds/files/external-binary-packages/

  These are snapshot builds of many packages, but you only need
  make.exe from there.  The advantage of this make.exe is that it
  supports parallel builds, so you can use "make -j N" to considerably
  speed up your builds.

  Several users reported that MSYS 1.0.18 causes Make to hang in
  parallel builds.  If you bump into this, we suggest to downgrade to
  MSYS 1.0.17, which doesn't have that problem.

  For each of these packages, install the 'bin' and 'dll' tarballs of
  their latest stable releases.  If there's an 'ext' tarball (e.g.,
  msysCORE and Coreutils have it), download and install those as well.

  Each package might list other packages as prerequisites on its
  download page (under "Runtime requirements"); download those as
  well.  (Using the mingw-get installer will fetch those prerequisites
  automatically for you.)  A missing prerequisite will manifest itself
  by the program failing to run and presenting a pop-up dialog that
  states the missing or incompatible DLL; be sure to find and install
  these missing DLLs.

  Do NOT add the MSYS bin directory to your Windows Path!  Only the
  MinGW bin directory should be on Path.  When you install MSYS, it
  creates a shortcut on your desktop that invokes the MSYS Bash shell
  in a Command Prompt window; that shell is already set up so that the
  MSYS bin directory is on PATH ahead of any other directory.  Thus,
  Bash will find MSYS executables first, which is exactly what you
  need.

347 348 349 350 351 352 353 354 355 356 357 358 359
* Starting the MSYS Bash shell

  For most reliable and predictable results, we recommend to start
  Bash by clicking the "MSYS" icon on your desktop.  That icon is
  created when you install MSYS, and using it is the official way of
  running the MSYS tools.

  For other methods of starting the shell, make sure Bash is invoked
  with the "--login" command-line switch.

  When the shell window opens and you get the shell prompt, change to
  the directory where you intend to build Emacs.

360 361 362 363 364 365 366 367 368
  At this point, you are ready to build Emacs in its basic
  configuration.  If you want to build it with image support and other
  optional libraries, read about that near the end of this document.

* Generating the configure script

  If you are building a release or pretest tarball, skip this section,
  because the configure script is already present in the tarball.

369
  To build a development snapshot from the Emacs repository,
370
  you will first need to generate the configure script and a few other
Glenn Morris's avatar
Glenn Morris committed
371
  auto-generated files.
372 373

  To generate the configure script, type this at the MSYS Bash prompt
374
  from the top-level directory of the Emacs source tree:
375 376 377 378 379 380 381

     ./autogen.sh

  If successful, this command should produce the following output:

     $ ./autogen.sh
     Checking whether you have the necessary tools...
382
     (Read INSTALL.REPO for more details on building Emacs)
383 384 385 386
     Checking for autoconf (need at least version 2.65) ... ok
     Your system has the required tools.
     Building aclocal.m4 ...
     Running 'autoreconf -fi -I m4' ...
387
     You can now run './configure'.
388

389 390
  If the script fails because it cannot find Git, you will need to
  arrange for the MSYS Bash's PATH to include the Git's 'bin'
391
  subdirectory, where there's the git.exe executable.
392

393 394 395 396 397 398 399 400 401 402 403 404
* Configuring Emacs for MinGW:

  Now it's time to run the configure script.  You can do that either
  from a separate build directory that is outside of the Emacs source
  tree (recommended), or from inside the source tree.  The former is
  recommended because it allows you to have several different builds,
  e.g., an optimized build and an unoptimized one, of the same
  revision of the source tree; the source tree will be left in its
  pristine state, without any build products.

  You invoke the configure script like this:

Dani Moncayo's avatar
Dani Moncayo committed
405
     /PATH/TO/EMACS/SOURCE/TREE/configure --prefix=PREFIX ...
406 407 408

  or, if you are building in-place, i.e. inside the source tree:

Dani Moncayo's avatar
Dani Moncayo committed
409
     ./configure --prefix=PREFIX ...
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428

  Here PREFIX is the place where you eventually want to install Emacs
  once built, e.g. /d/usr.  We recommend to always use --prefix when
  building Emacs on Windows, because the default '/usr/local' is not
  appropriate for Windows: it will be mapped by MSYS to something like
  C:\MSYS\local, and it will defeat the purpose of PREFIX, which is to
  install programs in a single coherent tree resembling Posix systems.
  Such a single-tree installation makes sure all the other programs
  and packages ported from GNU or Unix systems will work seamlessly
  together.  Where exactly is the root of that tree on your system is
  something only you, the user who builds Emacs, can know, and the
  Emacs build process cannot guess, because usually there's no
  '/usr/local' directory on any drive on Windows systems.

  Do NOT use Windows-style x:/foo/bar file names on the configure
  script command line; use the MSYS-style /x/foo/bar instead.  Using
  Windows-style file names was reported to cause subtle and hard to
  figure out problems during the build.  This applies both to the
  command switches, such as --prefix=, and to the absolute file name
Dani Moncayo's avatar
Dani Moncayo committed
429
  of 'configure', if you are building outside of the source tree.
430 431 432 433

  You can pass additional options to the configure script, for the
  full list type

Dani Moncayo's avatar
Dani Moncayo committed
434
     ./configure --help
435 436 437 438 439 440 441 442 443 444 445 446

  As explained in the help text, you may need to tell the script what
  are the optional flags to invoke the compiler.  This is needed if
  some of your headers and libraries, e.g., those belonging to
  optional image libraries, are installed in places where the compiler
  normally doesn't look for them.  (Remember that advice above to
  avoid such situations? here's is where you will start paying for
  disregarding that recommendation.)  For example, if you have libpng
  headers in C:\emacs\libs\libpng-1.2.37-lib\include and jpeg library
  headers in C:\emacs\libs\jpeg-6b-4-lib\include, you will need to say
  something like this:

Dani Moncayo's avatar
Dani Moncayo committed
447
    CPPFLAGS='-I/c/emacs/libs/libpng-1.2.37-lib/include -I/c/emacs/libs/jpeg-6b-4-lib/include' ./configure --prefix=PREFIX
448 449 450 451 452 453 454

  which is quite a mouth-full, especially if you have more directories
  to specify...  Perhaps you may wish to revisit your installation
  decisions now.

  If you have a global site-lisp directory from previous Emacs
  installation, and you want Emacs to continue using it, specify it
Dani Moncayo's avatar
Dani Moncayo committed
455
  via the --enable-locallisppath switch to 'configure', like this:
456

Dani Moncayo's avatar
Dani Moncayo committed
457
   ./configure --prefix=PREFIX --enable-locallisppath="/d/usr/share/emacs/VERSION/site-lisp:/d/wherever/site-lisp"
458 459 460 461 462 463 464

  Use the normal MSYS /d/foo/bar style to specify directories by their
  absolute file names.

  A few frequently used options are needed when you want to produce an
  unoptimized binary with runtime checks enabled:

465 466
     ./configure --prefix=PREFIX --enable-checking='yes,glyphs' \
       CFLAGS='-O0 -g3'
467 468 469

  Once invoked, the configure script will run for some time, and, if
  successful, will eventually produce a summary of the configuration
Eli Zaretskii's avatar
Eli Zaretskii committed
470
  similar to this:
471

472
     Configured for 'i686-pc-mingw32'.
473 474 475

       Where should the build process find the source code?    /path/to/emacs/sources
       What compiler should emacs be built with?               gcc  -std=gnu99 -O0 -g3
476 477 478 479
       Should Emacs use the GNU version of malloc?             no
	 (The GNU allocators don't work with this system configuration.)
       Should Emacs use a relocating allocator for buffers?    no
       Should Emacs use mmap(2) for buffer allocation?         yes
480 481 482 483 484 485 486 487 488
       What window system should Emacs use?                    w32
       What toolkit should Emacs use?                          none
       Where do we find X Windows header files?                NONE
       Where do we find X Windows libraries?                   NONE
       Does Emacs use -lXaw3d?                                 no
       Does Emacs use -lXpm?                                   yes
       Does Emacs use -ljpeg?                                  yes
       Does Emacs use -ltiff?                                  yes
       Does Emacs use a gif library?                           yes
489 490
       Does Emacs use a png library?                           yes
       Does Emacs use -lrsvg-2?                                yes
491 492
       Does Emacs use cairo?                                   no
       Does Emacs use -llcms2?                                 yes
493
       Does Emacs use imagemagick?                             no
494
       Does Emacs support sound?                               no
495 496 497 498
       Does Emacs use -lgpm?                                   no
       Does Emacs use -ldbus?                                  no
       Does Emacs use -lgconf?                                 no
       Does Emacs use GSettings?                               no
499 500
       Does Emacs use a file notification library?             yes (w32)
       Does Emacs use access control lists?                    yes
501 502 503 504 505 506 507
       Does Emacs use -lselinux?                               no
       Does Emacs use -lgnutls?                                yes
       Does Emacs use -lxml2?                                  yes
       Does Emacs use -lfreetype?                              no
       Does Emacs use -lm17n-flt?                              no
       Does Emacs use -lotf?                                   no
       Does Emacs use -lxft?                                   no
508
       Does Emacs directly use zlib?                           yes
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
       Does Emacs use toolkit scroll bars?                     yes

  You are almost there, hang on.

  If the output is significantly different, or if configure finishes
  prematurely and displays some error message, you should examine the
  configuration log in config.log and find the reason for the failure.

  Once you succeeded in configuring Emacs, and just want to rebuild it
  after updating your local repository from the main repository, you
  don't need to re-run the configure script manually, unless you want
  to change the configure-time options.  Just typing "make" will
  re-run configure if necessary with the exact same options you
  specified originally, and then go on to invoking Make, described
  below.

* Running Make.

  This is simple: just type "make" and sit back, watching the fun.

  If you  installed a snapshot build  of Make, the build  will be much
  faster if  you type "make  -j N" instead, where  N is the  number of
  independent processing  units on your  machine.  E.g., on a  core i7
  system try using  N of 6 or  even 8.  (If this hangs,  see the notes
  above about downgrading to MSYS 1.0.17.)

  When Make finishes, you can install the produced binaries:

    make install

  or, if you want the installed tree to go in a place different from
  the configured one, type

    make install prefix=WHEREVER

  Congrats!  You have built and installed your own Emacs!

* Make targets

  The following make targets may be used by users building the source
549
  distribution, or users who have checked out of the repository after
550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
  an initial bootstrapping.

  make
  Builds Emacs from the available sources and pre-compiled lisp files.

  make install
  Installs the built programs and the auxiliary files.

  make clean
  Removes object and executable files produced by the build process in
  the current configuration.  After "make clean", you can rebuild with
  the same configuration using make.  useful when you want to be sure
  that all of the products are built from coherent sources.

  make distclean
  In addition to the files removed by make clean, this also removes
  Makefiles and other generated files to get back to the state of a
  freshly unpacked source distribution.  After make distclean, it is
  necessary to run the configure script followed by "make", in order
  to rebuild.

571 572
  The following targets are intended only for use with the repository
  sources.
573 574 575 576 577 578 579 580 581

  make bootstrap
  Removes all the auto-generated files and all the *.elc byte-compiled
  files, and builds Emacs from scratch.  Useful when some change in
  basic Emacs functionality makes byte compilation of updated files
  fail.

  make maintainer-clean
  Removes everything that can be recreated, including compiled Lisp
582
  files, to get back to the state of a fresh repository tree.  After make
583 584 585
  maintainer-clean, it is necessary to run configure and "make" or
  "make bootstrap" to rebuild.  Occasionally it may be necessary to
  run this target after an update.
586

Jason Rumney's avatar
Jason Rumney committed
587 588
* Optional image library support

589
  In addition to its "native" image formats (pbm and xbm), Emacs can
590
  handle other image types: xpm, tiff, gif, png, jpeg and experimental
591
  support for svg.
592

593
  To build Emacs with support for them, the corresponding headers must
594 595 596 597 598 599
  be in the include path and libraries should be where the linker
  looks for them, when the configure script is run.  If needed, this
  can be set up using the CPPFLAGS and CFLAGS variable specified on
  the configure command line.  The configure script will report
  whether it was able to detect the headers and libraries.  If the
  results of this testing appear to be incorrect, please look for
600 601 602 603
  details in the file config.log: it will show the failed test
  programs and compiler error messages that should explain what is
  wrong.  (Usually, any such failures happen because some headers are
  missing due to bad packaging of the image support libraries.)
Jason Rumney's avatar
Jason Rumney committed
604

605
  Note that any file path passed to the compiler or linker must use
606 607 608 609 610 611 612 613 614 615
  forward slashes, or double each backslash, as that is how Bash
  works.

  If the configure script finds the necessary headers and libraries,
  but they are for some reason incompatible, or if you want to omit
  support for some image library that is installed on your system for
  some other reason, use the --without-PACKAGE option to configure,
  such as --without-gif to omit GIF, --without-tiff to omit TIFF, etc.
  Passing the --help option to the configure script displays all of
  the supported --without-PACKAGE options.
616

617
  To use the external image support, the DLLs implementing the
618 619 620 621 622
  functionality must be found when Emacs first needs them, either on the
  PATH, or in the same directory as emacs.exe.  Failure to find a
  library is not an error; the associated image format will simply be
  unavailable.  Note that once Emacs has determined that a library can
  not be found, there's no way to force it to try again, other than
623
  restarting.  See the variable `dynamic-library-alist' to configure the
624
  expected names of the libraries.
625 626 627 628

  Some image libraries have dependencies on one another, or on zlib.
  For example, tiff support depends on the jpeg library.  If you did not
  compile the libraries yourself, you must make sure that any dependency
Jason Rumney's avatar
Jason Rumney committed
629
  is in the PATH or otherwise accessible and that the binaries are
630 631
  compatible (for example, that they were built with the same compiler).

632
  To support XPM images (required for color tool-bar icons), you will
633
  need the libXpm library.  It is available from the ezwinports site,
634
  http://sourceforge.net/projects/ezwinports/files/ and from
Paul Eggert's avatar
Paul Eggert committed
635
  https://ftp.gnu.org/gnu/emacs/windows/.
636

637 638
  For PNG images, we recommend to use versions 1.4.x and later of
  libpng, because previous versions had security issues.  You can find
639
  precompiled libraries and headers on the ezwinports site and on
640
  ftp.gnu.org.
641 642 643 644 645

  Versions 1.4.0 and later of libpng are binary incompatible with
  earlier versions, so Emacs will only look for libpng libraries which
  are compatible with the version it was compiled against.  That
  version is given by the value of the Lisp variable `libpng-version';
646
  e.g., 10403 means version 1.4.3.  The variable `dynamic-library-alist'
647 648 649 650
  is automatically set to name only those DLL names that are known to
  be compatible with the version given by `libpng-version'.  If PNG
  support does not work for you even though you have the support DLL
  installed, check the name of the installed DLL against
651
  `dynamic-library-alist' and the value of `libpng-version', and
652 653
  download compatible DLLs if needed.

654 655 656
  For GIF images, we recommend to use versions 5.0.0 or later of
  giflib, as it is much enhanced wrt previous versions.  You can find
  precompiled binaries and headers for giflib on the ezwinports site,
657
  http://sourceforge.net/projects/ezwinports/files/ and on
Paul Eggert's avatar
Paul Eggert committed
658
  https://ftp.gnu.org/gnu/emacs/windows/.
659 660 661 662 663 664 665 666 667 668 669

  Version 5.0.0 and later of giflib are binary incompatible with
  previous versions (the signatures of several functions have
  changed), so Emacs will only look for giflib libraries that are
  compatible with the version it was compiled against.  Similar to
  libpng, that version is given by the value of the Lisp variable
  `libgif-version'; e.g., 50005 means version 5.0.5.  The variable
  `dynamic-library-alist' is automatically set to name only those DLL
  libraries that are known to be compatible with the version given by
  `libgif-version'.

670 671
  For JPEG images, you will need libjpeg 6b or later, which will be
  called libjpeg-N.dll, jpeg62.dll, libjpeg.dll, or jpeg.dll.  You can
672
  find these on the ezwinports site and on ftp.gnu.org.
673 674 675 676 677

  TIFF images require libTIFF 3.0 or later, which will be called
  libtiffN.dll or libtiff-N.dll or libtiff.dll.  These can be found on
  the ezwinports site.

678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
  Pre-built versions of librsvg and its dependencies can be found
  here:

    http://sourceforge.net/projects/ezwinports/files/

    This site includes a minimal (as much as possible for librsvg)
    build of the library and its dependencies; it is also more
    up-to-date with the latest upstream versions.  However, it
    currently only offers 32-bit builds.  For building Emacs, you need
    to download from this site all of the following *-bin.zip
    archives:

      librsvg, gdk-pixbuf, cairo, glib

    The 'bin' archives on this site include both header files and the
    libraries needed for building with librsvg and for running Emacs.
    The librsvg archive includes all the shared libraries needed to
    run Emacs with SVG support; the other 3 packages are required
    because the compiler needs to see their header files when building
    Emacs.
698

Paul Eggert's avatar
Paul Eggert committed
699
    https://ftp.gnu.org/gnu/emacs/windows/
700 701 702

    More fat ports, from the MSYS2 project.

703 704 705 706
  To use librsvg at runtime, ensure that librsvg and its dependencies
  are on your PATH, or in the same directory as the emacs.exe binary.
  If you are downloading from the ezwinports site, you only need to
  install a single archive, librsvg-X.Y.Z-w32-bin.zip, which includes
707
  all the dependency DLLs.
708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735

  If you think you've got all the dependencies and SVG support is
  still not working, check your PATH for other libraries that shadow
  the ones you downloaded.  Libraries of the same name from different
  sources may not be compatible, this problem was encountered in the
  past, e.g., with libcroco from gnome.org.

  If you can see etc/images/splash.svg, then you have managed to get
  SVG support working.  Congratulations for making it through DLL hell
  to this point.  For some SVG images, you'll probably see error
  messages from Glib about failed assertions, or warnings from Pango
  about failure to load fonts (installing the missing fonts should fix
  the latter kind of problems).  Problems have been observed in some
  images that contain text, they seem to be a problem in the Windows
  port of Pango, or maybe a problem with the way Cairo or librsvg is
  using it that doesn't show up on other platforms.  However, Emacs
  should not crash due to these issues.  If you eventually find the
  SVG support too unstable to your taste, you can rebuild Emacs
  without it by specifying the --without-rsvg switch to the configure
  script.

  Binaries for the other image libraries can be found on the
  ezwinports site or at the GnuWin32 project (the latter are generally
  very old, so not recommended).  Note specifically that, due to some
  packaging snafus in the GnuWin32-supplied image libraries, you will
  need to download _source_ packages for some of the libraries in
  order to get the header files necessary for building Emacs with
  image support.
736

Ted Zlatanov's avatar
Ted Zlatanov committed
737 738
* Optional GnuTLS support

739 740 741 742 743 744 745 746 747 748 749 750 751
  To compile with GnuTLS, you will need pkg-config to be installed, as
  the configure script invokes pkg-config to find out which compiler
  switches to use for GnuTLS.  See above for the URL where you can
  find pkg-config for Windows.

  You will also need to install the p11-kit package, which is a
  dependency of GnuTLS, and its header files are needed for
  compilation of programs that use GnuTLS.  You can find p11-kit on
  the same site as GnuTLS, see the URL below.

  If the configure script finds the GnuTLS header files and libraries
  on your system, Emacs is built with GnuTLS support by default; to
  avoid that you can pass the argument --without-gnutls.
Ted Zlatanov's avatar
Ted Zlatanov committed
752

753 754 755 756 757 758
  In order to support GnuTLS at runtime, a GnuTLS-enabled Emacs must
  be able to find the relevant DLLs during startup; failure to do so
  is not an error, but GnuTLS won't be available to the running
  session.

  You can get pre-built binaries (including any required DLL and the
759
  header files) at http://sourceforge.net/projects/ezwinports/files/
Paul Eggert's avatar
Paul Eggert committed
760
  and on https://ftp.gnu.org/gnu/emacs/windows/.
Ted Zlatanov's avatar
Ted Zlatanov committed
761

762 763
* Optional libxml2 support

764 765 766 767 768 769 770 771
  To compile with libxml2, you will need pkg-config to be installed,
  as the configure script invokes pkg-config to find out which
  compiler switches to use for libxml2.  See above for the URL where
  you can find pkg-config for Windows.

  If the configure script finds the libxml2 header files and libraries
  on your system, Emacs is built with libxml2 support by default; to
  avoid that you can pass the argument --without-libxml2.
772 773 774 775 776 777 778 779 780 781

  In order to support libxml2 at runtime, a libxml2-enabled Emacs must
  be able to find the relevant DLLs during startup; failure to do so
  is not an error, but libxml2 features won't be available to the
  running session.

  One place where you can get pre-built Windows binaries of libxml2
  (including any required DLL and the header files) is here:

     http://sourceforge.net/projects/ezwinports/files/
Paul Eggert's avatar
Paul Eggert committed
782
     https://ftp.gnu.org/gnu/emacs/windows/
783

784 785 786 787
  For runtime support of libxml2, you will also need to install the
  libiconv "development" tarball, because the libiconv headers need to
  be available to the compiler when you compile with libxml2 support.
  A MinGW port of libiconv can be found on the MinGW site:
788 789 790 791 792 793

   http://sourceforge.net/projects/mingw/files/MinGW/Base/libiconv/

  You need the libiconv-X.Y.Z-N-mingw32-dev.tar.lzma tarball from that
  site.

794 795 796 797
* Optional support for decompressing text

  Emacs can decompress text if compiled with the zlib library.
  Prebuilt binaries of zlib DLL (for 32-bit builds of Emacs) are
798
  available from the ezwinports site and on ftp.gnu.org; see above for
799
  the URLs.
800 801 802 803

  (This library is also a prerequisite for several image libraries, so
  you may already have it; look for zlib1.dll or libz-1.dll.)

804 805 806 807 808 809 810
* Optional support for lcms2 library

  Emacs can expose some capabilities of the Little CMS color
  management engine to Lisp programs using the lcms2 library.
  Prebuilt binaries of lcms2 DLL (for 32-bit builds of Emacs) are
  available from the ezwinports site and from the MSYS2 project.

811 812 813 814 815 816 817
* Optional support for JSON

  Emacs can provide built-in support for JSON parsing and
  serialization using the libjansson library.  Prebuilt binaries of
  the libjansson DLL (for 32-bit builds of Emacs) are available from
  the ezwinports site and from the MSYS2 project.

818 819

This file is part of GNU Emacs.
Andrew Innes's avatar
Andrew Innes committed
820

821
GNU Emacs is free software: you can redistribute it and/or modify
822
it under the terms of the GNU General Public License as published by
823 824
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Andrew Innes's avatar
Andrew Innes committed
825

826 827 828 829 830 831
GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
Paul Eggert's avatar
Paul Eggert committed
832
along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.