1993-05-28 04:47:23 +00:00
|
|
|
GNU Emacs Installation Guide
|
1997-09-12 22:46:14 +00:00
|
|
|
Copyright (c) 1992, 1994, 1996, 1997 Free software Foundation, Inc.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
|
|
|
Permission is granted to anyone to make or distribute verbatim copies
|
|
|
|
of this document as received, in any medium, provided that the
|
|
|
|
copyright notice and permission notice are preserved,
|
|
|
|
and that the distributor grants the recipient permission
|
|
|
|
for further redistribution as permitted by this notice.
|
|
|
|
|
|
|
|
Permission is granted to distribute modified versions
|
|
|
|
of this document, or of portions of it,
|
|
|
|
under the above conditions, provided also that they
|
|
|
|
carry prominent notices stating who last changed them,
|
|
|
|
and that any new or changed statements about the activities
|
|
|
|
of the Free Software Foundation are approved by the Foundation.
|
|
|
|
|
|
|
|
|
1997-07-28 01:19:19 +00:00
|
|
|
ADDITIONAL DISTRIBUTION FILES
|
|
|
|
|
|
|
|
* leim-M.N.tar.gz
|
|
|
|
|
|
|
|
The Emacs Lisp code for input methods for various international
|
|
|
|
character scripts is distributed in a separate tar file because of its
|
|
|
|
large size. This file is called leim-M.N.tar.gz, with the same
|
|
|
|
version number as Emacs, and it unpacks into the directory
|
|
|
|
emacs-M.N/leim. Thus, if you unpack it in the same directory where
|
|
|
|
you unpacked the Emacs distribution, it fills in a subdirectory
|
|
|
|
of the Emacs distribution.
|
|
|
|
|
|
|
|
If you have already unpacked the Leim tar file into a subdirectory of
|
|
|
|
the Emacs sources, building and installing Emacs automatically
|
|
|
|
installs the input method support as well. If you unpack the Leim tar
|
|
|
|
file into the Emacs sources after building and installing Emacs, just
|
|
|
|
build Emacs again and install it again.
|
|
|
|
|
|
|
|
* intlfonts-VERSION.tar.gz
|
|
|
|
|
|
|
|
The intlfonts distribution contains X11 fonts that Emacs needs in
|
|
|
|
order 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
|
1997-09-12 22:46:14 +00:00
|
|
|
it. You might find a font in the intlfonts distribution. If some
|
|
|
|
characters don't look right, or appear improperly aligned, a font
|
1997-11-07 18:58:27 +00:00
|
|
|
from the intlfonts distribution might look better.
|
1997-09-12 22:46:14 +00:00
|
|
|
|
1999-01-14 11:25:35 +00:00
|
|
|
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.
|
|
|
|
|
1997-09-12 22:46:14 +00:00
|
|
|
The intlfonts distribution contains its own installation instructions,
|
|
|
|
in the intlfonts/README file.
|
1997-07-28 01:19:19 +00:00
|
|
|
|
|
|
|
|
1993-05-28 04:47:23 +00:00
|
|
|
BUILDING AND INSTALLATION:
|
1996-05-11 10:52:47 +00:00
|
|
|
|
|
|
|
(This is for a Unix or Unix-like system. For MSDOS, see below; search
|
|
|
|
for MSDOG. For Windows NT or Windows 95, see the file nt/INSTALL.)
|
1993-05-28 04:47:23 +00:00
|
|
|
|
|
|
|
1) Make sure your system has enough swapping space allocated to handle
|
|
|
|
a program whose pure code is 900k bytes and whose data area is at
|
|
|
|
least 400k and can reach 8Mb or more. If the swapping space is
|
|
|
|
insufficient, you will get an error in the command `temacs -batch -l
|
1995-11-30 01:17:25 +00:00
|
|
|
loadup dump', found in `./src/Makefile.in', or possibly when
|
1994-02-24 19:15:08 +00:00
|
|
|
running the final dumped Emacs.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
1995-07-20 20:32:25 +00:00
|
|
|
Building Emacs requires about 70 Mb of disk space (including the Emacs
|
|
|
|
sources). Once installed, Emacs occupies about 35 Mb in the file
|
1994-02-24 19:15:08 +00:00
|
|
|
system where it is installed; this includes the executable files, Lisp
|
|
|
|
libraries, miscellaneous data files, and on-line documentation. If
|
|
|
|
the building and installation take place in different directories,
|
1995-07-20 20:32:25 +00:00
|
|
|
then the installation procedure momentarily requires 70+35 Mb.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
|
|
|
2) Consult `./etc/MACHINES' to see what configuration name you should
|
1994-10-31 14:54:47 +00:00
|
|
|
give to the `configure' program. That file offers hints for
|
1993-05-28 04:47:23 +00:00
|
|
|
getting around some possible installation problems.
|
|
|
|
|
1996-09-24 06:56:29 +00:00
|
|
|
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
|
|
|
|
directory and run the program `configure' as follows:
|
1993-05-28 04:47:23 +00:00
|
|
|
|
1998-05-26 20:50:52 +00:00
|
|
|
./configure [CONFIGURATION-NAME] [--OPTION[=VALUE]] ...
|
1993-05-28 04:47:23 +00:00
|
|
|
|
|
|
|
The CONFIGURATION-NAME argument should be a configuration name given
|
1998-05-26 20:50:52 +00:00
|
|
|
in `./etc/MACHINES', with the system version number added at the end.
|
|
|
|
|
|
|
|
You should try first omitting CONFIGURATION-NAME. This way,
|
|
|
|
`configure' will try to guess your system type. If it cannot guess,
|
|
|
|
or if something goes wrong in building or installing Emacs this way,
|
|
|
|
try again specifying the proper CONFIGURATION-NAME explicitly.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
1994-10-31 14:54:47 +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
|
|
|
|
system has X, and arrange to use it if present.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
|
|
|
The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build
|
|
|
|
process where the compiler should look for the include files and
|
1994-10-31 14:54:47 +00:00
|
|
|
object libraries used with the X Window System. Normally, `configure'
|
|
|
|
is able to find them; these options are necessary if you have your X
|
1995-05-31 19:46:12 +00:00
|
|
|
Window System files installed in unusual places. These options also
|
|
|
|
accept a list of directories, separated with colons.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
1994-10-31 14:54:47 +00:00
|
|
|
To get more attractive menus, you can specify an X toolkit when you
|
|
|
|
configure Emacs; use the option `--with-x-toolkit=TOOLKIT', where
|
|
|
|
TOOLKIT is `athena' or `motif' (`yes' and `lucid' are synonyms for
|
|
|
|
`athena'). On some systems, it does not work to use a toolkit with
|
|
|
|
shared libraries.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
|
|
|
The `--with-gcc' option specifies that the build process should
|
|
|
|
compile Emacs using GCC. If you don't want to use GCC, specify
|
1994-10-31 14:54:47 +00:00
|
|
|
`--with-gcc=no'. If you omit this option, `configure' will search
|
|
|
|
for GCC in your path, and use it if present.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
1996-08-26 17:58:30 +00:00
|
|
|
If you want the Emacs mail reader RMAIL to read mail from a POP
|
|
|
|
server, you must specify `--with-pop'. This provides support for the
|
|
|
|
POP3 protocol; older versions are not supported. For
|
|
|
|
Kerberos-authenticated POP add `--with-kerberos', for Hesiod support
|
|
|
|
add `--with-hesiod'. These options enable Emacs to use POP; whether
|
|
|
|
Emacs uses POP is controlled by individual users--see the Rmail
|
|
|
|
chapter of the Emacs manual.
|
|
|
|
|
1993-05-28 04:47:23 +00:00
|
|
|
The `--prefix=PREFIXDIR' option specifies where the installation process
|
|
|
|
should put emacs and its data files. This defaults to `/usr/local'.
|
|
|
|
- Emacs (and the other utilities users run) go in PREFIXDIR/bin
|
|
|
|
(unless the `--exec-prefix' option says otherwise).
|
1994-10-31 14:54:47 +00:00
|
|
|
- The architecture-independent files go in PREFIXDIR/share/emacs/VERSION
|
|
|
|
(where VERSION is the version number of Emacs, like `19.27').
|
1993-05-28 04:47:23 +00:00
|
|
|
- The architecture-dependent files go in
|
1994-10-31 14:54:47 +00:00
|
|
|
PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION
|
1993-05-28 04:47:23 +00:00
|
|
|
(where CONFIGURATION is the configuration name, like mips-dec-ultrix4.2),
|
|
|
|
unless the `--exec-prefix' option says otherwise.
|
|
|
|
|
|
|
|
The `--exec-prefix=EXECDIR' option allows you to specify a separate
|
|
|
|
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
|
1994-10-31 14:54:47 +00:00
|
|
|
EXECDIR/libexec/emacs/VERSION/CONFIGURATION.
|
1993-05-28 04:47:23 +00:00
|
|
|
EXECDIR/bin should be a directory that is normally in users' PATHs.
|
|
|
|
|
|
|
|
For example, the command
|
|
|
|
|
|
|
|
./configure mips-dec-ultrix --with-x11
|
|
|
|
|
|
|
|
configures Emacs to build for a DECstation running Ultrix, with
|
|
|
|
support for the X11 window system.
|
|
|
|
|
1994-10-31 14:54:47 +00:00
|
|
|
`configure' doesn't do any compilation or installation
|
1993-05-28 04:47:23 +00:00
|
|
|
itself. It just creates the files that influence those things:
|
1994-10-13 00:02:32 +00:00
|
|
|
`./Makefile', `lib-src/Makefile', `oldXMenu/Makefile',
|
|
|
|
`lwlib/Makefile', `src/Makefile', and `./src/config.h'. For details
|
|
|
|
on exactly what it does, see the section called `CONFIGURATION BY
|
|
|
|
HAND', below.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
|
|
|
When it is done, `configure' prints a description of what it did and
|
1994-10-31 14:54:47 +00:00
|
|
|
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'.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
|
|
|
The work of `configure' can be done by editing various files in the
|
1996-09-24 06:56:29 +00:00
|
|
|
distribution, but using `configure' is easier. See the section called
|
|
|
|
"CONFIGURATION BY HAND" below if you want to do the configuration
|
|
|
|
yourself.
|
|
|
|
|
|
|
|
3b) To build in a separate directory, go to that directory
|
|
|
|
and run the program `configure' as follows:
|
|
|
|
|
|
|
|
SOURCE-DIR/configure CONFIGURATION-NAME [--OPTION[=VALUE]] ...
|
|
|
|
|
|
|
|
SOURCE-DIR refers to the top-level Emacs source directory which is
|
|
|
|
where Emacs's configure script is located. `configure' looks for the
|
|
|
|
Emacs source code in the directory that `configure' is in.
|
|
|
|
|
|
|
|
To build in a separate directory, you must use a version of `make'
|
|
|
|
that supports the `VPATH' variable, such as GNU `make'.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
1998-04-21 06:14:05 +00:00
|
|
|
3c) Some people try to build in a separate directory by filling
|
|
|
|
it full of symlinks to the files in the real source directory.
|
1998-04-21 06:13:36 +00:00
|
|
|
If you do that, `make all' does work, but `make install' fails:
|
|
|
|
it copies the symbolic links rather than the actual files.
|
|
|
|
|
|
|
|
As far as is known, there is no particular reason to use
|
|
|
|
a directory full of links rather than use the standard GNU
|
|
|
|
facilities to build in a separate directory (see 3b above).
|
|
|
|
|
1993-05-28 04:47:23 +00:00
|
|
|
4) Look at `./lisp/paths.el'; if some of those values are not right
|
1995-05-24 20:50:54 +00:00
|
|
|
for your system, set up the file `./lisp/site-init.el' with Emacs
|
|
|
|
Lisp code to override them; it is not a good idea to edit paths.el
|
1993-05-28 04:47:23 +00:00
|
|
|
itself. YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES,
|
|
|
|
rather than `defvar', as used by `./lisp/paths.el'. For example,
|
|
|
|
|
|
|
|
(setq news-inews-program "/usr/bin/inews")
|
|
|
|
|
|
|
|
is how you would override the default value of the variable
|
|
|
|
news-inews-program (which is "/usr/local/inews").
|
|
|
|
|
1995-03-25 18:07:05 +00:00
|
|
|
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.
|
|
|
|
|
1994-02-24 19:15:08 +00:00
|
|
|
5) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs
|
|
|
|
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
|
1995-11-30 01:17:25 +00:00
|
|
|
src/Makefile.in if you wish to figure out how to do that). For all
|
1998-09-27 12:37:22 +00:00
|
|
|
else, use site-init.el. Do not load byte-compiled code which
|
|
|
|
was build with a non-nil value of `byte-compile-dynamic'.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
1995-05-07 04:36:44 +00:00
|
|
|
If you set load-path to a different value in site-init.el or
|
|
|
|
site-load.el, Emacs will use *precisely* that value when it starts up
|
|
|
|
again. If you do this, you are on your own!
|
1995-02-06 22:48:58 +00:00
|
|
|
|
1993-05-28 04:47:23 +00:00
|
|
|
Note that, on some systems, the code you place in site-init.el must
|
|
|
|
not use expand-file-name or any other function which may look
|
|
|
|
something up in the system's password and user information database.
|
1998-03-07 22:31:13 +00:00
|
|
|
See `./etc/PROBLEMS' for more details on which systems this affects.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
1994-05-22 19:56:27 +00:00
|
|
|
The `site-*.el' files are nonexistent in the distribution. You do not
|
|
|
|
need to create them if you have nothing to put in them.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
|
|
|
6) Refer to the file `./etc/TERMS' for information on fields you may
|
|
|
|
wish to add to various termcap entries. The files `./etc/termcap.ucb'
|
|
|
|
and `./etc/termcap.dat' may already contain appropriately-modified
|
|
|
|
entries.
|
|
|
|
|
|
|
|
7) Run `make' in the top directory of the Emacs distribution to finish
|
1995-05-07 06:13:58 +00:00
|
|
|
building Emacs in the standard way. The final executable file is
|
|
|
|
named `src/emacs'. You can execute this file "in place" without
|
|
|
|
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 Emacs into their
|
|
|
|
installed locations, with `make install'. By default, Emacs's files
|
|
|
|
are installed in the following directories:
|
1993-05-28 04:47:23 +00:00
|
|
|
|
|
|
|
`/usr/local/bin' holds the executable programs users normally run -
|
1994-06-13 15:30:51 +00:00
|
|
|
`emacs', `etags', `ctags', `b2m', `emacsclient',
|
|
|
|
and `rcs-checkin'.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
1994-10-31 14:54:47 +00:00
|
|
|
`/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library;
|
1993-05-28 04:47:23 +00:00
|
|
|
`VERSION' stands for the number of the Emacs version
|
1994-10-31 14:54:47 +00:00
|
|
|
you are installing, like `18.59' or `19.27'. Since the
|
1996-01-11 17:05:41 +00:00
|
|
|
Lisp library changes from one version of Emacs to
|
1993-05-28 04:47:23 +00:00
|
|
|
another, including the version number in the path
|
|
|
|
allows you to have several versions of Emacs installed
|
1996-01-11 17:05:41 +00:00
|
|
|
at the same time; in particular, you don't have to
|
|
|
|
make Emacs unavailable while installing a new version.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
1996-01-11 17:05:41 +00:00
|
|
|
`/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp
|
|
|
|
files installed for Emacs version VERSION only.
|
|
|
|
|
|
|
|
`/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp
|
|
|
|
files installed for all Emacs versions.
|
|
|
|
|
|
|
|
When Emacs is installed, it searches for its Lisp files
|
|
|
|
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'.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
1994-10-31 14:54:47 +00:00
|
|
|
`/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
|
1993-05-28 04:47:23 +00:00
|
|
|
file, the `yow' database, and other
|
|
|
|
architecture-independent files Emacs might need while
|
|
|
|
running. VERSION is as specified for `.../lisp'.
|
|
|
|
|
1994-10-31 14:54:47 +00:00
|
|
|
`/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable
|
1993-05-28 04:47:23 +00:00
|
|
|
programs used by Emacs that users are not expected to
|
|
|
|
run themselves.
|
|
|
|
`VERSION' is the number of the Emacs version you are
|
|
|
|
installing, and `CONFIGURATION-NAME' is the argument
|
|
|
|
you gave to the `configure' program to identify the
|
|
|
|
architecture and operating system of your machine,
|
|
|
|
like `mips-dec-ultrix' or `sparc-sun-sunos'. 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.
|
|
|
|
|
|
|
|
`/usr/local/info' holds the on-line documentation for Emacs, 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.
|
|
|
|
|
|
|
|
`/usr/local/man/man1' holds the man pages for the programs installed
|
|
|
|
in `/usr/local/bin'.
|
|
|
|
|
|
|
|
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
|
1996-01-11 17:05:41 +00:00
|
|
|
for its Lisp files by giving values for `make' variables as part of
|
1993-05-28 04:47:23 +00:00
|
|
|
the command. See the section below called `MAKE VARIABLES' for more
|
|
|
|
information on this.
|
|
|
|
|
|
|
|
8) Check the file `dir' in your site's info directory (usually
|
|
|
|
/usr/local/info) to make sure that it has a menu entry for the Emacs
|
|
|
|
info files.
|
|
|
|
|
1994-02-24 19:15:08 +00:00
|
|
|
9) If your system uses lock files to interlock access to mailer inbox files,
|
1994-10-31 14:54:47 +00:00
|
|
|
then you might need to make the movemail program setuid or setgid
|
1994-02-24 19:15:08 +00:00
|
|
|
to enable it to write the lock files. We believe this is safe.
|
|
|
|
|
1995-07-20 20:32:25 +00:00
|
|
|
10) You are done! You can remove executables and object files from
|
|
|
|
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'.
|
|
|
|
|
1993-05-28 04:47:23 +00:00
|
|
|
|
|
|
|
|
|
|
|
MAKE VARIABLES
|
|
|
|
|
|
|
|
You can change where the build process installs Emacs and its data
|
|
|
|
files by specifying values for `make' variables as part of the `make'
|
|
|
|
command line. For example, if you type
|
|
|
|
|
|
|
|
make install bindir=/usr/local/gnubin
|
|
|
|
|
|
|
|
the `bindir=/usr/local/gnubin' argument indicates that the Emacs
|
|
|
|
executable files should go in `/usr/local/gnubin', not
|
|
|
|
`/usr/local/bin'.
|
|
|
|
|
|
|
|
Here is a complete list of the variables you may want to set.
|
|
|
|
|
|
|
|
`bindir' indicates where to put executable programs that users can
|
|
|
|
run. This defaults to /usr/local/bin.
|
|
|
|
|
|
|
|
`datadir' indicates where to put the architecture-independent
|
|
|
|
read-only data files that Emacs refers to while it runs; it
|
1994-10-13 00:02:32 +00:00
|
|
|
defaults to /usr/local/share. We create the following
|
1993-05-28 04:47:23 +00:00
|
|
|
subdirectories under `datadir':
|
1996-01-11 17:05:41 +00:00
|
|
|
- `emacs/VERSION/lisp', containing the Emacs Lisp library, and
|
1993-05-28 04:47:23 +00:00
|
|
|
- `emacs/VERSION/etc', containing the Emacs tutorial, the DOC
|
|
|
|
file, and the `yow' database.
|
|
|
|
`VERSION' is the number of the Emacs version you are installing,
|
|
|
|
like `18.59' or `19.0'. Since these files vary 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; this means that you don't have to make Emacs
|
|
|
|
unavailable while installing a new version.
|
|
|
|
|
1994-10-13 00:02:32 +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':
|
1993-05-28 04:47:23 +00:00
|
|
|
- `emacs/VERSION/CONFIGURATION-NAME', containing executable
|
|
|
|
programs used by Emacs that users are not expected to run
|
|
|
|
themselves.
|
|
|
|
`VERSION' is the number of the Emacs version you are installing,
|
|
|
|
and `CONFIGURATION-NAME' is the argument you gave to the
|
|
|
|
`configure' program to identify the architecture and operating
|
|
|
|
system of your machine, like `mips-dec-ultrix' or
|
|
|
|
`sparc-sun-sunos'. 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.
|
|
|
|
|
|
|
|
`infodir' indicates where to put the info files distributed with
|
|
|
|
Emacs; it defaults to `/usr/local/info'.
|
|
|
|
|
|
|
|
`mandir' indicates where to put the man pages for Emacs and its
|
|
|
|
utilities (like `etags'); it defaults to
|
|
|
|
`/usr/local/man/man1'.
|
|
|
|
|
|
|
|
`manext' gives the extension the man pages should be installed with.
|
|
|
|
It should contain a period, followed by the appropriate
|
|
|
|
digit. It defaults to `.1'. For example given the default
|
|
|
|
values for `mandir' and `manext', the Emacs man page would be
|
|
|
|
installed as `/usr/local/man/man1/emacs.1'.
|
|
|
|
|
|
|
|
`prefix' doesn't give a path for any specific part of Emacs; instead,
|
|
|
|
its value is used to determine the defaults for all the
|
|
|
|
architecture-independent path variables - `datadir',
|
1994-10-13 00:02:32 +00:00
|
|
|
`sharedstatedir', `infodir', and `mandir'. Its default value is
|
1993-05-28 04:47:23 +00:00
|
|
|
`/usr/local'; the other variables add on `lib' or `man' to it
|
|
|
|
by default.
|
|
|
|
|
|
|
|
For example, suppose your site generally places GNU software
|
|
|
|
under `/usr/users/software/gnusoft' instead of `/usr/local'.
|
|
|
|
By including
|
|
|
|
`prefix=/usr/users/software/gnusoft'
|
|
|
|
in the arguments to `make', you can instruct the build process
|
|
|
|
to place all of the Emacs data files in the appropriate
|
|
|
|
directories under that path.
|
|
|
|
|
|
|
|
`exec_prefix' serves the same purpose as `prefix', but instead
|
|
|
|
determines the default values for the architecture-dependent
|
1994-10-13 00:02:32 +00:00
|
|
|
path variables - `bindir' and `libexecdir'.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
|
|
|
The above variables serve analogous purposes in the makefiles for all
|
1998-04-03 01:52:38 +00:00
|
|
|
GNU software; this variable is specific to Emacs.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
1995-07-20 20:32:25 +00:00
|
|
|
`archlibdir' indicates where Emacs installs and expects the executable
|
|
|
|
files and other architecture-dependent data it uses while
|
|
|
|
running. Its default value, based on `libexecdir' (which
|
|
|
|
see), is `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME'
|
1993-05-28 04:47:23 +00:00
|
|
|
(where VERSION and CONFIGURATION-NAME are as described above).
|
|
|
|
|
|
|
|
Remember that you must specify any variable values you need each time
|
|
|
|
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
|
|
|
|
must provide the same variable settings each time. To make the
|
|
|
|
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'.
|
|
|
|
|
1998-04-03 01:52:38 +00:00
|
|
|
The path for finding Lisp files is specified in src/paths.h,
|
|
|
|
a file which is generated by running configure. To change the path,
|
|
|
|
you can edit the definition of PATH_LOADSEARCH in that file
|
|
|
|
before you run `make'.
|
|
|
|
|
1993-05-28 04:47:23 +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.
|
|
|
|
|
|
|
|
|
|
|
|
CONFIGURATION BY HAND
|
|
|
|
|
1994-06-13 15:30:51 +00:00
|
|
|
Instead of running the `configure' program, you have to perform the
|
|
|
|
following steps.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
1995-11-30 01:17:25 +00:00
|
|
|
1) Copy `./src/config.in' to `./src/config.h'.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
|
|
|
2) Consult `./etc/MACHINES' to see what configuration name you should
|
|
|
|
use for your system. Look at the code of the `configure' script to
|
|
|
|
see which operating system and architecture description files from
|
|
|
|
`src/s' and `src/m' should be used for that configuration name. Edit
|
|
|
|
`src/config.h', and change the two `#include' directives to include
|
|
|
|
the appropriate system and architecture description files.
|
|
|
|
|
|
|
|
2) Edit `./src/config.h' to set the right options for your system. If
|
|
|
|
you need to override any of the definitions in the s/*.h and m/*.h
|
|
|
|
files for your system and machine, do so by editing config.h, not by
|
|
|
|
changing the s/*.h and m/*.h files. Occasionally you may need to
|
|
|
|
redefine parameters used in `./lib-src/movemail.c'.
|
|
|
|
|
1994-06-13 15:30:51 +00:00
|
|
|
3) Create src/Makefile and lib-src/Makefile from the corresponding
|
1995-11-30 01:17:25 +00:00
|
|
|
`Makefile.in' files. First copy `Makefile.in' to `Makefile.c',
|
1996-01-05 00:49:06 +00:00
|
|
|
then edit in appropriate substitutions for the @...@ constructs,
|
1994-06-13 15:30:51 +00:00
|
|
|
and then copy the shell commands near the end of `configure'
|
|
|
|
that run cpp to construct `Makefile'.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
1994-06-13 15:30:51 +00:00
|
|
|
4) Create `Makefile' files in various other directories
|
|
|
|
from the corresponding `Makefile.in' files. This isn't so hard,
|
|
|
|
just a matter of substitution.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
|
|
|
The `configure' script is built from `configure.in' by the `autoconf'
|
1994-10-31 14:54:47 +00:00
|
|
|
program. You need version 2.0 or newer of `autoconf' to rebuild `configure'.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
|
|
|
BUILDING GNU EMACS BY HAND
|
|
|
|
|
1994-10-13 04:05:41 +00:00
|
|
|
Once Emacs is configured, running `make' in the top directory performs
|
|
|
|
the following steps.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
|
|
|
1) Run `make src/paths.h' in the top directory. This produces
|
1995-11-30 01:17:25 +00:00
|
|
|
`./src/paths.h' from the template file `./src/paths.in', changing
|
1993-05-28 04:47:23 +00:00
|
|
|
the paths to the values specified in `./Makefile'.
|
|
|
|
|
1994-06-13 15:30:51 +00:00
|
|
|
2) Go to directory `./lib-src' and run `make'. This creates
|
|
|
|
executables named `ctags' and `etags' and `wakeup' and `make-docfile'
|
|
|
|
and `digest-doc' and `test-distrib'. And others.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
1994-06-13 15:30:51 +00:00
|
|
|
3) Go to directory `./src' and Run `make'. This refers to files in
|
|
|
|
the `./lisp' and `./lib-src' subdirectories using names `../lisp' and
|
1993-05-28 04:47:23 +00:00
|
|
|
`../lib-src'.
|
|
|
|
|
|
|
|
This creates a file `./src/emacs' which is the runnable Emacs,
|
1994-06-13 15:30:51 +00:00
|
|
|
which has another name that contains a version number.
|
|
|
|
Each time you do this, that version number increments in the last place.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
|
|
|
It also creates a file in `./etc' whose name is `DOC' followed by the
|
|
|
|
current Emacs version. This file contains documentation strings for
|
|
|
|
all the functions in Emacs. Each time you run make to make a new
|
|
|
|
emacs, a new DOC file with a new name is made. You must keep the DOC
|
|
|
|
file for an Emacs version as long as you keep using that Emacs
|
|
|
|
version.
|
|
|
|
|
|
|
|
|
|
|
|
INSTALLATION BY HAND
|
|
|
|
|
1994-10-13 04:05:41 +00:00
|
|
|
The steps below are done by running `make install' in the main
|
|
|
|
directory of the Emacs distribution.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
|
|
|
1) Copy `./lisp' and its subdirectories, `./etc', and the executables
|
|
|
|
in `./lib-src' to their final destinations, as selected in `./src/paths.h'.
|
|
|
|
|
|
|
|
Strictly speaking, not all of the executables in `./lib-src' need be copied.
|
1994-05-22 19:56:27 +00:00
|
|
|
- The programs `cvtmail', `emacsserver', `fakemail', `hexl',
|
1994-06-13 15:30:51 +00:00
|
|
|
`movemail', `profile', `rcs2log', `timer', `vcdiff', `wakeup',
|
|
|
|
and `yow' are used by Emacs; they do need to be copied.
|
|
|
|
- The programs `etags', `ctags', `emacsclient', `b2m', and `rcs-checkin'
|
1993-05-28 04:47:23 +00:00
|
|
|
are intended to be run by users; they are handled below.
|
1994-10-12 23:32:33 +00:00
|
|
|
- The programs `make-docfile' and `test-distrib' were
|
1993-05-28 04:47:23 +00:00
|
|
|
used in building Emacs, and are not needed any more.
|
|
|
|
- The programs `digest-doc' and `sorted-doc' convert a `DOC' file into
|
|
|
|
a file for users to read. There is no important reason to move them.
|
|
|
|
|
|
|
|
2) Copy the files in `./info' to the place specified in
|
|
|
|
`./lisp/site-init.el' or `./lisp/paths.el'. Note that if the
|
|
|
|
destination directory already contains a file named `dir', you
|
|
|
|
probably don't want to replace it with the `dir' file in the Emacs
|
|
|
|
distribution. Instead, you should make sure that the existing `dir'
|
|
|
|
file contains an appropriate menu entry for the Emacs info.
|
|
|
|
|
1998-09-30 19:07:17 +00:00
|
|
|
3) Copy `./src/emacs' to `/usr/local/bin', or to some other directory
|
1993-05-28 04:47:23 +00:00
|
|
|
in users' search paths. `./src/emacs' has an alternate name
|
|
|
|
`./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named
|
|
|
|
`/usr/local/bin/emacs' pointing to that alternate name, as an easy way
|
|
|
|
of installing different versions.
|
|
|
|
|
|
|
|
You can delete `./src/temacs'.
|
|
|
|
|
1998-09-30 19:07:17 +00:00
|
|
|
4) Copy the programs `b2m', `emacsclient', `ctags', `etags', and
|
1994-06-13 15:30:51 +00:00
|
|
|
`rcs-checkin' from `./lib-src' to `/usr/local/bin'. These programs are
|
1993-05-28 04:47:23 +00:00
|
|
|
intended for users to run.
|
|
|
|
|
1998-09-30 19:07:17 +00:00
|
|
|
5) Copy the man pages in `./etc' for emacs, ctags, and etags into the
|
1993-05-28 04:47:23 +00:00
|
|
|
appropriate man directories.
|
|
|
|
|
1998-09-30 19:07:17 +00:00
|
|
|
6) The files in the `./src' subdirectory, except for `emacs', are not
|
1994-06-13 15:30:51 +00:00
|
|
|
used by Emacs once it is built. However, it is very desirable to keep
|
|
|
|
the source on line for debugging.
|
1993-05-28 04:47:23 +00:00
|
|
|
|
|
|
|
|
|
|
|
PROBLEMS
|
|
|
|
|
1998-03-07 22:31:13 +00:00
|
|
|
See the file PROBLEMS in etc subdirectory for a list of various
|
1993-05-28 04:47:23 +00:00
|
|
|
problems sometimes encountered, and what to do about them.
|
|
|
|
|
|
|
|
|
1994-02-24 19:15:08 +00:00
|
|
|
Installation on MSDOG (a.k.a. MSDOS)
|
|
|
|
|
1994-05-22 19:56:27 +00:00
|
|
|
To install on MSDOG, you need to have the GNU C compiler for MSDOG
|
1996-06-17 22:25:58 +00:00
|
|
|
(also known as djgpp), GNU Make, rm, mv, and sed. See the remarks in
|
|
|
|
config.bat for more information about locations and versions. The
|
|
|
|
file etc/FAQ includes pointers to Internet sites where you can find
|
|
|
|
the necessary utilities; search for "MS-DOS". The configuration step
|
|
|
|
(see below) will test for these utilities and will refuse to continue
|
|
|
|
if any of them isn't found.
|
|
|
|
|
|
|
|
If you are building the MSDOG version of Emacs on an MSDOG-like system
|
|
|
|
which supports long file names (e.g. Windows 95), you need to make
|
|
|
|
sure that long file names are handled consistently both when you
|
|
|
|
unpack the distribution and compile it. If you intend to compile with
|
|
|
|
DJGPP v2.0 or later, and long file names support is enabled (LFN=y in
|
|
|
|
the environment), you need to unpack Emacs distribution in a way that
|
|
|
|
doesn't truncate the original long filenames to the DOS 8.3 namespace;
|
|
|
|
the easiest way to do this is to use djtar program which comes with
|
|
|
|
DJGPP, since it will note the LFN setting and behave accordingly.
|
|
|
|
DJGPP v1 doesn't support long filenames, so you must unpack Emacs with
|
|
|
|
a program that truncates the filenames to 8.3 naming as it extracts
|
|
|
|
files; again, using djtar after setting LFN=n is the recommended way.
|
|
|
|
You can build Emacs with LFN=n even if you use DJGPP v2, if some of
|
|
|
|
your tools don't support long file names: just ensure that LFN is set
|
|
|
|
to `n' during both unpacking and compiling.
|
|
|
|
|
|
|
|
(By the time you read this, you have already unpacked the Emacs
|
|
|
|
distribution, but if the explanations above imply that you should have
|
|
|
|
done it differently, it's safer to delete the directory tree created
|
|
|
|
by the unpacking program and unpack Emacs again, than to risk running
|
|
|
|
into problems during the build process.)
|
|
|
|
|
|
|
|
It is important to understand that the runtime support of long file
|
|
|
|
names by the Emacs binary is NOT affected by the LFN setting during
|
|
|
|
compilation; Emacs compiled with DJGPP v2.0 or later will always
|
|
|
|
support long file names on Windows 95 no matter what was the setting
|
1996-07-19 19:50:23 +00:00
|
|
|
of LFN at compile time. However, if you compiled with LFN disabled
|
|
|
|
and want to enable LFN support after Emacs was already built, you need
|
|
|
|
to make sure that the support files in the lisp, etc and info
|
|
|
|
directories are called by their original long names as found in the
|
|
|
|
distribution. You can do this either by renaming the files manually,
|
|
|
|
or by extracting them from the original distribution archive with
|
|
|
|
djtar after you set LFN=y in the environment.
|
1996-06-17 22:25:58 +00:00
|
|
|
|
|
|
|
To unpack Emacs with djtar, type this command:
|
|
|
|
|
|
|
|
djtar -x emacs.tgz
|
|
|
|
|
|
|
|
(This assumes that the Emacs distribution is called `emacs.tgz' on
|
1997-08-31 16:42:40 +00:00
|
|
|
your system.)
|
1996-06-17 22:25:58 +00:00
|
|
|
|
1999-01-14 11:25:35 +00:00
|
|
|
If you need to type international characters, you will need to unpack
|
|
|
|
the Leim distribution (see the description near the beginning of this
|
|
|
|
file). You unpack it from the same directory where you unpacked
|
|
|
|
Emacs. To unpack Leim with djtar, assuming the Leim distribution is
|
|
|
|
called `leim.tgz', type this command:
|
|
|
|
|
|
|
|
djtar -x leim.tgz
|
|
|
|
|
|
|
|
If you want to print international characters, install the intlfonts
|
|
|
|
distribution. For this, create a directory called, `fonts', under the
|
|
|
|
Emacs top-level directory (usually called `emacs-XX.YY') created by
|
|
|
|
unpacking emacs.tgz, chdir into the directory emacs-XX.YY/fonts, and
|
|
|
|
type this:
|
|
|
|
|
|
|
|
djtar -x intlfonts.tgz
|
|
|
|
|
1996-06-17 22:25:58 +00:00
|
|
|
When unpacking is done, a directory called `emacs-XX.YY' will be
|
|
|
|
created, where XX.YY is the Emacs version. To build and install
|
|
|
|
Emacs, chdir to that directory and type these commands:
|
1995-06-20 16:28:39 +00:00
|
|
|
|
|
|
|
config msdos
|
|
|
|
make install
|
1994-02-24 19:15:08 +00:00
|
|
|
|
1996-04-17 16:43:16 +00:00
|
|
|
Building Emacs creates executable files in the src and lib-src
|
|
|
|
directories. Installing Emacs on MSDOS moves these executables to a
|
|
|
|
sibling directory called bin. For example, if you build in directory
|
|
|
|
/emacs, installing moves the executables from /emacs/src and
|
|
|
|
/emacs/lib-src to the directory /emacs/bin, so you can then delete the
|
|
|
|
subdirectories /emacs/src and /emacs/lib-src if you wish. The only
|
1999-01-14 11:25:35 +00:00
|
|
|
subdirectories you need to keep are bin, lisp, etc and info. (If you
|
|
|
|
installed Leim, keep the leim subdirectory, and if you installed
|
|
|
|
intlfonts, keep the fonts directory and all its sibdirectories as well.)
|
|
|
|
The bin subdirectory should be added to your PATH. The msdos
|
|
|
|
subdirectory includes a PIF and an icon file for Emacs which you might
|
|
|
|
find useful if you run Emacs under MS Windows.
|
1996-04-17 16:43:16 +00:00
|
|
|
|
|
|
|
Emacs on MSDOS finds the lisp, etc and info directories by looking in
|
|
|
|
../lisp, ../etc and ../info, starting from the directory where the
|
|
|
|
Emacs executable was run from. You can override this by setting the
|
1997-08-31 16:42:40 +00:00
|
|
|
environment variables EMACSDATA (for the location of `etc' directory),
|
|
|
|
EMACSLOADPATH (for the location of `lisp' directory) and INFOPATH (for
|
|
|
|
the location of the `info' directory).
|
1994-02-24 19:15:08 +00:00
|
|
|
|
1994-05-22 19:56:27 +00:00
|
|
|
MSDOG is a not a multitasking operating system, so Emacs features such
|
|
|
|
as asynchronous subprocesses that depend on multitasking will not
|
|
|
|
work. Synchronous subprocesses do work.
|
1996-08-05 03:30:41 +00:00
|
|
|
|
1997-01-13 02:41:58 +00:00
|
|
|
Version 2.0 of djgpp has two bugs that affect Emacs. We've included
|
|
|
|
corrected versions of two files from djgpp in the msdos subdirectory:
|
|
|
|
is_exec.c and sigaction.c. To work around the bugs, compile these
|
|
|
|
files and link them into temacs. Djgpp version 2.01 have these bugs
|
|
|
|
fixed, so upgrade if you can before building Emacs.
|