GNU Emacs Installation Guide
-Copyright (C) 1992, 1994, 1996-1997, 2000-2013
- Free Software Foundation, Inc.
+Copyright (C) 1992, 1994, 1996-1997, 2000-2014 Free Software Foundation, Inc.
See the end of the file for license conditions.
This file contains general information on building GNU Emacs.
For more information specific to the MS-Windows, GNUstep/Mac OS X, and
MS-DOS ports, also read the files nt/INSTALL, nextstep/INSTALL, and
-msdos/INSTALL. For information about building from a Bazaar checkout
-(rather than a release), also read the file INSTALL.BZR.
+msdos/INSTALL. For information about building from a repository checkout
+(rather than a release), also read the file INSTALL.REPO.
BASIC INSTALLATION
sections of this guide will help you do that, so please refer to those
sections if you need to.
- 1. Unpacking the Emacs 24.1 release requires about 180 MB of free
- disk space. Building Emacs uses about another 70 MB of space.
- The final installed Emacs uses about 110 MB of disk space.
+ 1. Unpacking the Emacs 24 release requires about 200 MB of free
+ disk space. Building Emacs uses about another 200 MB of space.
+ The final installed Emacs uses about 150 MB of disk space.
This includes the space-saving that comes from automatically
compressing the Lisp source files on installation.
name, where to find various headers and libraries, etc.
Refer to the section DETAILED BUILDING AND INSTALLATION below.
- If `configure' didn't find some (optional) image support libraries,
- such as Xpm, jpeg, etc., and you want to use them, refer to the
- subsection "Image support libraries" below.
+ If `configure' didn't find some image support libraries, such as
+ Xpm and jpeg, refer to "Image support libraries" below.
If the details printed by `configure' don't make any sense to
you, but there are no obvious errors, assume that `configure' did
* Image support libraries
-Emacs needs optional libraries to be able to display images (with the
-exception of PBM and XBM images whose support is built-in).
+Emacs needs libraries to display images, with the exception of PBM and
+XBM images whose support is built-in.
On some systems, particularly on GNU/Linux, these libraries may
-already be present or available as additional packages. Note that if
+already be present or available as additional packages. If
there is a separate `dev' or `devel' package, for use at compilation
time rather than run time, you will need that as well as the
corresponding run time package; typically the dev package will
contain header files and a library archive. Otherwise, you can
-download and build libraries from sources. None of them are vital for
-running Emacs; however, note that Emacs will not be able to use
-colored icons in the toolbar if XPM support is not compiled in.
-
-Here's the list of some of these optional libraries, and the URLs
-where they can be found (in the unlikely event that your distribution
-does not provide them):
-
- . libXaw3d http://directory.fsf.org/project/xaw3d/
- . libxpm for XPM: http://www.x.org/releases/current/src/lib/
- . libpng for PNG: http://www.libpng.org/
- . libz (for PNG): http://www.zlib.net/
- . libjpeg for JPEG: http://www.ijg.org/
- . libtiff for TIFF: http://www.remotesensing.org/libtiff/
- . libgif for GIF: http://sourceforge.net/projects/giflib/
-
-Emacs will configure itself to build with these libraries if the
-`configure' script finds them on your system, unless you supply the
-appropriate --without-LIB option. In some cases, older versions of
-these libraries won't work because some routines are missing, and
-configure should avoid such old versions. If that happens, use the
---without-LIB options to `configure', if you need to.
+download and build libraries from sources. Although none of them are
+essential for running Emacs, some are important enough that
+'configure' will report an error if they are absent from a system that
+has X11 support, unless 'configure' is specifically told to omit them.
+
+Here's a list of some of these libraries, and the URLs where they
+can be found (in the unlikely event that your distribution does not
+provide them). By default, libraries marked with an X are required if
+X11 is being used.
+
+ libXaw3d http://directory.fsf.org/project/xaw3d/
+ X libxpm for XPM: http://www.x.org/releases/current/src/lib/
+ X libpng for PNG: http://www.libpng.org/
+ libz (for PNG): http://www.zlib.net/
+ X libjpeg for JPEG: http://www.ijg.org/
+ X libtiff for TIFF: http://www.remotesensing.org/libtiff/
+ X libgif for GIF: http://sourceforge.net/projects/giflib/
+
+If you supply the appropriate --without-LIB option, 'configure' will
+omit the corresponding library from Emacs, even if that makes for a
+less-pleasant user interface. Otherwise, Emacs will configure itself
+to build with these libraries if 'configure' finds them on your
+system, and 'configure' will complain and exit if a library marked 'X'
+is not found on a system that uses X11. Use --without-LIB if your
+version of a library won't work because some routines are missing.
* Extra fonts
see msdos/INSTALL. For later versions of MS Windows, see the file
nt/INSTALL. For GNUstep and Mac OS X, see nextstep/INSTALL.)
-1) Make sure your system has enough swapping space allocated to handle
-a program whose pure code is 1.5 MB and whose data area is at
-least 2.8 MB and can reach 100 MB or more. If the swapping space is
-insufficient, you will get an error in the command `temacs -batch -l
-loadup dump', found in `./src/Makefile.in', or possibly when
-running the final dumped Emacs. (This should not be an issue
-on any recent system.)
-
-Building Emacs requires about 230 MB of disk space (including the
-Emacs sources). Once installed, Emacs occupies about 120 MB in the file
-system where it is installed; this includes the executable files, Lisp
-libraries, miscellaneous data files, and on-line documentation. If
-the building and installation take place in different directories,
-then the installation procedure momentarily requires 230+120 MB.
+1) See the basic installation summary above for the disk space requirements.
2) In the unlikely event that `configure' does not detect your system
type correctly, consult `./etc/MACHINES' to see what --host, --build
To get more attractive menus, you can specify an X toolkit when you
configure Emacs; use the option `--with-x-toolkit=TOOLKIT', where
TOOLKIT is `gtk' (the default), `athena', or `motif' (`yes' and
-`lucid' are synonyms for `athena'). On some systems, it does not work
-to use a toolkit with shared libraries. A free implementation of
-Motif, called LessTif, is available from <http://www.lesstif.org>.
-Compiling with LessTif or Motif causes a standard File Selection
-Dialog to pop up when you invoke file commands with the mouse. You
-can get fancy 3D-style scroll bars, even without Gtk or LessTif/Motif,
-if you have the Xaw3d library installed (see "Image support libraries"
-above for Xaw3d availability).
+`lucid' are synonyms for `athena'). Compiling with Motif causes a
+standard File Selection Dialog to pop up when you invoke file commands
+with the mouse. You can get fancy 3D-style scroll bars, even without
+Gtk or Motif, if you have the Xaw3d library installed (see
+"Image support libraries" above for Xaw3d availability).
You can tell configure where to search for GTK by specifying
`--with-pkg-config-prog=PATH' where PATH is the pathname to
-pkg-config. Note that GTK version 2.6 or newer is required for Emacs.
+pkg-config.
Emacs will autolaunch a D-Bus session bus, when the environment
variable DISPLAY is set, but no session bus is running. This might be
For image support you may have to download, build, and install the
appropriate image support libraries for image types other than XBM and
-PBM, see the list of URLs in "ADDITIONAL DISTRIBUTION FILES" above.
+PBM, see the list of URLs in "Image support libraries" above.
(Note that PNG support requires libz in addition to libpng.)
To disable individual types of image support in Emacs for some reason,
--without-gif for GIF image support
--without-png for PNG image support
-Use --without-toolkit-scroll-bars to disable LessTif/Motif or Xaw3d
-scroll bars.
+Use --without-toolkit-scroll-bars to disable Motif or Xaw3d scroll bars.
Use --without-xim to inhibit the default use of X Input Methods.
In this case, the X resource useXIM can be used to turn on use of XIM.