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