Fixes: 18757
[emacs.git] / INSTALL
blob2f4f41773c1a532ed9ca61715665d6a641084d59
1 GNU Emacs Installation Guide
2 Copyright (C) 1992, 1994, 1996-1997, 2000-2014 Free Software Foundation, Inc.
3 See the end of the file for license conditions.
6 This file contains general information on building GNU Emacs.
7 For more information specific to the MS-Windows, GNUstep/Mac OS X, and
8 MS-DOS ports, also read the files nt/INSTALL, nextstep/INSTALL, and
9 msdos/INSTALL.  For information about building from a repository checkout
10 (rather than a release), also read the file INSTALL.REPO.
13 BASIC INSTALLATION
15 On most Unix systems, you build Emacs by first running the `configure'
16 shell script.  This attempts to deduce the correct values for
17 various system-dependent variables and features, and find the
18 directories where certain system headers and libraries are kept.
19 In a few cases, you may need to explicitly tell configure where to
20 find some things, or what options to use.
22 `configure' creates a `Makefile' in several subdirectories, and a
23 `src/config.h' file containing system-dependent definitions.
24 Running the `make' utility then builds the package for your system.
26 Here's the procedure to build Emacs using `configure' on systems which
27 are supported by it.  In some cases, if the simplified procedure fails,
28 you might need to use various non-default options, and maybe perform
29 some of the steps manually.  The more detailed description in the other
30 sections of this guide will help you do that, so please refer to those
31 sections if you need to.
33   1. Unpacking the Emacs 24 release requires about 200 MB of free
34   disk space.  Building Emacs uses about another 200 MB of space.
35   The final installed Emacs uses about 150 MB of disk space.
36   This includes the space-saving that comes from automatically
37   compressing the Lisp source files on installation.
39   2a. `cd' to the directory where you unpacked Emacs and invoke the
40       `configure' script:
42                  ./configure
44   2b. Alternatively, create a separate directory, outside the source
45       directory, where you want to build Emacs, and invoke `configure'
46       from there:
48                  SOURCE-DIR/configure
50       where SOURCE-DIR is the top-level Emacs source directory.
51       This may not work unless you use GNU make.
53   3. When `configure' finishes, it prints several lines of details
54      about the system configuration.  Read those details carefully
55      looking for anything suspicious, such as wrong CPU and operating
56      system names, wrong places for headers or libraries, missing
57      libraries that you know are installed on your system, etc.
59      If you find anything wrong, you may have to pass to `configure'
60      one or more options specifying the explicit machine configuration
61      name, where to find various headers and libraries, etc.
62      Refer to the section DETAILED BUILDING AND INSTALLATION below.
64      If `configure' didn't find some image support libraries, such as
65      Xpm and jpeg, refer to "Image support libraries" below.
67      If the details printed by `configure' don't make any sense to
68      you, but there are no obvious errors, assume that `configure' did
69      its job and proceed.
71   4. Invoke the `make' program:
73                  make
75   5. If `make' succeeds, it will build an executable program `emacs'
76      in the `src' directory.  You can try this program, to make sure
77      it works:
79                  src/emacs -Q
81   6. Assuming that the program `src/emacs' starts and displays its
82      opening screen, you can install the program and its auxiliary
83      files into their installation directories:
85                  make install
87   You are now ready to use Emacs.  If you wish to conserve disk space,
88   you may remove the program binaries and object files from the
89   directory where you built Emacs:
91                  make clean
93   You can delete the entire build directory if you do not plan to
94   build Emacs again, but it can be useful to keep for debugging.
95   If you want to build Emacs again with different configure options,
96   first clean the source directories:
98                 make distclean
100   Note that the install automatically saves space by compressing
101   (provided you have the `gzip' program) those installed Lisp source (.el)
102   files that have corresponding .elc versions, as well as the Info files.
105 ADDITIONAL DISTRIBUTION FILES
107 * Complex Text Layout support libraries
109 On GNU and Unix systems, Emacs needs the optional libraries "m17n-db",
110 "libm17n-flt", "libotf" to correctly display such complex scripts as
111 Indic and Khmer, and also for scripts that require Arabic shaping
112 support (Arabic and Farsi).  On some systems, particularly GNU/Linux,
113 these libraries may be already present or available as additional
114 packages.  Note that if there is a separate `dev' or `devel' package,
115 for use at compilation time rather than run time, you will need that
116 as well as the corresponding run time package; typically the dev
117 package will contain header files and a library archive.  Otherwise,
118 you can download the libraries from <http://www.nongnu.org/m17n/>.
120 Note that Emacs cannot support complex scripts on a TTY, unless the
121 terminal includes such a support.
123 * intlfonts-VERSION.tar.gz
125 The intlfonts distribution contains X11 fonts in various encodings
126 that Emacs can use to display international characters.  If you see a
127 non-ASCII character appear as a hollow box, that means you don't have
128 a font for it.  You might find one in the intlfonts distribution.  If
129 you do have a font for a non-ASCII character, but some characters
130 don't look right, or appear improperly aligned, a font from the
131 intlfonts distribution might look better.
133 The fonts in the intlfonts distribution are also used by the ps-print
134 package for printing international characters.  The file
135 lisp/ps-mule.el defines the *.bdf font files required for printing
136 each character set.
138 The intlfonts distribution contains its own installation instructions,
139 in the intlfonts/README file.
141 * Image support libraries
143 Emacs needs libraries to display images, with the exception of PBM and
144 XBM images whose support is built-in.
146 On some systems, particularly on GNU/Linux, these libraries may
147 already be present or available as additional packages.  If
148 there is a separate `dev' or `devel' package, for use at compilation
149 time rather than run time, you will need that as well as the
150 corresponding run time package; typically the dev package will
151 contain header files and a library archive.  Otherwise, you can
152 download and build libraries from sources.  Although none of them are
153 essential for running Emacs, some are important enough that
154 'configure' will report an error if they are absent from a system that
155 has X11 support, unless 'configure' is specifically told to omit them.
157 Here's a list of some of these libraries, and the URLs where they
158 can be found (in the unlikely event that your distribution does not
159 provide them).  By default, libraries marked with an X are required if
160 X11 is being used.
162     libXaw3d          http://directory.fsf.org/project/xaw3d/
163   X libxpm for XPM:   http://www.x.org/releases/current/src/lib/
164   X libpng for PNG:   http://www.libpng.org/
165     libz (for PNG):   http://www.zlib.net/
166   X libjpeg for JPEG: http://www.ijg.org/
167   X libtiff for TIFF: http://www.remotesensing.org/libtiff/
168   X libgif for GIF:   http://sourceforge.net/projects/giflib/
170 If you supply the appropriate --without-LIB option, 'configure' will
171 omit the corresponding library from Emacs, even if that makes for a
172 less-pleasant user interface.  Otherwise, Emacs will configure itself
173 to build with these libraries if 'configure' finds them on your
174 system, and 'configure' will complain and exit if a library marked 'X'
175 is not found on a system that uses X11.  Use --without-LIB if your
176 version of a library won't work because some routines are missing.
178 * Extra fonts
180 The Emacs distribution does not include fonts and does not install
181 them.
183 On the GNU system, Emacs supports both X fonts and local fonts
184 (i.e. fonts managed by the fontconfig library).  If you need more
185 fonts than your distribution normally provides, you must install them
186 yourself.  See <URL:http://www.gnu.org/software/freefont/> for a large
187 number of free Unicode fonts.
189 * GNU/Linux development packages
191 Many GNU/Linux systems do not come with development packages by default;
192 they include the files that you need to run Emacs, but not those you
193 need to compile it.  For example, to compile Emacs with support for X
194 and graphics libraries, you may need to install the `X development'
195 package(s), and development versions of the jpeg, png, etc. packages.
197 The names of the packages that you need varies according to the
198 GNU/Linux distribution that you use, and the options that you want to
199 configure Emacs with.  On Debian-based systems, you can install all the
200 packages needed to build the installed version of Emacs with a command
201 like `apt-get build-dep emacs24'.  On Red Hat systems, the
202 corresponding command is `yum-builddep emacs'.
205 DETAILED BUILDING AND INSTALLATION:
207 (This is for a Unix or Unix-like system.  For MS-DOS and MS Windows 3.X,
208 see msdos/INSTALL.  For later versions of MS Windows, see the file
209 nt/INSTALL.  For GNUstep and Mac OS X, see nextstep/INSTALL.)
211 1) See the basic installation summary above for the disk space requirements.
213 2) In the unlikely event that `configure' does not detect your system
214 type correctly, consult `./etc/MACHINES' to see what --host, --build
215 options you should pass to `configure'.  That file also offers hints
216 for getting around some possible installation problems.
218 3) You can build Emacs in the top-level Emacs source directory
219 or in a separate directory.
221 3a) To build in the top-level Emacs source directory, go to that
222 directory and run the program `configure' as follows:
224     ./configure [--OPTION[=VALUE]] ...
226 If `configure' cannot determine your system type, try again
227 specifying the proper --build, --host options explicitly.
229 If you don't want X support, specify `--with-x=no'.  If you omit this
230 option, `configure' will try to figure out for itself whether your
231 system has X, and arrange to use it if present.
233 The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build
234 process where the compiler should look for the include files and
235 object libraries used with the X Window System.  Normally, `configure'
236 is able to find them; these options are necessary if you have your X
237 Window System files installed in unusual places.  These options also
238 accept a list of directories, separated with colons.
240 To get more attractive menus, you can specify an X toolkit when you
241 configure Emacs; use the option `--with-x-toolkit=TOOLKIT', where
242 TOOLKIT is `gtk' (the default), `athena', or `motif' (`yes' and
243 `lucid' are synonyms for `athena').  Compiling with Motif causes a
244 standard File Selection Dialog to pop up when you invoke file commands
245 with the mouse.  You can get fancy 3D-style scroll bars, even without
246 Gtk or Motif, if you have the Xaw3d library installed (see
247 "Image support libraries" above for Xaw3d availability).
249 You can tell configure where to search for GTK by specifying
250 `--with-pkg-config-prog=PATH' where PATH is the pathname to
251 pkg-config.
253 Emacs will autolaunch a D-Bus session bus, when the environment
254 variable DISPLAY is set, but no session bus is running.  This might be
255 inconvenient for Emacs when running as daemon or running via a remote
256 ssh connection.  In order to completely prevent the use of D-Bus, configure
257 Emacs with the options `--without-dbus --without-gconf --without-gsettings'.
259 The Emacs mail reader RMAIL is configured to be able to read mail from
260 a POP3 server by default.  Versions of the POP protocol older than
261 POP3 are not supported.  For Kerberos-authenticated POP add
262 `--with-kerberos', for Hesiod support add `--with-hesiod'.  While POP3
263 is always enabled, whether Emacs actually uses POP is controlled by
264 individual users--see the Rmail chapter of the Emacs manual.
266 For image support you may have to download, build, and install the
267 appropriate image support libraries for image types other than XBM and
268 PBM, see the list of URLs in "Image support libraries" above.
269 (Note that PNG support requires libz in addition to libpng.)
271 To disable individual types of image support in Emacs for some reason,
272 even though configure finds the libraries, you can configure with one
273 or more of these options:
275   --without-xpm        for XPM image support
276   --without-jpeg       for JPEG image support
277   --without-tiff       for TIFF image support
278   --without-gif        for GIF image support
279   --without-png        for PNG image support
281 Use --without-toolkit-scroll-bars to disable Motif or Xaw3d scroll bars.
283 Use --without-xim to inhibit the default use of X Input Methods.
284 In this case, the X resource useXIM can be used to turn on use of XIM.
286 Use --disable-largefile to omit support for files larger than 2GB on
287 systems which support that.
289 Use --without-sound to disable sound support.
291 Use --without-all if you want to build a small executable with the minimal
292 dependencies on external libraries, at the cost of disabling most of the
293 features that are normally enabled by default.  Using --without-all is
294 equivalent to --without-sound --without-dbus --without-libotf
295 --without-selinux --without-xft --without-gsettings --without-gnutls
296 --without-rsvg --without-xml2 --without-gconf --without-imagemagick
297 --without-m17n-flt --without-jpeg --without-tiff --without-gif
298 --without-png --without-gpm --without-file-notification.  Note that
299 --without-all leaves X support enabled, and using the GTK2 or GTK3
300 toolkit creates a lot of library dependencies.  So if you want to
301 build a small executable with very basic X support, use --without-all
302 --with-x-toolkit=no.  For the smallest possible executable without X,
303 use --without-all --without-x.  If you want to build with just a few
304 features enabled, you can combine --without-all with --with-FEATURE.
305 For example, you can use --without-all --with-dbus to build with DBus
306 support and nothing more.
308 Use --with-wide-int to implement Emacs values with the type 'long long',
309 even on hosts where a narrower type would do.  With this option, on a
310 typical 32-bit host, Emacs integers have 62 bits instead of 30.
312 Use --enable-gcc-warnings to enable compile-time checks that warn
313 about possibly-questionable C code.  This is intended for developers
314 and is useful with GNU-compatible compilers.  On a recent GNU system
315 there should be no warnings; on older and on non-GNU systems the
316 generated warnings may still be useful.
318 Use --enable-link-time-optimization to enable link-time optimizer, which
319 is available in GNU compiler since version 4.5.0.  If your compiler is not
320 GNU or older than version 4.5.0, this option does nothing.  If `configure'
321 can determine number of online CPUS on your system, final link-time
322 optimization and code generation is executed in parallel using one job
323 per each available online CPU.
325 The `--prefix=PREFIXDIR' option specifies where the installation process
326 should put emacs and its data files.  This defaults to `/usr/local'.
327 - Emacs (and the other utilities users run) go in PREFIXDIR/bin
328   (unless the `--exec-prefix' option says otherwise).
329 - The architecture-independent files go in PREFIXDIR/share/emacs/VERSION
330   (where VERSION is the version number of Emacs, like `23.2').
331 - The architecture-dependent files go in
332   PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION
333   (where CONFIGURATION is the configuration name, like
334   i686-pc-linux-gnu), unless the `--exec-prefix' option says otherwise.
336 The `--exec-prefix=EXECDIR' option allows you to specify a separate
337 portion of the directory tree for installing architecture-specific
338 files, like executables and utility programs.  If specified,
339 - Emacs (and the other utilities users run) go in EXECDIR/bin, and
340 - The architecture-dependent files go in
341   EXECDIR/libexec/emacs/VERSION/CONFIGURATION.
342 EXECDIR/bin should be a directory that is normally in users' PATHs.
344 For example, the command
346     ./configure --build=i386-linux-gnu --without-sound
348 configures Emacs to build for a 32-bit GNU/Linux distribution,
349 without sound support.
351 `configure' doesn't do any compilation or installation itself.
352 It just creates the files that influence those things:
353 `./Makefile' in the top-level directory and several subdirectories;
354 and `./src/config.h'.  For details on exactly what it does, see the
355 section called `CONFIGURATION BY HAND', below.
357 When it is done, `configure' prints a description of what it did and
358 creates a shell script `config.status' which, when run, recreates the
359 same configuration.  If `configure' exits with an error after
360 disturbing the status quo, it removes `config.status'.  `configure'
361 also creates a file `config.cache' that saves the results of its tests
362 to make reconfiguring faster, and a file `config.log' containing compiler
363 output (useful mainly for debugging `configure').  You can give
364 `configure' the option `--cache-file=FILE' to use the results of the
365 tests in FILE instead of `config.cache'.  Set FILE to `/dev/null' to
366 disable caching, for debugging `configure'.
368 If the description of the system configuration printed by `configure'
369 is not right, or if it claims some of the features or libraries are not
370 available when you know they are, look at the `config.log' file for
371 the trace of the failed tests performed by `configure' to check
372 whether these features are supported.  Typically, some test fails
373 because the compiler cannot find some function in the system
374 libraries, or some macro-processor definition in the system headers.
376 Some tests might fail because the compiler should look in special
377 directories for some header files, or link against optional
378 libraries, or use special compilation options.  You can force
379 `configure' and the build process which follows it to do that by
380 setting the variables CPPFLAGS, CFLAGS, LDFLAGS, LIBS, CPP and CC
381 before running `configure'.  CPP is the command which invokes the
382 preprocessor, CPPFLAGS lists the options passed to it, CFLAGS are
383 compilation options, LDFLAGS are options used when linking, LIBS are
384 libraries to link against, and CC is the command which invokes the
385 compiler.  By default, gcc is used if available.
387 Here's an example of a `configure' invocation, assuming a Bourne-like
388 shell such as Bash, which uses these variables:
390  CPPFLAGS='-I/foo/myinclude' LDFLAGS='-L/bar/mylib' \
391   CFLAGS='-O3' LIBS='-lfoo -lbar' ./configure
393 (this is all one long line).  This tells `configure' to instruct the
394 preprocessor to look in the `/foo/myinclude' directory for header
395 files (in addition to the standard directories), instruct the linker
396 to look in `/bar/mylib' for libraries, pass the -O3 optimization
397 switch to the compiler, and link against libfoo and libbar
398 libraries in addition to the standard ones.
400 For some libraries, like Gtk+, fontconfig and ALSA, `configure' uses
401 pkg-config to find where those libraries are installed.
402 If you want pkg-config to look in special directories, you have to set
403 the environment variable PKG_CONFIG_PATH to point to the directories
404 where the .pc-files for those libraries are.
405 For example:
407  PKG_CONFIG_PATH='/usr/local/alsa/lib/pkgconfig:/opt/gtk+-2.8/lib/pkgconfig' \
408    ./configure
410 The work of `configure' can be done by editing various files in the
411 distribution, but using `configure' is easier.  See the section called
412 "CONFIGURATION BY HAND" below if you want to do the configuration
413 yourself.
415 3b) To build in a separate directory, go to that directory
416 and run the program `configure' as follows:
418     SOURCE-DIR/configure CONFIGURATION-NAME [--OPTION[=VALUE]] ...
420 SOURCE-DIR refers to the top-level Emacs source directory which is
421 where Emacs's configure script is located.  `configure' looks for the
422 Emacs source code in the directory that `configure' is in.
424 To build in a separate directory, you must use a version of `make'
425 that supports the `VPATH' variable, such as GNU `make'.
427 (Do not try to build in a separate directory by creating many links
428 to the real source directory--there is no need, and installation will
429 fail.)
431 4) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs
432 Lisp code you want Emacs to load before it is dumped out.  Use
433 site-load.el for additional libraries if you arrange for their
434 documentation strings to be in the etc/DOC file (see
435 src/Makefile.in if you wish to figure out how to do that).  For all
436 else, use site-init.el.  Do not load byte-compiled code which
437 was built with a non-nil value of `byte-compile-dynamic'.
439 It is not a good idea to edit the normal .el files that come with Emacs.
440 Instead, use a file like site-init.el to change settings.
442 To change the value of a variable that is already defined in Emacs,
443 you should use the Lisp function `setq', not `defvar'.  For example,
445      (setq news-inews-program "/usr/bin/inews")
447 is how you would override the default value of the variable
448 news-inews-program.
450 Before you override a variable this way, *look at the value* that the
451 variable gets by default!  Make sure you know what kind of value the
452 variable should have.  If you don't pay attention to what you are
453 doing, you'll make a mistake.
455 The `site-*.el' files are nonexistent in the distribution.  You do not
456 need to create them if you have nothing to put in them.
458 5) Refer to the file `./etc/TERMS' for information on fields you may
459 wish to add to various termcap entries.  (This is unlikely to be necessary.)
461 6) Run `make' in the top directory of the Emacs distribution to finish
462 building Emacs in the standard way.  The final executable file is
463 named `src/emacs'.  You can execute this file "in place" without
464 copying it, if you wish; then it automatically uses the sibling
465 directories ../lisp, ../lib-src, ../info.
467 Or you can "install" the executable and the other files into their
468 installed locations, with `make install'.  By default, Emacs's files
469 are installed in the following directories:
471 `/usr/local/bin' holds the executable programs users normally run -
472                 `emacs', `etags', `ctags', `emacsclient', and
473                 `grep-changelog'.
475 `/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library;
476                 `VERSION' stands for the number of the Emacs version
477                 you are installing, like `23.1' or `23.2'.  Since the
478                 Lisp library changes from one version of Emacs to
479                 another, including the version number in the path
480                 allows you to have several versions of Emacs installed
481                 at the same time; in particular, you don't have to
482                 make Emacs unavailable while installing a new version.
484 `/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
485                 file, and other architecture-independent files Emacs
486                 might need while running.
488 `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable
489                 programs used by Emacs that users are not expected to
490                 run themselves.
491                 `VERSION' is the number of the Emacs version you are
492                 installing, and `CONFIGURATION-NAME' is the value
493                 deduced by the `configure' program to identify the
494                 architecture and operating system of your machine,
495                 like `i686-pc-linux-gnu' or `sparc-sun-sunos'.  Since
496                 these files are specific to the version of Emacs,
497                 operating system, and architecture in use, including
498                 the configuration name in the path allows you to have
499                 several versions of Emacs for any mix of machines and
500                 operating systems installed at the same time; this is
501                 useful for sites at which different kinds of machines
502                 share the file system Emacs is installed on.
504 `/usr/local/share/info' holds the on-line documentation for Emacs,
505                 known as "info files".  Many other GNU programs are
506                 documented using info files as well, so this directory
507                 stands apart from the other, Emacs-specific directories.
509 `/usr/local/share/man/man1' holds the man pages for the programs installed
510                 in `/usr/local/bin'.
512 Any version of Emacs, whether installed or not, also looks for Lisp
513 files in these directories.
515 `/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp
516                 files installed for Emacs version VERSION only.
518 `/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp
519                 files installed for all Emacs versions.
521                 When Emacs is installed, it searches for its Lisp files
522                 in `/usr/local/share/emacs/VERSION/site-lisp', then in
523                 `/usr/local/share/emacs/site-lisp', and finally in
524                 `/usr/local/share/emacs/VERSION/lisp'.
526 If these directories are not what you want, you can specify where to
527 install Emacs's libraries and data files or where Emacs should search
528 for its Lisp files by giving values for `make' variables as part of
529 the command.  See the section below called `MAKE VARIABLES' for more
530 information on this.
532 7) Check the file `dir' in your site's info directory (usually
533 /usr/local/share/info) to make sure that it has a menu entry for the
534 Emacs info files.
536 8) If your system uses lock files to interlock access to mailer inbox files,
537 then you might need to make the movemail program setuid or setgid
538 to enable it to write the lock files.  We believe this is safe.
540 9) You are done!  You can remove executables and object files from
541 the build directory by typing `make clean'.  To also remove the files
542 that `configure' created (so you can compile Emacs for a different
543 configuration), type `make distclean'.  If you don't need some, or all
544 of the input methods from the Leim package, you can remove the
545 unneeded files in the leim subdirectories of your site's lisp
546 directory (usually /usr/local/share/emacs/VERSION/).
550 MAKE VARIABLES
552 You can change where the build process installs Emacs and its data
553 files by specifying values for `make' variables as part of the `make'
554 command line.  For example, if you type
556     make install bindir=/usr/local/gnubin
558 the `bindir=/usr/local/gnubin' argument indicates that the Emacs
559 executable files should go in `/usr/local/gnubin', not
560 `/usr/local/bin'.
562 Here is a complete list of the variables you may want to set.
564 `bindir' indicates where to put executable programs that users can
565         run.  This defaults to /usr/local/bin.
567 `datadir' indicates where to put the architecture-independent
568         read-only data files that Emacs refers to while it runs; it
569         defaults to /usr/local/share.  We create the following
570         subdirectories under `datadir':
571         - `emacs/VERSION/lisp', containing the Emacs Lisp library, and
572         - `emacs/VERSION/etc', containing the tutorials, DOC file, etc.
573         `VERSION' is the number of the Emacs version you are installing,
574         like `23.1' or `23.2'.  Since these files vary from one version
575         of Emacs to another, including the version number in the path
576         allows you to have several versions of Emacs installed at the
577         same time; this means that you don't have to make Emacs
578         unavailable while installing a new version.
580 `libexecdir' indicates where to put architecture-specific data files that
581         Emacs refers to as it runs; it defaults to `/usr/local/libexec'.
582         We create the following subdirectories under `libexecdir':
583         - `emacs/VERSION/CONFIGURATION-NAME', containing executable
584                 programs used by Emacs that users are not expected to run
585                 themselves.
586         `VERSION' is the number of the Emacs version you are installing,
587         and `CONFIGURATION-NAME' is the value deduced by the
588         `configure' program to identify the architecture and operating
589         system of your machine, like `i686-pc-linux-gnu' or `sparc-sun-sunos'.
590         Since these files are specific to the version of Emacs,
591         operating system, and architecture in use, including the
592         configuration name in the path allows you to have several
593         versions of Emacs for any mix of machines and operating
594         systems installed at the same time; this is useful for sites
595         at which different kinds of machines share the file system
596         Emacs is installed on.
598 `infodir' indicates where to put the info files distributed with
599         Emacs; it defaults to `/usr/local/share/info'.
601 `mandir' indicates where to put the man pages for Emacs and its
602         utilities (like `etags'); it defaults to
603         `/usr/local/share/man/man1'.
605 `prefix' doesn't give a path for any specific part of Emacs; instead,
606         its value is used to determine the defaults for all the
607         architecture-independent path variables - `datadir',
608         `sharedstatedir', `infodir', and `mandir'.  Its default value is
609         `/usr/local'; the other variables add on `lib' or `man' to it
610         by default.
612         For example, suppose your site generally places GNU software
613         under `/usr/users/software/gnusoft' instead of `/usr/local'.
614         By including
615             `prefix=/usr/users/software/gnusoft'
616         in the arguments to `make', you can instruct the build process
617         to place all of the Emacs data files in the appropriate
618         directories under that path.
620 `exec_prefix' serves the same purpose as `prefix', but instead
621         determines the default values for the architecture-dependent
622         path variables - `bindir' and `libexecdir'.
624 The above variables serve analogous purposes in the makefiles for all
625 GNU software; the following variables are specific to Emacs.
627 `archlibdir' indicates where Emacs installs and expects the executable
628         files and other architecture-dependent data it uses while
629         running.  Its default value, based on `libexecdir' (which
630         see), is `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME'
631         (where VERSION and CONFIGURATION-NAME are as described above).
633 `GZIP_PROG' is the name of the executable that compresses installed info,
634         manual, and .el files.  It defaults to gzip.  Setting it to
635         the empty string suppresses compression.
637 Remember that you must specify any variable values you need each time
638 you run `make' in the top directory.  If you run `make' once to build
639 emacs, test it, and then run `make' again to install the files, you
640 must provide the same variable settings each time.  To make the
641 settings persist, you can edit them into the `Makefile' in the top
642 directory, but be aware that running the `configure' program erases
643 `Makefile' and rebuilds it from `Makefile.in'.
645 The path for finding Lisp files is specified in src/epaths.h,
646 a file which is generated by running configure.  To change the path,
647 you can edit the definition of PATH_LOADSEARCH in that file
648 before you run `make'.
650 The top-level Makefile stores the variable settings it used in the
651 Makefiles for the subdirectories, so you don't have to specify them
652 when running make in the subdirectories.
655 CONFIGURATION BY HAND
657 This should not be necessary and is not recommended.  Instead of
658 running the `configure' program, you have to perform the following steps.
660 1) Copy `./src/config.in' to `./src/config.h'.
662 2) Edit `./src/config.h' to set the right options for your system.
664 3) Create `Makefile' files in various directories from the
665 corresponding `Makefile.in' files.  This isn't so hard, just a matter
666 of editing in appropriate substitutions for the @...@ constructs.
668 The `configure' script is built from `configure.ac' by the
669 `autogen.sh' script, which checks that `autoconf' and other build
670 tools are sufficiently up to date and then runs the build tools.
672 BUILDING GNU EMACS BY HAND
674 Once Emacs is configured, running `make' in the top directory performs
675 the following steps.
677 1) Run `make epaths-force' in the top directory.  This produces
678 `./src/epaths.h' from the template file `./src/epaths.in', changing
679 the paths to the values specified in `./Makefile'.
681 2) Go to directory `./lib' and run `make'.  This creates include files
682 and libraries used in later steps.
684 3) Go to directory `./lib-src' and run `make'.  This creates
685 executables named `etags', `make-docfile', and others.
687 4) Go to directory `./src' and run `make'.  This refers to files in
688 the `./lisp', `./lib', and `./lib-src' subdirectories using names
689 `../lisp', `../lib', and `../lib-src'.
691 This creates a file `./src/emacs' which is the runnable Emacs,
692 which has another name that contains a version number.
693 Each time you do this, that version number increments in the last place.
695 It also creates a file in `./etc' whose name is `DOC' followed by the
696 current Emacs version.  This file contains documentation strings for
697 all the functions in Emacs.  Each time you run make to make a new
698 emacs, a new DOC file with a new name is made.  You must keep the DOC
699 file for an Emacs version as long as you keep using that Emacs version.
702 INSTALLATION BY HAND
704 The steps below are done by running `make install' in the main
705 directory of the Emacs distribution.
707 1) Copy `./lisp' and its subdirectories, `./etc', and the executables
708 in `./lib-src' to their final destinations, as selected in `./src/epaths.h'.
710 Strictly speaking, not all of the executables in `./lib-src' need be copied.
711 - The programs `hexl', `movemail', `profile', and `rcs2log'
712     are used by Emacs; they do need to be copied.
713 - The programs `etags', `ctags', and `emacsclient' are intended to be
714     run by users; they are handled below.
715 - The programs `make-docfile' and `test-distrib' were
716     used in building Emacs, and are not needed any more.
718 2) Copy the files in `./info' to the place specified in
719 `./lisp/site-init.el' or `./lisp/info.el'.  Note that if the
720 destination directory already contains a file named `dir', you
721 probably don't want to replace it with the `dir' file in the Emacs
722 distribution.  Instead, you should make sure that the existing `dir'
723 file contains an appropriate menu entry for the Emacs info.
725 3) Copy `./src/emacs' to `/usr/local/bin', or to some other directory
726 in users' search paths.  `./src/emacs' has an alternate name
727 `./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named
728 `/usr/local/bin/emacs' pointing to that alternate name, as an easy way
729 of installing different versions.
731 You can delete `./src/temacs'.
733 4) Copy the programs `emacsclient', `ctags', and `etags' from `./lib-src'
734 to `/usr/local/bin'.  These programs are intended for users to run.
736 5) Copy the man pages in `./doc/man' into the appropriate man directory.
738 6) The files in the `./src' subdirectory, except for `emacs', are not
739 used by Emacs once it is built.  However, it is very desirable to keep
740 the source on line for debugging.
743 PROBLEMS
745 See the file `./etc/PROBLEMS' for a list of various problems sometimes
746 encountered, and what to do about them.
748 This file is part of GNU Emacs.
750 GNU Emacs is free software: you can redistribute it and/or modify
751 it under the terms of the GNU General Public License as published by
752 the Free Software Foundation, either version 3 of the License, or
753 (at your option) any later version.
755 GNU Emacs is distributed in the hope that it will be useful,
756 but WITHOUT ANY WARRANTY; without even the implied warranty of
757 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
758 GNU General Public License for more details.
760 You should have received a copy of the GNU General Public License
761 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.