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