INSTALL 32.9 KB
Newer Older
1
GNU Emacs Installation Guide
2
Copyright (C) 1992, 1994, 1996-1997, 2000-2019 Free Software Foundation,
3
Inc.
4 5 6 7
See the end of the file for license conditions.


This file contains general information on building GNU Emacs.
8
For more information specific to the MS-Windows, GNUstep/macOS, and
9
MS-DOS ports, also read the files nt/INSTALL, nextstep/INSTALL, and
10
msdos/INSTALL.  For information about building from a repository checkout
11
(rather than a release), also read the file INSTALL.REPO.
12 13 14 15


BASIC INSTALLATION

16
On most Unix systems, you build Emacs by first running the 'configure'
17 18 19 20 21 22
shell script.  This attempts to deduce the correct values for
various system-dependent variables and features, and find the
directories where certain system headers and libraries are kept.
In a few cases, you may need to explicitly tell configure where to
find some things, or what options to use.

23 24 25
'configure' creates a 'Makefile' in several subdirectories, and a
'src/config.h' file containing system-dependent definitions.
Running the 'make' utility then builds the package for your system.
26

27
Building Emacs requires GNU make, <https://www.gnu.org/software/make/>.
28
On most systems that Emacs supports, this is the default 'make' program.
29

30
Here's the procedure to build Emacs using 'configure' on systems which
31 32 33 34 35 36
are supported by it.  In some cases, if the simplified procedure fails,
you might need to use various non-default options, and maybe perform
some of the steps manually.  The more detailed description in the other
sections of this guide will help you do that, so please refer to those
sections if you need to.

Paul Eggert's avatar
Paul Eggert committed
37 38 39 40 41 42
  1.  Obtain and unpack the Emacs release, with commands like this:

		 wget https://ftp.gnu.org/gnu/emacs/emacs-VERSION.tar.xz
		 tar -xf emacs-VERSION.tar.xz

      where VERSION is the Emacs version number.
43

44 45
  2a. 'cd' to the directory where you unpacked Emacs and invoke the
      'configure' script:
46 47 48 49

		 ./configure

  2b. Alternatively, create a separate directory, outside the source
50
      directory, where you want to build Emacs, and invoke 'configure'
51 52 53 54 55 56
      from there:

		 SOURCE-DIR/configure

      where SOURCE-DIR is the top-level Emacs source directory.

57
  3. When 'configure' finishes, it prints several lines of details
58 59 60 61 62
     about the system configuration.  Read those details carefully
     looking for anything suspicious, such as wrong CPU and operating
     system names, wrong places for headers or libraries, missing
     libraries that you know are installed on your system, etc.

63
     If you find anything wrong, you may have to pass to 'configure'
64 65 66 67
     one or more options specifying the explicit machine configuration
     name, where to find various headers and libraries, etc.
     Refer to the section DETAILED BUILDING AND INSTALLATION below.

68
     If 'configure' didn't find some image support libraries, such as
69
     Xpm and jpeg, refer to "Image support libraries" below.
70

71 72
     If the details printed by 'configure' don't make any sense to
     you, but there are no obvious errors, assume that 'configure' did
73 74
     its job and proceed.

75
  4. Invoke the 'make' program:
76 77 78

		 make

79 80
  5. If 'make' succeeds, it will build an executable program 'emacs'
     in the 'src' directory.  You can try this program, to make sure
81 82 83 84
     it works:

		 src/emacs -Q

85 86 87 88
     To test Emacs further (intended mostly to help developers):

		 make check

89
  6. Assuming that the program 'src/emacs' starts and displays its
90 91 92 93 94
     opening screen, you can install the program and its auxiliary
     files into their installation directories:

		 make install

Paul Eggert's avatar
Paul Eggert committed
95
  You are now ready to use Emacs.  If you wish to conserve space,
96 97 98 99 100 101 102
  you may remove the program binaries and object files from the
  directory where you built Emacs:

		 make clean

  You can delete the entire build directory if you do not plan to
  build Emacs again, but it can be useful to keep for debugging.
103 104 105 106
  If you want to build Emacs again with different configure options,
  first clean the source directories:

		make distclean
107 108

  Note that the install automatically saves space by compressing
109
  (provided you have the 'gzip' program) those installed Lisp source (.el)
110 111
  files that have corresponding .elc versions, as well as the Info files.

112 113 114
  You can read a brief summary about common make targets:

                make help
115 116 117 118 119

ADDITIONAL DISTRIBUTION FILES

* Complex Text Layout support libraries

120 121 122 123 124
On GNU and Unix systems, Emacs needs the optional libraries "m17n-db",
"libm17n-flt", "libotf" to correctly display such complex scripts as
Indic and Khmer, and also for scripts that require Arabic shaping
support (Arabic and Farsi).  On some systems, particularly GNU/Linux,
these libraries may be already present or available as additional
125
packages.  Note that if there is a separate 'dev' or 'devel' package,
126 127 128
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,
Paul Eggert's avatar
Paul Eggert committed
129
you can download the libraries from <https://www.nongnu.org/m17n/>.
130

131 132 133
Note that Emacs cannot support complex scripts on a TTY, unless the
terminal includes such a support.

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
* intlfonts-VERSION.tar.gz

The intlfonts distribution contains X11 fonts in various encodings
that Emacs can use to display international characters.  If you see a
non-ASCII character appear as a hollow box, that means you don't have
a font for it.  You might find one in the intlfonts distribution.  If
you do have a font for a non-ASCII character, but some characters
don't look right, or appear improperly aligned, a font from the
intlfonts distribution might look better.

The fonts in the intlfonts distribution are also used by the ps-print
package for printing international characters.  The file
lisp/ps-mule.el defines the *.bdf font files required for printing
each character set.

The intlfonts distribution contains its own installation instructions,
in the intlfonts/README file.

* Image support libraries

154 155
Emacs needs libraries to display images, with the exception of PBM and
XBM images whose support is built-in.
156 157

On some systems, particularly on GNU/Linux, these libraries may
158
already be present or available as additional packages.  If
159
there is a separate 'dev' or 'devel' package, for use at compilation
160 161 162
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
163 164 165 166 167 168 169 170 171 172
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.

Paul Eggert's avatar
Paul Eggert committed
173 174
    libXaw3d          https://directory.fsf.org/project/Xaw3d
  X libxpm for XPM:   https://www.x.org/releases/current/src/lib/
175
  X libpng for PNG:   http://www.libpng.org/
Paul Eggert's avatar
Paul Eggert committed
176 177 178 179 180
    libz (for PNG):   https://www.zlib.net/
  X libjpeg for JPEG: https://www.ijg.org/
  X libtiff for TIFF: http://www.simplesystems.org/libtiff/
  X libgif for GIF:   http://giflib.sourceforge.net/
    librsvg2 for SVG: https://wiki.gnome.org/Projects/LibRsvg
181 182 183 184 185 186 187 188

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.
189 190 191 192 193 194 195 196 197

* Extra fonts

The Emacs distribution does not include fonts and does not install
them.

On the GNU system, Emacs supports both X fonts and local fonts
(i.e. fonts managed by the fontconfig library).  If you need more
fonts than your distribution normally provides, you must install them
198
yourself.  See <https://www.gnu.org/software/freefont/> for a large
199 200 201 202 203 204 205
number of free Unicode fonts.

* GNU/Linux development packages

Many GNU/Linux systems do not come with development packages by default;
they include the files that you need to run Emacs, but not those you
need to compile it.  For example, to compile Emacs with support for X
206
and graphics libraries, you may need to install the X development
207 208
package(s), and development versions of the jpeg, png, etc. packages.

209
The names of the packages that you need vary according to the
210 211 212
GNU/Linux distribution that you use, and the options that you want to
configure Emacs with.  On Debian-based systems, you can install all the
packages needed to build the installed version of Emacs with a command
213 214
like 'apt-get build-dep emacs' (on older systems, replace 'emacs' with
eg 'emacs25').  On Red Hat-based systems, the corresponding command is
215
'dnf builddep emacs' (on older systems, use 'yum-builddep' instead).
216

217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
* GNU/Linux source and debug packages

Many GNU/Linux systems provide separate packages containing the
sources and debug symbols of Emacs.  They are useful if you want to
check the source code of Emacs primitive functions or debug Emacs on
the C level.

The names of the packages that you need vary according to the
GNU/Linux distribution that you use.  On Debian-based systems, you can
install a source package of Emacs with a command like 'apt-get source
emacs' (on older systems, replace 'emacs' with eg 'emacs25').  The
target directory for unpacking the source tree is the current
directory.  On Red Hat-based systems, the corresponding command is
'dnf install emacs-debugsource', with target directory /usr/src/debug
(this requires to add the *-debuginfo repositories first, via 'dnf
config-manager --set-enabled fedora-debuginfo updates-debuginfo').

Once you have installed the source package, for example at
/path/to/emacs-26.1, add the following line to your startup file:

     (setq find-function-C-source-directory
           "/path/to/emacs-26.1/src")

The installation directory of the Emacs source package will contain
the exact package name and version number Emacs is installed on your
system.  If a new Emacs package is installed, the source package must
be reinstalled as well, and the setting in your startup file must be
updated.

Emacs debugging symbols are distributed by a debug package.  It does
not exist for every released Emacs package, this depends on the
distribution.  On Debian-based systems, you can install a debug
package of Emacs with a command like 'apt-get install emacs-dbg' (on
older systems, replace 'emacs' with eg 'emacs25').  On Red Hat-based
systems, the corresponding command is 'dnf debuginfo-install emacs'.

253 254 255

DETAILED BUILDING AND INSTALLATION:

256
(This is for a Unix or Unix-like system.  For GNUstep and macOS,
257 258
see nextstep/INSTALL.  For non-ancient versions of MS Windows, see
the file nt/INSTALL.  For MS-DOS and MS Windows 3.X, see msdos/INSTALL.)
259

Paul Eggert's avatar
Paul Eggert committed
260
1) See BASIC INSTALLATION above for getting and configuring Emacs.
261

262 263 264
2) In the unlikely event that 'configure' does not detect your system
type correctly, consult './etc/MACHINES' to see what --host, --build
options you should pass to 'configure'.  That file also offers hints
265 266 267 268 269 270
for getting around some possible installation problems.

3) You can build Emacs in the top-level Emacs source directory
or in a separate directory.

3a) To build in the top-level Emacs source directory, go to that
271
directory and run the program 'configure' as follows:
272 273 274

    ./configure [--OPTION[=VALUE]] ...

275
If 'configure' cannot determine your system type, try again
276 277
specifying the proper --build, --host options explicitly.

278 279
If you don't want X support, specify '--with-x=no'.  If you omit this
option, 'configure' will try to figure out for itself whether your
280 281
system has X, and arrange to use it if present.

282
The '--x-includes=DIR' and '--x-libraries=DIR' options tell the build
283
process where the compiler should look for the include files and
284
object libraries used with the X Window System.  Normally, 'configure'
285 286 287 288 289
is able to find them; these options are necessary if you have your X
Window System files installed in unusual places.  These options also
accept a list of directories, separated with colons.

To get more attractive menus, you can specify an X toolkit when you
290 291 292
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').  Compiling with Motif causes a
293 294 295 296
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).
297

298
You can tell configure where to search for GTK by giving it the
299
argument PKG_CONFIG='/full/name/of/pkg-config'.
300

301 302 303
Emacs will autolaunch a D-Bus session bus, when the environment
variable DISPLAY is set, but no session bus is running.  This might be
inconvenient for Emacs when running as daemon or running via a remote
Glenn Morris's avatar
Glenn Morris committed
304
ssh connection.  In order to completely prevent the use of D-Bus, configure
305
Emacs with the options '--without-dbus --without-gconf --without-gsettings'.
306

307 308
To read email via a network protocol like IMAP or POP, you can
configure Emacs with the option '--with-mailutils', so that it always
309 310 311 312
uses the GNU Mailutils 'movemail' program to retrieve mail; this is
the default if GNU Mailutils is installed.  Otherwise the Emacs build
procedure builds and installs an auxiliary 'movemail' program, a
limited and insecure substitute; when this happens, there are several
313
configure options such as --without-pop that provide fine-grained
314 315
control over Emacs 'movemail' construction.

316 317
The Emacs mail reader RMAIL is configured to be able to read mail from
a POP3 server by default.  Versions of the POP protocol older than
318 319
POP3 are not supported.  While POP3 support is typically enabled,
whether Emacs actually uses POP3 is controlled by individual users;
320
see the Rmail chapter of the Emacs manual.  Unless --with-mailutils is
321 322 323 324
in effect, it is a good idea to configure without POP3 support so that
users are less likely to inadvertently read email via insecure
channels.  On native MS-Windows, --with-pop is the default; on other
platforms, --without-pop is the default.
325 326 327

For image support you may have to download, build, and install the
appropriate image support libraries for image types other than XBM and
328
PBM, see the list of URLs in "Image support libraries" above.
329 330 331 332 333 334
(Note that PNG support requires libz in addition to libpng.)

To disable individual types of image support in Emacs for some reason,
even though configure finds the libraries, you can configure with one
or more of these options:

335 336 337 338 339 340
  --without-xpm          for XPM image support
  --without-jpeg         for JPEG image support
  --without-tiff         for TIFF image support
  --without-gif          for GIF image support
  --without-png          for PNG image support
  --without-rsvg         for SVG image support
341 342 343

Although ImageMagick support is disabled by default due to security
and stability concerns, you can enable it with --with-imagemagick.
344

345
Use --without-toolkit-scroll-bars to disable Motif or Xaw3d scroll bars.
346 347 348 349 350 351 352 353 354

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.

Use --disable-largefile to omit support for files larger than 2GB on
systems which support that.

Use --without-sound to disable sound support.

355 356 357 358
Use --without-all for a smaller executable with fewer dependencies on
external libraries, at the cost of disabling many features.  Although
--without-all disables libraries not needed for ordinary Emacs
operation, it does enable X support, and using the GTK2 or GTK3
359 360 361 362 363
toolkit creates a lot of library dependencies.  So if you want to
build a small executable with very basic X support, use --without-all
--with-x-toolkit=no.  For the smallest possible executable without X,
use --without-all --without-x.  If you want to build with just a few
features enabled, you can combine --without-all with --with-FEATURE.
364
For example, you can use --without-all --without-x --with-dbus to
Michael Albinus's avatar
Michael Albinus committed
365
build with D-Bus support and nothing more.
366

367 368 369 370 371 372
Use --with-gnutls=ifavailable to use GnuTLS if available but go ahead
and build without it if not available.  This overrides Emacs's default
behavior of refusing to build if GnuTLS is absent.  When X11 support
is enabled, the libraries for gif, jpeg, png, tiff, and xpm are in the
same strongly-recommended category as GnuTLS, and have similar options.

Paul Eggert's avatar
Paul Eggert committed
373 374 375 376
Use --with-wide-int to implement Emacs values with the type 'long long',
even on hosts where a narrower type would do.  With this option, on a
typical 32-bit host, Emacs integers have 62 bits instead of 30.

377 378
Use --with-cairo to compile Emacs with Cairo drawing.

379 380 381
Use --with-modules to build Emacs with support for dynamic modules.
This needs a C compiler that supports '__attribute__ ((cleanup (...)))',
as in GCC 3.4 and later.
382

383 384 385 386
Use --enable-gcc-warnings to enable compile-time checks that warn
about possibly-questionable C code.  This is intended for developers
and is useful with GNU-compatible compilers.  On a recent GNU system
there should be no warnings; on older and on non-GNU systems the
387 388 389 390 391
generated warnings may still be useful, though you may prefer
configuring with --enable-gcc-warnings=warn-only so they are not
treated as errors.  The default is --enable-gcc-warnings=warn-only if
it appears to be a developer build, and is --disable-gcc-warnings
otherwise.
392

393 394 395
Use --disable-silent-rules to cause 'make' to give more details about
the commands it executes.  This can be helpful when debugging a build
that goes awry.  'make V=1' also enables the extra chatter.
396

397 398 399 400
Use --enable-link-time-optimization to enable link-time optimization.
With GCC, you need GCC 4.5.0 and later, and 'configure' arranges for
linking to be parallelized if possible.  With Clang, you need GNU
binutils with the gold linker and plugin support, along with the LLVM
Paul Eggert's avatar
Paul Eggert committed
401
gold plugin <https://llvm.org/docs/GoldPlugin.html>.  Link time
402 403
optimization is not the default as it tends to cause crashes and to
make Emacs slower.
404

405 406
The '--prefix=PREFIXDIR' option specifies where the installation process
should put emacs and its data files.  This defaults to '/usr/local'.
407
- Emacs (and the other utilities users run) go in PREFIXDIR/bin
408
  (unless the '--exec-prefix' option says otherwise).
409
- The architecture-independent files go in PREFIXDIR/share/emacs/VERSION
410
  (where VERSION is the version number of Emacs, like '23.2').
411 412 413
- The architecture-dependent files go in
  PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION
  (where CONFIGURATION is the configuration name, like
414
  i686-pc-linux-gnu), unless the '--exec-prefix' option says otherwise.
415

416
The '--exec-prefix=EXECDIR' option allows you to specify a separate
417 418 419 420 421 422 423 424 425 426 427 428 429 430
portion of the directory tree for installing architecture-specific
files, like executables and utility programs.  If specified,
- Emacs (and the other utilities users run) go in EXECDIR/bin, and
- The architecture-dependent files go in
  EXECDIR/libexec/emacs/VERSION/CONFIGURATION.
EXECDIR/bin should be a directory that is normally in users' PATHs.

For example, the command

    ./configure --build=i386-linux-gnu --without-sound

configures Emacs to build for a 32-bit GNU/Linux distribution,
without sound support.

431
'configure' doesn't do any compilation or installation itself.
432
It just creates the files that influence those things:
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
'./Makefile' in the top-level directory and several subdirectories;
and './src/config.h'.

When it is done, 'configure' prints a description of what it did and
creates a shell script 'config.status' which, when run, recreates the
same configuration.  If 'configure' exits with an error after
disturbing the status quo, it removes 'config.status'.  'configure'
also creates a file 'config.cache' that saves the results of its tests
to make reconfiguring faster, and a file 'config.log' containing compiler
output (useful mainly for debugging 'configure').  You can give
'configure' the option '--cache-file=FILE' to use the results of the
tests in FILE instead of 'config.cache'.  Set FILE to '/dev/null' to
disable caching, for debugging 'configure'.

If the description of the system configuration printed by 'configure'
448
is not right, or if it claims some of the features or libraries are not
449 450
available when you know they are, look at the 'config.log' file for
the trace of the failed tests performed by 'configure' to check
451 452 453 454 455 456 457
whether these features are supported.  Typically, some test fails
because the compiler cannot find some function in the system
libraries, or some macro-processor definition in the system headers.

Some tests might fail because the compiler should look in special
directories for some header files, or link against optional
libraries, or use special compilation options.  You can force
458
'configure' and the build process which follows it to do that by
459
setting the variables CPPFLAGS, CFLAGS, LDFLAGS, LIBS, CPP and CC
460
before running 'configure'.  CPP is the command which invokes the
461 462 463 464 465
preprocessor, CPPFLAGS lists the options passed to it, CFLAGS are
compilation options, LDFLAGS are options used when linking, LIBS are
libraries to link against, and CC is the command which invokes the
compiler.  By default, gcc is used if available.

466
Here's an example of a 'configure' invocation, assuming a Bourne-like
467 468
shell such as Bash, which uses these variables:

469 470 471
  ./configure \
    CPPFLAGS='-I/foo/myinclude' LDFLAGS='-L/bar/mylib' \
    CFLAGS='-O3' LIBS='-lfoo -lbar'
472

473 474
(this is all one shell command).  This tells 'configure' to instruct the
preprocessor to look in the '/foo/myinclude' directory for header
475
files (in addition to the standard directories), instruct the linker
476
to look in '/bar/mylib' for libraries, pass the -O3 optimization
477 478 479
switch to the compiler, and link against libfoo and libbar
libraries in addition to the standard ones.

480
For some libraries, like Gtk+, fontconfig and ALSA, 'configure' uses
481 482
pkg-config to find where those libraries are installed.
If you want pkg-config to look in special directories, you have to set
483 484
PKG_CONFIG_PATH to point to the directories where the .pc-files for
those libraries are.  For example:
485

486 487
  ./configure \
    PKG_CONFIG_PATH='/usr/local/alsa/lib/pkgconfig:/opt/gtk+-2.8/lib/pkgconfig'
488 489

3b) To build in a separate directory, go to that directory
490
and run the program 'configure' as follows:
491 492 493 494

    SOURCE-DIR/configure CONFIGURATION-NAME [--OPTION[=VALUE]] ...

SOURCE-DIR refers to the top-level Emacs source directory which is
495 496
where Emacs's configure script is located.  'configure' looks for the
Emacs source code in the directory that 'configure' is in.
497

498
4) Put into './lisp/site-init.el' or './lisp/site-load.el' any Emacs
Glenn Morris's avatar
Glenn Morris committed
499 500 501 502 503
Lisp code you want Emacs to load before it is dumped out.  Use
site-load.el for additional libraries if you arrange for their
documentation strings to be in the etc/DOC file (see
src/Makefile.in if you wish to figure out how to do that).  For all
else, use site-init.el.  Do not load byte-compiled code which
504
was built with a non-nil value of 'byte-compile-dynamic'.
Glenn Morris's avatar
Glenn Morris committed
505 506 507 508 509

It is not a good idea to edit the normal .el files that come with Emacs.
Instead, use a file like site-init.el to change settings.

To change the value of a variable that is already defined in Emacs,
510
you should use the Lisp function 'setq', not 'defvar'.  For example,
511 512 513 514 515 516 517 518 519 520 521

     (setq news-inews-program "/usr/bin/inews")

is how you would override the default value of the variable
news-inews-program.

Before you override a variable this way, *look at the value* that the
variable gets by default!  Make sure you know what kind of value the
variable should have.  If you don't pay attention to what you are
doing, you'll make a mistake.

522
The 'site-*.el' files are nonexistent in the distribution.  You do not
523 524
need to create them if you have nothing to put in them.

525
5) Refer to the file './etc/TERMS' for information on fields you may
526 527
wish to add to various termcap entries.  (This is unlikely to be necessary.)

528
6) Run 'make' in the top directory of the Emacs distribution to finish
529
building Emacs in the standard way.  The final executable file is
530
named 'src/emacs'.  You can execute this file "in place" without
531 532 533 534
copying it, if you wish; then it automatically uses the sibling
directories ../lisp, ../lib-src, ../info.

Or you can "install" the executable and the other files into their
535
installed locations, with 'make install'.  By default, Emacs's files
536 537
are installed in the following directories:

538 539
'/usr/local/bin' holds the executable programs users normally run -
		'emacs', 'etags', 'ctags', 'emacsclient'.
540

541 542 543
'/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library;
		'VERSION' stands for the number of the Emacs version
		you are installing, like '23.1' or '23.2'.  Since the
544 545 546 547 548 549
		Lisp library changes from one version of Emacs to
		another, including the version number in the path
		allows you to have several versions of Emacs installed
		at the same time; in particular, you don't have to
		make Emacs unavailable while installing a new version.

550
'/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
551 552 553
		file, and other architecture-independent files Emacs
		might need while running.

554
'/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable
555 556
		programs used by Emacs that users are not expected to
		run themselves.
557 558 559
		'VERSION' is the number of the Emacs version you are
		installing, and 'CONFIGURATION-NAME' is the value
		deduced by the 'configure' program to identify the
560
		architecture and operating system of your machine,
561
		like 'i686-pc-linux-gnu' or 'sparc-sun-sunos'.  Since
562 563 564 565 566 567 568 569
		these files are specific to the version of Emacs,
		operating system, and architecture in use, including
		the configuration name in the path allows you to have
		several versions of Emacs for any mix of machines and
		operating systems installed at the same time; this is
		useful for sites at which different kinds of machines
		share the file system Emacs is installed on.

570
'/usr/local/share/info' holds the on-line documentation for Emacs,
571 572 573 574
		known as "info files".  Many other GNU programs are
		documented using info files as well, so this directory
		stands apart from the other, Emacs-specific directories.

575 576
'/usr/local/share/man/man1' holds the man pages for the programs installed
		in '/usr/local/bin'.
577 578 579 580

Any version of Emacs, whether installed or not, also looks for Lisp
files in these directories.

581
'/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp
582 583
		files installed for Emacs version VERSION only.

584
'/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp
585 586 587
		files installed for all Emacs versions.

		When Emacs is installed, it searches for its Lisp files
588 589 590
		in '/usr/local/share/emacs/VERSION/site-lisp', then in
		'/usr/local/share/emacs/site-lisp', and finally in
		'/usr/local/share/emacs/VERSION/lisp'.
591 592 593

If these directories are not what you want, you can specify where to
install Emacs's libraries and data files or where Emacs should search
594 595
for its Lisp files by giving values for 'make' variables as part of
the command.  See the section below called 'MAKE VARIABLES' for more
596 597
information on this.

598
7) Check the file 'dir' in your site's info directory (usually
599 600 601
/usr/local/share/info) to make sure that it has a menu entry for the
Emacs info files.

Glenn Morris's avatar
Glenn Morris committed
602
8) If your system uses lock files to interlock access to mailer inbox files,
603
and if --with-mailutils is not in effect, then you might need to
604
make the Emacs-specific 'movemail' program setuid or setgid in order
605 606
to enable it to write the lock files.  We believe this is safe.

Glenn Morris's avatar
Glenn Morris committed
607
9) You are done!  You can remove executables and object files from
608 609 610
the build directory by typing 'make clean'.  To also remove the files
that 'configure' created (so you can compile Emacs for a different
configuration), type 'make distclean'.
611 612 613 614 615


MAKE VARIABLES

You can change where the build process installs Emacs and its data
616
files by specifying values for 'make' variables as part of the 'make'
617 618 619 620
command line.  For example, if you type

    make install bindir=/usr/local/gnubin

621 622 623
the 'bindir=/usr/local/gnubin' argument indicates that the Emacs
executable files should go in '/usr/local/gnubin', not
'/usr/local/bin'.
624 625 626

Here is a complete list of the variables you may want to set.

627
'bindir' indicates where to put executable programs that users can
628 629
	run.  This defaults to /usr/local/bin.

630
'datadir' indicates where to put the architecture-independent
631 632
	read-only data files that Emacs refers to while it runs; it
	defaults to /usr/local/share.  We create the following
633 634 635 636 637
	subdirectories under 'datadir':
	- 'emacs/VERSION/lisp', containing the Emacs Lisp library, and
	- 'emacs/VERSION/etc', containing the tutorials, DOC file, etc.
	'VERSION' is the number of the Emacs version you are installing,
	like '23.1' or '23.2'.  Since these files vary from one version
638 639 640 641 642
	of Emacs to another, including the version number in the path
	allows you to have several versions of Emacs installed at the
	same time; this means that you don't have to make Emacs
	unavailable while installing a new version.

643 644 645 646
'libexecdir' indicates where to put architecture-specific data files that
	Emacs refers to as it runs; it defaults to '/usr/local/libexec'.
	We create the following subdirectories under 'libexecdir':
	- 'emacs/VERSION/CONFIGURATION-NAME', containing executable
647 648
		programs used by Emacs that users are not expected to run
		themselves.
649 650 651 652
	'VERSION' is the number of the Emacs version you are installing,
	and 'CONFIGURATION-NAME' is the value deduced by the
	'configure' program to identify the architecture and operating
	system of your machine, like 'i686-pc-linux-gnu' or 'sparc-sun-sunos'.
653 654 655 656 657 658 659 660
	Since these files are specific to the version of Emacs,
	operating system, and architecture in use, including the
	configuration name in the path allows you to have several
	versions of Emacs for any mix of machines and operating
	systems installed at the same time; this is useful for sites
	at which different kinds of machines share the file system
	Emacs is installed on.

661 662
'infodir' indicates where to put the info files distributed with
	Emacs; it defaults to '/usr/local/share/info'.
663

664 665 666
'mandir' indicates where to put the man pages for Emacs and its
	utilities (like 'etags'); it defaults to
	'/usr/local/share/man/man1'.
667

668
'prefix' doesn't give a path for any specific part of Emacs; instead,
669
	its value is used to determine the defaults for all the
670 671 672
	architecture-independent path variables - 'datadir',
	'sharedstatedir', 'infodir', and 'mandir'.  Its default value is
	'/usr/local'; the other variables add on 'lib' or 'man' to it
673 674 675
	by default.

	For example, suppose your site generally places GNU software
676
	under '/usr/users/software/gnusoft' instead of '/usr/local'.
677
	By including
678 679
	    'prefix=/usr/users/software/gnusoft'
	in the arguments to 'make', you can instruct the build process
680 681 682
	to place all of the Emacs data files in the appropriate
	directories under that path.

683
'exec_prefix' serves the same purpose as 'prefix', but instead
684
	determines the default values for the architecture-dependent
685
	path variables - 'bindir' and 'libexecdir'.
686 687

The above variables serve analogous purposes in the makefiles for all
688
GNU software; the following variables are specific to Emacs.
689

690
'archlibdir' indicates where Emacs installs and expects the executable
691
	files and other architecture-dependent data it uses while
692 693
	running.  Its default value, based on 'libexecdir' (which
	see), is '/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME'
694 695
	(where VERSION and CONFIGURATION-NAME are as described above).

696
'GZIP_PROG' is the name of the executable that compresses installed info,
697 698 699
	manual, and .el files.  It defaults to gzip.  Setting it to
	the empty string suppresses compression.

700
Remember that you must specify any variable values you need each time
701 702
you run 'make' in the top directory.  If you run 'make' once to build
emacs, test it, and then run 'make' again to install the files, you
703
must provide the same variable settings each time.  To make the
704 705 706
settings persist, you can edit them into the 'Makefile' in the top
directory, but be aware that running the 'configure' program erases
'Makefile' and rebuilds it from 'Makefile.in'.
707 708 709 710

The path for finding Lisp files is specified in src/epaths.h,
a file which is generated by running configure.  To change the path,
you can edit the definition of PATH_LOADSEARCH in that file
711
before you run 'make'.
712 713 714 715 716 717 718 719

The top-level Makefile stores the variable settings it used in the
Makefiles for the subdirectories, so you don't have to specify them
when running make in the subdirectories.


PROBLEMS

720
See the file './etc/PROBLEMS' for a list of various problems sometimes
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
encountered, and what to do about them.

This file is part of GNU Emacs.

GNU Emacs is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

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
736
along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.