Commit | Line | Data |
---|---|---|
a4a9692d DL |
1 | This directory tree holds version 20.0 of GNU Emacs, the extensible, |
2 | customizable, self-documenting real-time display editor. | |
3 | ||
4 | You may encounter bugs in this release. If you do, please report | |
5 | them; your bug reports are valuable contributions to the FSF, since | |
6 | they allow us to notice and fix problems on machines we don't have, or | |
7 | in code we don't use often. See the file BUGS for more information on | |
8 | how to report bugs. | |
9 | ||
10 | See the files `etc/NEWS' and `etc/news.texi' for information on new | |
11 | features and other user-visible changes since the last version of | |
12 | Emacs. | |
13 | ||
14 | The file INSTALL in this directory says how to bring up GNU Emacs on | |
15 | Unix, once you have loaded the entire subtree of this directory. | |
16 | ||
17 | The file etc/PROBLEMS contains information on many common problems that | |
18 | occur in building, installing and running Emacs. | |
19 | ||
20 | Reports of bugs in Emacs should be sent to the mailing list | |
21 | bug-gnu-emacs@gnu.org. See the "Bugs" section of the Emacs | |
22 | manual for more information on how to report bugs. (The file `BUGS' | |
23 | in this directory explains how you can find and read that section | |
24 | using the Info files that come with Emacs.) See `etc/MAILINGLISTS' | |
25 | for more information on mailing lists relating to GNU packages. | |
26 | ||
27 | The `etc' subdirectory contains several other files, named in | |
28 | capital letters, which you should look at when installing GNU Emacs. | |
29 | ||
30 | The file `configure' is a shell script to acclimate Emacs to the | |
31 | oddities of your processor and operating system. It creates the file | |
32 | `Makefile' (a script for the `make' program), which automates the | |
33 | process of building and installing Emacs. See INSTALL for more | |
34 | detailed information. | |
35 | ||
36 | The file `configure.in' is the input used by the autoconf program to | |
37 | construct the `configure' script. Since Emacs has configuration | |
38 | requirements that autoconf can't meet, `configure.in' uses an unholy | |
39 | marriage of custom-baked configuration code and autoconf macros; it | |
40 | may be wise to avoid rebuilding `configure' from `configure.in' when | |
41 | possible. | |
42 | ||
43 | The file `Makefile.in' is a template used by `configure' to create | |
44 | `Makefile'. | |
45 | ||
46 | The file `make-dist' is a shell script to build a distribution tar | |
47 | file from the current Emacs tree, containing only those files | |
48 | appropriate for distribution. If you make extensive changes to Emacs, | |
49 | this script will help you distribute your version to others. | |
50 | ||
51 | There are several subdirectories: | |
52 | ||
53 | `src' holds the C code for Emacs (the Emacs Lisp interpreter and its | |
54 | primitives, the redisplay code, and some basic editing functions). | |
55 | `lisp' holds the Emacs Lisp code for Emacs (most everything else). | |
56 | `lib-src' holds the source code for some utility programs for use by | |
57 | or with Emacs, like movemail and etags. | |
58 | `etc' holds miscellaneous architecture-independent data files | |
59 | Emacs uses, like the tutorial text and the Zippy the Pinhead quote | |
60 | database. The contents of the `lisp', `info' and `man' | |
61 | subdirectories are architecture-independent too. | |
62 | ||
63 | `info' holds the Info documentation tree for Emacs. | |
64 | `man' holds the source code for the Emacs manual. | |
65 | ||
66 | Note that the Emacs Lisp manual sources are distributed separately. | |
67 | (They are twice as large as the Emacs manual in the man subdirectory.) | |
68 | ||
69 | `msdos' holds configuration files for compiling Emacs under MSDOG. | |
70 | `vms' holds instructions and useful files for running Emacs under VMS. | |
71 | `nt' holds various command files and documentation files that pertain | |
72 | to running Emacs on Windows NT. |