2010-12-03 14:45:09 +00:00
|
|
|
|
GNU Emacs Installation Guide
|
2018-01-01 08:21:42 +00:00
|
|
|
|
Copyright (C) 1992, 1994, 1996-1997, 2000-2018 Free Software Foundation,
|
2015-01-01 22:26:41 +00:00
|
|
|
|
Inc.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
See the end of the file for license conditions.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This file contains general information on building GNU Emacs.
|
2016-11-06 07:33:43 +00:00
|
|
|
|
For more information specific to the MS-Windows, GNUstep/macOS, and
|
2010-12-03 14:45:09 +00:00
|
|
|
|
MS-DOS ports, also read the files nt/INSTALL, nextstep/INSTALL, and
|
2014-01-09 00:10:07 +00:00
|
|
|
|
msdos/INSTALL. For information about building from a repository checkout
|
2014-01-08 23:24:54 +00:00
|
|
|
|
(rather than a release), also read the file INSTALL.REPO.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
BASIC INSTALLATION
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
On most Unix systems, you build Emacs by first running the 'configure'
|
2010-12-03 14:45:09 +00:00
|
|
|
|
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.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'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.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
2017-09-13 22:52:52 +00:00
|
|
|
|
Building Emacs requires GNU make, <https://www.gnu.org/software/make/>.
|
2015-04-19 21:40:51 +00:00
|
|
|
|
On most systems that Emacs supports, this is the default 'make' program.
|
2014-03-27 19:41:57 +00:00
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
Here's the procedure to build Emacs using 'configure' on systems which
|
2010-12-03 14:45:09 +00:00
|
|
|
|
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.
|
|
|
|
|
|
2018-05-03 18:19:07 +00:00
|
|
|
|
1. Unpacking the Emacs release requires about 200 MB of free
|
2014-10-14 21:05:33 +00:00
|
|
|
|
disk space. Building Emacs uses about another 200 MB of space.
|
|
|
|
|
The final installed Emacs uses about 150 MB of disk space.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
This includes the space-saving that comes from automatically
|
|
|
|
|
compressing the Lisp source files on installation.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
2a. 'cd' to the directory where you unpacked Emacs and invoke the
|
|
|
|
|
'configure' script:
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
./configure
|
|
|
|
|
|
|
|
|
|
2b. Alternatively, create a separate directory, outside the source
|
2015-04-19 21:40:51 +00:00
|
|
|
|
directory, where you want to build Emacs, and invoke 'configure'
|
2010-12-03 14:45:09 +00:00
|
|
|
|
from there:
|
|
|
|
|
|
|
|
|
|
SOURCE-DIR/configure
|
|
|
|
|
|
|
|
|
|
where SOURCE-DIR is the top-level Emacs source directory.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
3. When 'configure' finishes, it prints several lines of details
|
2010-12-03 14:45:09 +00:00
|
|
|
|
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.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
If you find anything wrong, you may have to pass to 'configure'
|
2010-12-03 14:45:09 +00:00
|
|
|
|
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.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
If 'configure' didn't find some image support libraries, such as
|
2013-12-16 17:58:25 +00:00
|
|
|
|
Xpm and jpeg, refer to "Image support libraries" below.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
If the details printed by 'configure' don't make any sense to
|
|
|
|
|
you, but there are no obvious errors, assume that 'configure' did
|
2010-12-03 14:45:09 +00:00
|
|
|
|
its job and proceed.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
4. Invoke the 'make' program:
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
make
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
5. If 'make' succeeds, it will build an executable program 'emacs'
|
|
|
|
|
in the 'src' directory. You can try this program, to make sure
|
2010-12-03 14:45:09 +00:00
|
|
|
|
it works:
|
|
|
|
|
|
|
|
|
|
src/emacs -Q
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
6. Assuming that the program 'src/emacs' starts and displays its
|
2010-12-03 14:45:09 +00:00
|
|
|
|
opening screen, you can install the program and its auxiliary
|
|
|
|
|
files into their installation directories:
|
|
|
|
|
|
|
|
|
|
make install
|
|
|
|
|
|
|
|
|
|
You are now ready to use Emacs. If you wish to conserve disk space,
|
|
|
|
|
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.
|
2013-07-09 18:30:24 +00:00
|
|
|
|
If you want to build Emacs again with different configure options,
|
|
|
|
|
first clean the source directories:
|
|
|
|
|
|
|
|
|
|
make distclean
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
Note that the install automatically saves space by compressing
|
2015-04-19 21:40:51 +00:00
|
|
|
|
(provided you have the 'gzip' program) those installed Lisp source (.el)
|
2010-12-03 14:45:09 +00:00
|
|
|
|
files that have corresponding .elc versions, as well as the Info files.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
ADDITIONAL DISTRIBUTION FILES
|
|
|
|
|
|
|
|
|
|
* Complex Text Layout support libraries
|
|
|
|
|
|
2011-09-28 17:49:09 +00:00
|
|
|
|
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
|
2015-04-19 21:40:51 +00:00
|
|
|
|
packages. Note that if there is a separate 'dev' or 'devel' package,
|
2011-09-28 17:49:09 +00:00
|
|
|
|
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,
|
2013-09-20 16:33:46 +00:00
|
|
|
|
you can download the libraries from <http://www.nongnu.org/m17n/>.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
2011-09-28 17:49:09 +00:00
|
|
|
|
Note that Emacs cannot support complex scripts on a TTY, unless the
|
|
|
|
|
terminal includes such a support.
|
|
|
|
|
|
2010-12-03 14:45:09 +00:00
|
|
|
|
* 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
|
|
|
|
|
|
2013-12-16 17:58:25 +00:00
|
|
|
|
Emacs needs libraries to display images, with the exception of PBM and
|
|
|
|
|
XBM images whose support is built-in.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
On some systems, particularly on GNU/Linux, these libraries may
|
2013-12-16 17:58:25 +00:00
|
|
|
|
already be present or available as additional packages. If
|
2015-04-19 21:40:51 +00:00
|
|
|
|
there is a separate 'dev' or 'devel' package, for use at compilation
|
2010-12-03 14:45:09 +00:00
|
|
|
|
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
|
2013-12-16 17:58:25 +00:00
|
|
|
|
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.
|
|
|
|
|
|
2017-09-13 22:52:52 +00:00
|
|
|
|
libXaw3d https://directory.fsf.org/project/xaw3d/
|
2013-12-16 17:58:25 +00:00
|
|
|
|
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/
|
2014-06-05 17:31:41 +00:00
|
|
|
|
librsvg2 for SVG: http://wiki.gnome.org/action/show/Projects/LibRsvg
|
2013-12-16 17:58:25 +00:00
|
|
|
|
|
|
|
|
|
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.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
* 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
|
2017-09-13 22:52:52 +00:00
|
|
|
|
yourself. See <https://www.gnu.org/software/freefont/> for a large
|
2010-12-03 14:45:09 +00:00
|
|
|
|
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
|
2015-04-19 21:40:51 +00:00
|
|
|
|
and graphics libraries, you may need to install the X development
|
2010-12-03 14:45:09 +00:00
|
|
|
|
package(s), and development versions of the jpeg, png, etc. packages.
|
|
|
|
|
|
|
|
|
|
The names of the packages that you need varies according to the
|
|
|
|
|
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
|
2018-09-14 15:54:28 +00:00
|
|
|
|
like 'apt-get build-dep emacs' (on older systems, replace 'emacs' with
|
|
|
|
|
eg 'emacs25'). On Red Hat-based systems, the corresponding command is
|
2018-09-15 07:52:55 +00:00
|
|
|
|
'dnf builddep emacs' (on older systems, use 'yum-builddep' instead).
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
DETAILED BUILDING AND INSTALLATION:
|
|
|
|
|
|
2016-11-06 07:33:43 +00:00
|
|
|
|
(This is for a Unix or Unix-like system. For GNUstep and macOS,
|
2014-10-15 07:02:43 +00:00
|
|
|
|
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.)
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
2014-10-14 21:18:15 +00:00
|
|
|
|
1) See the basic installation summary above for the disk space requirements.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
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
|
2010-12-03 14:45:09 +00:00
|
|
|
|
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
|
2015-04-19 21:40:51 +00:00
|
|
|
|
directory and run the program 'configure' as follows:
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
./configure [--OPTION[=VALUE]] ...
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
If 'configure' cannot determine your system type, try again
|
2010-12-03 14:45:09 +00:00
|
|
|
|
specifying the proper --build, --host options explicitly.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
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
|
2010-12-03 14:45:09 +00:00
|
|
|
|
system has X, and arrange to use it if present.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
The '--x-includes=DIR' and '--x-libraries=DIR' options tell the build
|
2010-12-03 14:45:09 +00:00
|
|
|
|
process where the compiler should look for the include files and
|
2015-04-19 21:40:51 +00:00
|
|
|
|
object libraries used with the X Window System. Normally, 'configure'
|
2010-12-03 14:45:09 +00:00
|
|
|
|
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
|
2015-04-19 21:40:51 +00:00
|
|
|
|
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
|
2014-01-23 02:09:31 +00:00
|
|
|
|
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).
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
2014-05-16 15:49:13 +00:00
|
|
|
|
You can tell configure where to search for GTK by giving it the
|
2014-10-15 02:42:58 +00:00
|
|
|
|
argument PKG_CONFIG='/full/name/of/pkg-config'.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
2012-08-05 12:53:48 +00:00
|
|
|
|
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
|
2012-08-06 21:05:25 +00:00
|
|
|
|
ssh connection. In order to completely prevent the use of D-Bus, configure
|
2015-04-19 21:40:51 +00:00
|
|
|
|
Emacs with the options '--without-dbus --without-gconf --without-gsettings'.
|
2012-08-05 12:53:48 +00:00
|
|
|
|
|
2017-03-17 06:50:37 +00:00
|
|
|
|
To read email via a network protocol like IMAP or POP, you can
|
|
|
|
|
configure Emacs with the option '--with-mailutils', so that it always
|
2017-08-03 02:13:26 +00:00
|
|
|
|
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
|
2017-03-21 19:04:56 +00:00
|
|
|
|
configure options such as --without-pop that provide fine-grained
|
2017-03-17 06:50:37 +00:00
|
|
|
|
control over Emacs 'movemail' construction.
|
|
|
|
|
|
2010-12-03 14:45:09 +00:00
|
|
|
|
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
|
2017-03-17 06:50:37 +00:00
|
|
|
|
POP3 are not supported. While POP3 support is typically enabled,
|
|
|
|
|
whether Emacs actually uses POP3 is controlled by individual users;
|
2017-08-03 02:13:26 +00:00
|
|
|
|
see the Rmail chapter of the Emacs manual. Unless --with-mailutils is
|
2017-10-03 22:42:10 +00:00
|
|
|
|
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.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
For image support you may have to download, build, and install the
|
|
|
|
|
appropriate image support libraries for image types other than XBM and
|
2013-12-16 17:58:25 +00:00
|
|
|
|
PBM, see the list of URLs in "Image support libraries" above.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
(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:
|
|
|
|
|
|
2015-07-24 13:42:08 +00:00
|
|
|
|
--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
|
|
|
|
|
--without-imagemagick for Imagemagick support
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
2014-01-23 02:09:31 +00:00
|
|
|
|
Use --without-toolkit-scroll-bars to disable Motif or Xaw3d scroll bars.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
2014-06-05 00:34:34 +00:00
|
|
|
|
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
|
2013-07-29 11:35:16 +00:00
|
|
|
|
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.
|
2014-06-05 00:34:34 +00:00
|
|
|
|
For example, you can use --without-all --without-x --with-dbus to
|
2017-06-14 07:08:45 +00:00
|
|
|
|
build with D-Bus support and nothing more.
|
2012-08-07 04:16:47 +00:00
|
|
|
|
|
2011-06-07 04:16:37 +00:00
|
|
|
|
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.
|
|
|
|
|
|
2015-11-14 16:20:36 +00:00
|
|
|
|
Use --with-cairo to compile Emacs with Cairo drawing.
|
|
|
|
|
|
2017-06-14 01:19:30 +00:00
|
|
|
|
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.
|
2016-01-16 15:20:34 +00:00
|
|
|
|
|
2012-04-17 21:40:07 +00:00
|
|
|
|
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
|
2016-04-05 14:51:28 +00:00
|
|
|
|
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.
|
2012-04-17 21:40:07 +00:00
|
|
|
|
|
2015-01-11 09:18:15 +00:00
|
|
|
|
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.
|
--enable-silent-warnings now suppresses more chatter.
* INSTALL, etc/NEWS: Document this.
* lib-src/Makefile.in (AM_DEFAULT_VERBOSITY, AM_V_CC, am__v_CC_)
(am__v_CC_0, am__v_CC_1, AM_V_CCLD, am__v_CCLD_, am__v_CCLD_0)
(am__v_CCLD_1): New macros, taken from Automake.
(regex.o, etags${EXEEXT}, ctags${EXEEXT}, ebrowse${EXEEXT})
(profile${EXEEXT}, make-docfile${EXEEXT}, movemail${EXEEXT})
(pop.o, emacsclient${EXEEXT}, emacsclientw${EXEEXT})
(emacsclientw${EXEEXT}, ntlib.o, hexl${EXEEXT})
(update-game-score${EXEEXT}): Use them.
* lwlib/Makefile.in (AM_DEFAULT_VERBOSITY, AM_V_CC, am__v_CC_)
(am__v_CC_0, am__v_CC_1): New macros, taken from Automake.
(.c.o): Use them.
* oldXMenu/Makefile.in (AM_DEFAULT_VERBOSITY, AM_V_CC, am__v_CC_)
(am__v_CC_0, am__v_CC_1): New macros, taken from Automake.
(.c.o): Use them.
* src/Makefile.in (AM_DEFAULT_VERBOSITY, AM_V_CC, am__v_CC_)
(am__v_CC_0, am__v_CC_1, AM_V_CCLD, am__v_CCLD_, am__v_CCLD_0)
(am__v_CCLD_1): New macros, taken from Automake.
(.c.o, .m.o, temacs$(EXEEXT)): Use them.
2014-09-01 09:49:51 +00:00
|
|
|
|
|
2017-08-29 21:52:57 +00:00
|
|
|
|
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
|
|
|
|
|
gold plugin <http://llvm.org/docs/GoldPlugin.html>. Link time
|
|
|
|
|
optimization is not the default as it tends to cause crashes and to
|
|
|
|
|
make Emacs slower.
|
2012-06-28 16:34:05 +00:00
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
The '--prefix=PREFIXDIR' option specifies where the installation process
|
|
|
|
|
should put emacs and its data files. This defaults to '/usr/local'.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
- Emacs (and the other utilities users run) go in PREFIXDIR/bin
|
2015-04-19 21:40:51 +00:00
|
|
|
|
(unless the '--exec-prefix' option says otherwise).
|
2010-12-03 14:45:09 +00:00
|
|
|
|
- The architecture-independent files go in PREFIXDIR/share/emacs/VERSION
|
2015-04-19 21:40:51 +00:00
|
|
|
|
(where VERSION is the version number of Emacs, like '23.2').
|
2010-12-03 14:45:09 +00:00
|
|
|
|
- The architecture-dependent files go in
|
|
|
|
|
PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION
|
|
|
|
|
(where CONFIGURATION is the configuration name, like
|
2015-04-19 21:40:51 +00:00
|
|
|
|
i686-pc-linux-gnu), unless the '--exec-prefix' option says otherwise.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
The '--exec-prefix=EXECDIR' option allows you to specify a separate
|
2010-12-03 14:45:09 +00:00
|
|
|
|
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.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'configure' doesn't do any compilation or installation itself.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
It just creates the files that influence those things:
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'./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'
|
2010-12-03 14:45:09 +00:00
|
|
|
|
is not right, or if it claims some of the features or libraries are not
|
2015-04-19 21:40:51 +00:00
|
|
|
|
available when you know they are, look at the 'config.log' file for
|
|
|
|
|
the trace of the failed tests performed by 'configure' to check
|
2010-12-03 14:45:09 +00:00
|
|
|
|
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
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'configure' and the build process which follows it to do that by
|
2010-12-03 14:45:09 +00:00
|
|
|
|
setting the variables CPPFLAGS, CFLAGS, LDFLAGS, LIBS, CPP and CC
|
2015-04-19 21:40:51 +00:00
|
|
|
|
before running 'configure'. CPP is the command which invokes the
|
2010-12-03 14:45:09 +00:00
|
|
|
|
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.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
Here's an example of a 'configure' invocation, assuming a Bourne-like
|
2010-12-03 14:45:09 +00:00
|
|
|
|
shell such as Bash, which uses these variables:
|
|
|
|
|
|
2014-05-16 15:49:13 +00:00
|
|
|
|
./configure \
|
|
|
|
|
CPPFLAGS='-I/foo/myinclude' LDFLAGS='-L/bar/mylib' \
|
|
|
|
|
CFLAGS='-O3' LIBS='-lfoo -lbar'
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
(this is all one shell command). This tells 'configure' to instruct the
|
|
|
|
|
preprocessor to look in the '/foo/myinclude' directory for header
|
2010-12-03 14:45:09 +00:00
|
|
|
|
files (in addition to the standard directories), instruct the linker
|
2015-04-19 21:40:51 +00:00
|
|
|
|
to look in '/bar/mylib' for libraries, pass the -O3 optimization
|
2010-12-03 14:45:09 +00:00
|
|
|
|
switch to the compiler, and link against libfoo and libbar
|
|
|
|
|
libraries in addition to the standard ones.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
For some libraries, like Gtk+, fontconfig and ALSA, 'configure' uses
|
2010-12-03 14:45:09 +00:00
|
|
|
|
pkg-config to find where those libraries are installed.
|
|
|
|
|
If you want pkg-config to look in special directories, you have to set
|
2014-05-16 15:49:13 +00:00
|
|
|
|
PKG_CONFIG_PATH to point to the directories where the .pc-files for
|
|
|
|
|
those libraries are. For example:
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
2014-05-16 15:49:13 +00:00
|
|
|
|
./configure \
|
|
|
|
|
PKG_CONFIG_PATH='/usr/local/alsa/lib/pkgconfig:/opt/gtk+-2.8/lib/pkgconfig'
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
3b) To build in a separate directory, go to that directory
|
2015-04-19 21:40:51 +00:00
|
|
|
|
and run the program 'configure' as follows:
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
SOURCE-DIR/configure CONFIGURATION-NAME [--OPTION[=VALUE]] ...
|
|
|
|
|
|
|
|
|
|
SOURCE-DIR refers to the top-level Emacs source directory which is
|
2015-04-19 21:40:51 +00:00
|
|
|
|
where Emacs's configure script is located. 'configure' looks for the
|
|
|
|
|
Emacs source code in the directory that 'configure' is in.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
4) Put into './lisp/site-init.el' or './lisp/site-load.el' any Emacs
|
2012-06-27 07:47:56 +00:00
|
|
|
|
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
|
2015-04-19 21:40:51 +00:00
|
|
|
|
was built with a non-nil value of 'byte-compile-dynamic'.
|
2012-06-27 07:47:56 +00:00
|
|
|
|
|
|
|
|
|
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,
|
2015-04-19 21:40:51 +00:00
|
|
|
|
you should use the Lisp function 'setq', not 'defvar'. For example,
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
(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.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
The 'site-*.el' files are nonexistent in the distribution. You do not
|
2010-12-03 14:45:09 +00:00
|
|
|
|
need to create them if you have nothing to put in them.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
5) Refer to the file './etc/TERMS' for information on fields you may
|
2010-12-03 14:45:09 +00:00
|
|
|
|
wish to add to various termcap entries. (This is unlikely to be necessary.)
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
6) Run 'make' in the top directory of the Emacs distribution to finish
|
2010-12-03 14:45:09 +00:00
|
|
|
|
building Emacs in the standard way. The final executable file is
|
2015-04-19 21:40:51 +00:00
|
|
|
|
named 'src/emacs'. You can execute this file "in place" without
|
2010-12-03 14:45:09 +00:00
|
|
|
|
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
|
2015-04-19 21:40:51 +00:00
|
|
|
|
installed locations, with 'make install'. By default, Emacs's files
|
2010-12-03 14:45:09 +00:00
|
|
|
|
are installed in the following directories:
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'/usr/local/bin' holds the executable programs users normally run -
|
|
|
|
|
'emacs', 'etags', 'ctags', 'emacsclient'.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'/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
|
2010-12-03 14:45:09 +00:00
|
|
|
|
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.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
|
2010-12-03 14:45:09 +00:00
|
|
|
|
file, and other architecture-independent files Emacs
|
|
|
|
|
might need while running.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable
|
2010-12-03 14:45:09 +00:00
|
|
|
|
programs used by Emacs that users are not expected to
|
|
|
|
|
run themselves.
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'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
|
2010-12-03 14:45:09 +00:00
|
|
|
|
architecture and operating system of your machine,
|
2015-04-19 21:40:51 +00:00
|
|
|
|
like 'i686-pc-linux-gnu' or 'sparc-sun-sunos'. Since
|
2010-12-03 14:45:09 +00:00
|
|
|
|
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.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'/usr/local/share/info' holds the on-line documentation for Emacs,
|
2010-12-03 14:45:09 +00:00
|
|
|
|
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.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'/usr/local/share/man/man1' holds the man pages for the programs installed
|
|
|
|
|
in '/usr/local/bin'.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
Any version of Emacs, whether installed or not, also looks for Lisp
|
|
|
|
|
files in these directories.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp
|
2010-12-03 14:45:09 +00:00
|
|
|
|
files installed for Emacs version VERSION only.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp
|
2010-12-03 14:45:09 +00:00
|
|
|
|
files installed for all Emacs versions.
|
|
|
|
|
|
|
|
|
|
When Emacs is installed, it searches for its Lisp files
|
2015-04-19 21:40:51 +00:00
|
|
|
|
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'.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
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
|
2015-04-19 21:40:51 +00:00
|
|
|
|
for its Lisp files by giving values for 'make' variables as part of
|
|
|
|
|
the command. See the section below called 'MAKE VARIABLES' for more
|
2010-12-03 14:45:09 +00:00
|
|
|
|
information on this.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
7) Check the file 'dir' in your site's info directory (usually
|
2010-12-03 14:45:09 +00:00
|
|
|
|
/usr/local/share/info) to make sure that it has a menu entry for the
|
|
|
|
|
Emacs info files.
|
|
|
|
|
|
2012-06-27 07:47:56 +00:00
|
|
|
|
8) If your system uses lock files to interlock access to mailer inbox files,
|
2017-08-03 02:13:26 +00:00
|
|
|
|
and if --with-mailutils is not in effect, then you might need to
|
2017-03-17 06:50:37 +00:00
|
|
|
|
make the Emacs-specific 'movemail' program setuid or setgid in order
|
2010-12-03 14:45:09 +00:00
|
|
|
|
to enable it to write the lock files. We believe this is safe.
|
|
|
|
|
|
2012-06-27 07:47:56 +00:00
|
|
|
|
9) You are done! You can remove executables and object files from
|
2015-04-19 21:40:51 +00:00
|
|
|
|
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'.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
MAKE VARIABLES
|
|
|
|
|
|
|
|
|
|
You can change where the build process installs Emacs and its data
|
2015-04-19 21:40:51 +00:00
|
|
|
|
files by specifying values for 'make' variables as part of the 'make'
|
2010-12-03 14:45:09 +00:00
|
|
|
|
command line. For example, if you type
|
|
|
|
|
|
|
|
|
|
make install bindir=/usr/local/gnubin
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
the 'bindir=/usr/local/gnubin' argument indicates that the Emacs
|
|
|
|
|
executable files should go in '/usr/local/gnubin', not
|
|
|
|
|
'/usr/local/bin'.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
Here is a complete list of the variables you may want to set.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'bindir' indicates where to put executable programs that users can
|
2010-12-03 14:45:09 +00:00
|
|
|
|
run. This defaults to /usr/local/bin.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'datadir' indicates where to put the architecture-independent
|
2010-12-03 14:45:09 +00:00
|
|
|
|
read-only data files that Emacs refers to while it runs; it
|
|
|
|
|
defaults to /usr/local/share. We create the following
|
2015-04-19 21:40:51 +00:00
|
|
|
|
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
|
2010-12-03 14:45:09 +00:00
|
|
|
|
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.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'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
|
2010-12-03 14:45:09 +00:00
|
|
|
|
programs used by Emacs that users are not expected to run
|
|
|
|
|
themselves.
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'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'.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
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.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'infodir' indicates where to put the info files distributed with
|
|
|
|
|
Emacs; it defaults to '/usr/local/share/info'.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'mandir' indicates where to put the man pages for Emacs and its
|
|
|
|
|
utilities (like 'etags'); it defaults to
|
|
|
|
|
'/usr/local/share/man/man1'.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'prefix' doesn't give a path for any specific part of Emacs; instead,
|
2010-12-03 14:45:09 +00:00
|
|
|
|
its value is used to determine the defaults for all the
|
2015-04-19 21:40:51 +00:00
|
|
|
|
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
|
2010-12-03 14:45:09 +00:00
|
|
|
|
by default.
|
|
|
|
|
|
|
|
|
|
For example, suppose your site generally places GNU software
|
2015-04-19 21:40:51 +00:00
|
|
|
|
under '/usr/users/software/gnusoft' instead of '/usr/local'.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
By including
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'prefix=/usr/users/software/gnusoft'
|
|
|
|
|
in the arguments to 'make', you can instruct the build process
|
2010-12-03 14:45:09 +00:00
|
|
|
|
to place all of the Emacs data files in the appropriate
|
|
|
|
|
directories under that path.
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'exec_prefix' serves the same purpose as 'prefix', but instead
|
2010-12-03 14:45:09 +00:00
|
|
|
|
determines the default values for the architecture-dependent
|
2015-04-19 21:40:51 +00:00
|
|
|
|
path variables - 'bindir' and 'libexecdir'.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
The above variables serve analogous purposes in the makefiles for all
|
2013-03-06 06:26:55 +00:00
|
|
|
|
GNU software; the following variables are specific to Emacs.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'archlibdir' indicates where Emacs installs and expects the executable
|
2010-12-03 14:45:09 +00:00
|
|
|
|
files and other architecture-dependent data it uses while
|
2015-04-19 21:40:51 +00:00
|
|
|
|
running. Its default value, based on 'libexecdir' (which
|
|
|
|
|
see), is '/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME'
|
2010-12-03 14:45:09 +00:00
|
|
|
|
(where VERSION and CONFIGURATION-NAME are as described above).
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
'GZIP_PROG' is the name of the executable that compresses installed info,
|
2013-03-06 06:26:55 +00:00
|
|
|
|
manual, and .el files. It defaults to gzip. Setting it to
|
|
|
|
|
the empty string suppresses compression.
|
|
|
|
|
|
2010-12-03 14:45:09 +00:00
|
|
|
|
Remember that you must specify any variable values you need each time
|
2015-04-19 21:40:51 +00:00
|
|
|
|
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
|
2010-12-03 14:45:09 +00:00
|
|
|
|
must provide the same variable settings each time. To make the
|
2015-04-19 21:40:51 +00:00
|
|
|
|
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'.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
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
|
2015-04-19 21:40:51 +00:00
|
|
|
|
before you run 'make'.
|
2010-12-03 14:45:09 +00:00
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
2015-04-19 21:40:51 +00:00
|
|
|
|
See the file './etc/PROBLEMS' for a list of various problems sometimes
|
2010-12-03 14:45:09 +00:00
|
|
|
|
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
|
2017-09-13 22:52:52 +00:00
|
|
|
|
along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
|