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
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.
- ./configure CONFIGURATION-NAME [--OPTION[=VALUE]] ...
+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]] ...
The CONFIGURATION-NAME argument should be a configuration name given
-in `./etc/MACHINES'. If omitted, `configure' will try to guess your
-system type; if it cannot, you must find the appropriate configuration
-name in `./etc/MACHINES' and specify it explicitly.
+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.
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
`--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'.
+
+3c) Some people try to build in a separate directory by filling
+it full of symlinks to the files in the real source directory.
+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).
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
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.
+See `./etc/PROBLEMS' for more details on which systems this affects.
The `site-*.el' files are nonexistent in the distribution. You do not
need to create them if you have nothing to put in them.
path variables - `bindir' and `libexecdir'.
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/share/emacs/VERSION/lisp' (where `VERSION' is as
- described above).
-
-`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/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
- `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/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/com/emacs/lock'.
+GNU software; this variable is specific to Emacs.
`archlibdir' indicates where Emacs installs and expects the executable
files and other architecture-dependent data it uses while
directory, but be aware that running the `configure' program erases
`Makefile' and rebuilds it from `Makefile.in'.
+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'.
+
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
-See the file PROBLEMS in this directory for a list of various
+See the file PROBLEMS in etc subdirectory for a list of various
problems sometimes encountered, and what to do about them.
djtar -x emacs.tgz
(This assumes that the Emacs distribution is called `emacs.tgz' on
-your system.) There are a few files in the archive whose names
-collide with other files under the 8.3 DOS naming. On native MSDOS,
-or if you have set LFN=n on Win95, djtar will ask you to supply
-alternate names for these files; you can just press `Enter' when this
-happens (which makes djtar skip these files) because they aren't
-required for MS-DOS.
+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 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 variable HOME; if you do that, the directories lisp, etc
-and info are accessed as subdirectories of the HOME directory.
+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