* 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.
+character scripts is distributed in a separate tar file because it
+amounts to a significant fraction of the size of the distribution.
+This tar 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.
+
+You should unpack leim-M.N.tar.gz into the same directory where you
+have previously unpacked the main Emacs distribution. It fills in the
+contents of one subdirectory, which is present in the main Emacs
+distribution only in dummy form.
+
+Once you have unpacked the Leim tar file into the Emacs source tree,
+building and installing Emacs automatically installs the input method
+support as well. If you have built Emacs without unpacking Leim
+first, just unpack Leim, build Emacs again, and install it again.
* intlfonts-VERSION.tar.gz
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.
+* elisp-manual-M.N.tar.gz
+
+This distribution contains the Emacs Lisp Reference Manual which
+complements the Emacs Lisp Manual. It is a good idea to install the
+Emacs Lisp Reference Manual after installing Emacs, to complete the
+on-line documentation of Emacs in Info.
+
+If you have installed Texinfo, you can install the Emacs Lisp
+Reference Manual this way:
+
+ cd elisp-manual-M.N
+ ./configure --prefix=PREFIXDIR
+ make install
+
+Otherwise, you can install it manually. Just copy the files elisp and
+elisp-* from the elisp-manual-M.N directory to your site's info
+directory (see the description of `infodir', below), and make sure
+that file `dir' in this directory contains an entry like this:
+
+ * Elisp: (elisp). The Emacs Lisp Reference Manual.
+
+* Image support libraries
+
+Emacs needs optional libraries to be able to display images (with the
+exception of PBM images whose support is built-in). Here's the list
+of these optional libraries, and the URLs where they can be found:
+
+ . libxpm for XPM: ftp://ftp.x.org/contrib/libraries/
+ . libpng for PNG: ftp://www.libpng.org/pub/png/
+ . Zlib (for PNG): http://www.info-zip.org/pub/infozip/zlib/
+ . libjpeg for JPEG: ftp://ftp.uu.net/graphics/jpeg/
+ . libtiff for TIFF: http://www.libtiff.org/
+ . libungif for GIF:
+ http://prtr-13.ucsc.edu/~badger/software/libungif/index.shtml
+
+Emacs needs to be configured with the appropriate --with-LIB option,
+to be built with these libraries. See below for more details.
+
BUILDING AND INSTALLATION:
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]] ...
+ ./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
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.
+shared libraries. A free implementation of Motif, called LessTif, is
+available ftom <http://www.lesstif.org>.
The `--with-gcc' option specifies that the build process should
compile Emacs using GCC. If you don't want to use GCC, specify
Emacs uses POP is controlled by individual users--see the Rmail
chapter of the Emacs manual.
+To get Emacs with image support, configure with one or more of these
+options:
+
+ --with-xpm for XPM image support
+ --with-jpeg for JPEG image support
+ --with-tiff for TIFF image support
+ --with-gif for GIF image support
+ --with-png for PNG image support
+
+You will have to download, build, and install the appropriate image
+support libraries, see the list of URLs in "ADDITIONAL DISTRIBUTION
+FILES" above. (Note that configuring --with-png requires Zlib in
+addition to libpng.)
+
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
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 real source directory.
+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.
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.
+else, use site-init.el. Do not load byte-compiled code which
+was build with a non-nil value of `byte-compile-dynamic'.
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
architecture-independent files Emacs might need while
running. VERSION is as specified for `.../lisp'.
-`/usr/local/com/emacs/lock' contains files indicating who is editing
- what, so Emacs can detect editing clashes between
- users.
-
`/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable
programs used by Emacs that users are not expected to
run themselves.
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'.
+configuration), type `make distclean'. If you don't need some, or all
+of the input methods from the Leim package, you can remove the
+unneeded files in the leim/quail, leim/skk, and leim/skk-dic
+subdirectories of your site's lisp directory (usually
+/usr/local/share/emacs/VERSION/).
same time; this means that you don't have to make Emacs
unavailable while installing a new version.
-`sharedstatedir' indicates where to put architecture-independent data files
- that Emacs modifies while it runs; it defaults to
- /usr/local/com. We create the following
- subdirectories under `sharedstatedir':
- - `emacs/lock', containing files indicating who is editing
- what, so Emacs can detect editing clashes between
- users.
-
`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':
distribution. Instead, you should make sure that the existing `dir'
file contains an appropriate menu entry for the Emacs info.
-3) Create a directory for Emacs to use for clash detection, named as
-indicated by the PATH_LOCK macro in `./src/paths.h'.
-
-4) Copy `./src/emacs' to `/usr/local/bin', or to some other directory
+3) Copy `./src/emacs' to `/usr/local/bin', or to some other directory
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
You can delete `./src/temacs'.
-5) Copy the programs `b2m', `emacsclient', `ctags', `etags', and
+4) Copy the programs `b2m', `emacsclient', `ctags', `etags', and
`rcs-checkin' from `./lib-src' to `/usr/local/bin'. These programs are
intended for users to run.
-6) Copy the man pages in `./etc' for emacs, ctags, and etags into the
+5) Copy the man pages in `./etc' for emacs, ctags, and etags into the
appropriate man directories.
-7) The files in the `./src' subdirectory, except for `emacs', are not
+6) The files in the `./src' subdirectory, except for `emacs', are not
used by Emacs once it is built. However, it is very desirable to keep
the source on line for debugging.
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
+support long file names on Windows 9X 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
(This assumes that the Emacs distribution is called `emacs.tgz' on
your system.)
+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
+
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 install the international fonts, chdir to the intlfonts-X.Y
+directory created when you unpacked the intlfonts distribution (X.Y is
+the version number of the fonts' distribution), and type the following
+command:
+
+ make bdf INSTALLDIR=..
+
+After Make finishes, you may remove the directory intlfonts-X.Y; the
+fonts are installed into the fonts/bdf subdirectory of the top-level
+Emacs directory, and that is where Emacs will look for them by
+default.
+
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.
+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.
Emacs on MSDOS finds the lisp, etc and info directories by looking in
../lisp, ../etc and ../info, starting from the directory where the
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.
+files and link them into temacs. Djgpp versions 2.01 and later have
+these bugs fixed, so upgrade if you can before building Emacs.