| 1 |
This directory tree holds version 21.4 of GNU Emacs, the extensible, |
|---|
| 2 |
customizable, self-documenting real-time display editor. This release |
|---|
| 3 |
was made to fix a security bug, so most directories have no changes |
|---|
| 4 |
from 21.3. The documentation still identifies the version as 21.3, |
|---|
| 5 |
since it has not been altered. |
|---|
| 6 |
|
|---|
| 7 |
You may encounter bugs in this release. If you do, please report |
|---|
| 8 |
them; your bug reports are valuable contributions to the FSF, since |
|---|
| 9 |
they allow us to notice and fix problems on machines we don't have, or |
|---|
| 10 |
in code we don't use often. See the file BUGS for more information on |
|---|
| 11 |
how to report bugs. |
|---|
| 12 |
|
|---|
| 13 |
See the file etc/NEWS for information on new features and other |
|---|
| 14 |
user-visible changes in recent versions of Emacs. |
|---|
| 15 |
|
|---|
| 16 |
The file INSTALL in this directory says how to bring up GNU Emacs on |
|---|
| 17 |
various systems, once you have loaded the entire subtree of this |
|---|
| 18 |
directory. |
|---|
| 19 |
|
|---|
| 20 |
The file etc/PROBLEMS contains information on many common problems that |
|---|
| 21 |
occur in building, installing and running Emacs. |
|---|
| 22 |
|
|---|
| 23 |
Reports of bugs in Emacs should be sent to the mailing list |
|---|
| 24 |
bug-gnu-emacs@gnu.org. See the "Bugs" section of the Emacs |
|---|
| 25 |
manual for more information on how to report bugs. (The file `BUGS' |
|---|
| 26 |
in this directory explains how you can find and read that section |
|---|
| 27 |
using the Info files that come with Emacs.) See `etc/MAILINGLISTS' |
|---|
| 28 |
for more information on mailing lists relating to GNU packages. |
|---|
| 29 |
|
|---|
| 30 |
The `etc' subdirectory contains several other files, named in capital |
|---|
| 31 |
letters, which you might consider looking at when installing GNU |
|---|
| 32 |
Emacs. |
|---|
| 33 |
|
|---|
| 34 |
The file `configure' is a shell script to acclimate Emacs to the |
|---|
| 35 |
oddities of your processor and operating system. It creates the file |
|---|
| 36 |
`Makefile' (a script for the `make' program), which automates the |
|---|
| 37 |
process of building and installing Emacs. See INSTALL for more |
|---|
| 38 |
detailed information. |
|---|
| 39 |
|
|---|
| 40 |
The file `configure.in' is the input used by the autoconf program to |
|---|
| 41 |
construct the `configure' script. Since Emacs has some configuration |
|---|
| 42 |
requirements that autoconf can't meet directly, and for historical |
|---|
| 43 |
reasons, `configure.in' uses an unholy marriage of custom-baked |
|---|
| 44 |
configuration code and autoconf macros. If you want to rebuild |
|---|
| 45 |
`configure' from `configure.in', you will need to install a recent |
|---|
| 46 |
version of autoconf and GNU m4. |
|---|
| 47 |
|
|---|
| 48 |
The file `Makefile.in' is a template used by `configure' to create |
|---|
| 49 |
`Makefile'. |
|---|
| 50 |
|
|---|
| 51 |
The file `make-dist' is a shell script to build a distribution tar |
|---|
| 52 |
file from the current Emacs tree, containing only those files |
|---|
| 53 |
appropriate for distribution. If you make extensive changes to Emacs, |
|---|
| 54 |
this script will help you distribute your version to others. |
|---|
| 55 |
|
|---|
| 56 |
There are several subdirectories: |
|---|
| 57 |
|
|---|
| 58 |
`src' holds the C code for Emacs (the Emacs Lisp interpreter and its |
|---|
| 59 |
primitives, the redisplay code, and some basic editing functions). |
|---|
| 60 |
`lisp' holds the Emacs Lisp code for Emacs (most everything else). |
|---|
| 61 |
`lib-src' holds the source code for some utility programs for use by |
|---|
| 62 |
or with Emacs, like movemail and etags. |
|---|
| 63 |
`etc' holds miscellaneous architecture-independent data files |
|---|
| 64 |
Emacs uses, like the tutorial text and the Zippy the Pinhead quote |
|---|
| 65 |
database. The contents of the `lisp', `info' and `man' |
|---|
| 66 |
subdirectories are architecture-independent too. |
|---|
| 67 |
|
|---|
| 68 |
`info' holds the Info documentation tree for Emacs. |
|---|
| 69 |
`man' holds the source code for the Emacs Manual. If you modify the |
|---|
| 70 |
manual sources, you will need the `makeinfo' program to produce |
|---|
| 71 |
an updated manual. `makeinfo' is part of the GNU Texinfo |
|---|
| 72 |
package; you need version 4.0 or later of Texinfo. |
|---|
| 73 |
|
|---|
| 74 |
Note that the Emacs Lisp Reference Manual sources are distributed |
|---|
| 75 |
separately. (They are twice as large as the Emacs Manual in the man |
|---|
| 76 |
subdirectory.) |
|---|
| 77 |
|
|---|
| 78 |
`msdos' holds configuration files for compiling Emacs under MSDOG. |
|---|
| 79 |
`vms' holds instructions and useful files for running Emacs under VMS. |
|---|
| 80 |
`nt' holds various command files and documentation files that pertain |
|---|
| 81 |
to running Emacs on Windows NT. |
|---|
| 82 |
`mac' holds instructions, sources, and other useful files for building |
|---|
| 83 |
and running Emacs on the Mac. |
|---|
| 84 |
|
|---|
| 85 |
Building Emacs on non-Posix platforms requires to install tools |
|---|
| 86 |
that aren't part of the standard distribution of the OS. The |
|---|
| 87 |
platform-specific README files and installation instructions should |
|---|
| 88 |
list the required tools. |
|---|
