GNU Emacs Installation Guide
-Copyright (c) 1992, 1994 Free software Foundation, Inc.
+Copyright (c) 1992, 1994, 1996, 1997 Free software Foundation, Inc.
Permission is granted to anyone to make or distribute verbatim copies
of this document as received, in any medium, provided that the
of the Free Software Foundation are approved by the Foundation.
+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
+it. You might find a font in the intlfonts distribution. If some
+characters don't look right, or appear improperly aligned, a font
+from the intlfonts distribution might look better.
+
+The intlfonts distribution contains its own installation instructions,
+in the intlfonts/README file.
+
+
BUILDING AND INSTALLATION:
-(This is for a Unix or Unix-like system. For MSDOS, see below;
-search for MSDOG. For Windows NT, see the file nt/install.)
+
+(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.)
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
-loadup dump', found in `./src/Makefile.in.in', or possibly when
+loadup dump', found in `./src/Makefile.in', or possibly when
running the final dumped Emacs.
-Building Emacs requires about 50 Mb of disk space (including the Emacs
-sources). Once installed, Emacs occupies about 20 Mb in the file
+Building Emacs requires about 70 Mb of disk space (including the Emacs
+sources). Once installed, Emacs occupies about 35 Mb in the file
system where it is installed; this includes the executable files, Lisp
libraries, miscellaneous data files, and on-line documentation. If
the building and installation take place in different directories,
-then the installation procedure momentarily requires 50+20 Mb.
+then the installation procedure momentarily requires 70+35 Mb.
2) Consult `./etc/MACHINES' to see what configuration name you should
give to the `configure' program. That file offers hints for
getting around some possible installation problems.
-3) In the top directory of the Emacs distribution, run the program
-`configure' as follows:
+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:
./configure CONFIGURATION-NAME [--OPTION[=VALUE]] ...
`--with-gcc=no'. If you omit this option, `configure' will search
for GCC in your path, and use it if present.
-You can build Emacs for several different machine types from a single
-source directory. To do this, you must use a version of `make' that
-supports the `VPATH' variable, such as GNU `make'. Make separate
-build directories for the different configuration types, and in each
-one, run the Emacs `configure' script. `configure' looks for the
-Emacs source code in the directory that `configure' is in.
+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.
The `--prefix=PREFIXDIR' option specifies where the installation process
should put emacs and its data files. This defaults to `/usr/local'.
disable caching, for debugging `configure'.
The work of `configure' can be done by editing various files in the
-distribution, but using `configure' is supposed to be simpler. See
-the section called "CONFIGURATION BY HAND" below if you want to do the
-configuration yourself.
+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'.
4) Look at `./lisp/paths.el'; if some of those values are not right
for your system, set up the file `./lisp/site-init.el' with Emacs
variable should have. If you don't pay attention to what you are
doing, you'll make a mistake.
-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.
-See `./PROBLEMS' for more details on which systems this affects.
-
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
-src/Makefile.in.in if you wish to figure out how to do that). For all
+src/Makefile.in if you wish to figure out how to do that). For all
else, use site-init.el.
If you set load-path to a different value in site-init.el or
`/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library;
`VERSION' stands for the number of the Emacs version
you are installing, like `18.59' or `19.27'. Since the
- lisp library changes from one version of Emacs to
+ 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; this means that you don't have to
- make Emacs unavailable while installing a new
- version.
+ at the same time; in particular, you don't have to
+ make Emacs unavailable while installing a new version.
- Emacs searches for its lisp files in
- `/usr/local/share/emacs/site-lisp', then in this
- directory.
+`/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'.
`/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
file, the `yow' database, and other
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
-for its lisp files by giving values for `make' variables as part of
+for its Lisp files by giving values for `make' variables as part of
the command. See the section below called `MAKE VARIABLES' for more
information on this.
then you might need to make the movemail program setuid or setgid
to enable it to write the lock files. We believe this is safe.
-10) You are done!
+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'.
+
MAKE VARIABLES
read-only data files that Emacs refers to while it runs; it
defaults to /usr/local/share. We create the following
subdirectories under `datadir':
- - `emacs/VERSION/lisp', containing the Emacs lisp library, and
+ - `emacs/VERSION/lisp', containing the Emacs Lisp library, and
- `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,
The above variables serve analogous purposes in the makefiles for all
GNU software; here are some variables specific to Emacs.
-`lispdir' indicates where Emacs installs and expects its lisp
- library. Its default value, based on `datadir' (see above),
- is `/usr/local/lib/emacs/VERSION/lisp' (where `VERSION' is as
+`lispdir' indicates where Emacs installs and expects its Lisp library.
+ Its default value, based on `datadir' (see above), is
+ `/usr/local/share/emacs/VERSION/lisp' (where `VERSION' is as
described above).
-`locallisppath' indicates where Emacs should search for lisp files
+`locallisppath' indicates where Emacs should search for Lisp files
specific to your site. It should be a colon-separated list of
directories; Emacs checks them in order before checking
- `lispdir'. Its default value, based on `datadir' (see above),
- is `/usr/local/lib/emacs/site-lisp'.
+ `lispdir'. Its default value, based on `datadir' (see above), is
+ `/usr/local/share/emacs/VERSION/site-lisp:/usr/local/share/emacs/site-lisp'.
`lisppath' is the complete list of directories Emacs should search for
- its lisp files; its default value is the concatenation of
- `lispdir' and `locallisppath'. It should be a colon-separated
+ its Lisp files; its default value is the concatenation of
+ `locallisppath' and `lispdir'. It should be a colon-separated
list of directories; Emacs checks them in the order they
appear.
`etcdir' indicates where Emacs should install and expect the rest of
its architecture-independent data, like the tutorial, DOC
file, and yow database. Its default value, based on `datadir'
- (which see), is `/usr/local/lib/emacs/VERSION/etc'.
+ (which see), is `/usr/local/share/emacs/VERSION/etc'.
`lockdir' indicates the directory where Emacs keeps track of its
- locking information. Its default value, based on `sharedstatedir'
- (which see), is `/usr/local/lib/emacs/lock'.
+ locking information. Its default value, based on
+ `sharedstatedir' (which see), is `/usr/local/com/emacs/lock'.
-`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/lib/emacs/VERSION/CONFIGURATION-NAME'
+`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'
(where VERSION and CONFIGURATION-NAME are as described above).
Remember that you must specify any variable values you need each time
Instead of running the `configure' program, you have to perform the
following steps.
-1) Copy `./src/config.h.in' to `./src/config.h'.
+1) Copy `./src/config.in' to `./src/config.h'.
2) Consult `./etc/MACHINES' to see what configuration name you should
use for your system. Look at the code of the `configure' script to
redefine parameters used in `./lib-src/movemail.c'.
3) Create src/Makefile and lib-src/Makefile from the corresponding
-`Makefile.in.in' files. First copy `Makefile.in.in' to `Makefile.in',
-then edit in appropriate substituions for the @...@ constructs,
+`Makefile.in' files. First copy `Makefile.in' to `Makefile.c',
+then edit in appropriate substitutions for the @...@ constructs,
and then copy the shell commands near the end of `configure'
that run cpp to construct `Makefile'.
the following steps.
1) Run `make src/paths.h' in the top directory. This produces
-`./src/paths.h' from the template file `./src/paths.h.in', changing
+`./src/paths.h' from the template file `./src/paths.in', changing
the paths to the values specified in `./Makefile'.
2) Go to directory `./lib-src' and run `make'. This creates
Installation on MSDOG (a.k.a. MSDOS)
To install on MSDOG, you need to have the GNU C compiler for MSDOG
-(also known as djgpp), GNU Make, rm, mv, chmod, and sed.
-
-Some users report that running Emacs 19.29 requires qdpmi memory
-management. We do not know why this is so, since 19.28 did not need
-it. If we find out what change introduced this requirement, we will
-try to eliminate it. It is possible that this problem happens only
-when there is not enough physical memory on the machine.
-
-To build and install Emacs, type these commands:
+(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
+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.
+
+To unpack Emacs with djtar, type this command:
+
+ djtar -x emacs.tgz
+
+(This assumes that the Emacs distribution is called `emacs.tgz' on
+your system.)
+
+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:
config msdos
make install
-To save disk space, Emacs is built with the idea that you will execute
-it from the same place in the file system where you built it. As the
-/usr/local/ subtree does not exist on most MSDOG systems, the
-executables are placed in /emacs/bin/.
+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
+subdirectories you need to keep are bin, lisp, etc and info. 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.
+
+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
+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).
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.
+
+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.
HCoop / bpt / emacs.git / blobdiff