Commit | Line | Data |
---|---|---|
893db5bc | 1 | Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, |
5df4f04c | 2 | 2010, 2011 Free Software Foundation, Inc. |
7f6d64f8 | 3 | See the end of the file for license conditions. |
c2e309f2 GM |
4 | |
5 | ||
4648b91b | 6 | This directory tree holds version 23.2.94 of GNU Emacs, the extensible, |
a4a9692d DL |
7 | customizable, self-documenting real-time display editor. |
8 | ||
fdd68ab3 RS |
9 | The file INSTALL in this directory says how to build and install GNU |
10 | Emacs on various systems, once you have unpacked or checked out the | |
11 | entire Emacs file tree. | |
a4a9692d | 12 | |
49417719 | 13 | See the file etc/NEWS for information on new features and other |
d955d095 | 14 | user-visible changes in recent versions of Emacs. |
a4a9692d | 15 | |
a4a9692d DL |
16 | The file etc/PROBLEMS contains information on many common problems that |
17 | occur in building, installing and running Emacs. | |
18 | ||
fdd68ab3 RS |
19 | You may encounter bugs in this release. If you do, please report |
20 | them; your bug reports are valuable contributions to the FSF, since | |
21 | they allow us to notice and fix problems on machines we don't have, or | |
893db5bc GM |
22 | in code we don't use often. Please send bug reports to the mailing |
23 | list bug-gnu-emacs@gnu.org. If possible, use M-x report-emacs-bug. | |
fdd68ab3 RS |
24 | |
25 | See the "Bugs" section of the Emacs manual for more information on how | |
26 | to report bugs. (The file `BUGS' in this directory explains how you | |
27 | can find and read that section using the Info files that come with | |
28 | Emacs.) See `etc/MAILINGLISTS' for more information on mailing lists | |
29 | relating to GNU packages. | |
a4a9692d | 30 | |
d955d095 EZ |
31 | The `etc' subdirectory contains several other files, named in capital |
32 | letters, which you might consider looking at when installing GNU | |
33 | Emacs. | |
a4a9692d DL |
34 | |
35 | The file `configure' is a shell script to acclimate Emacs to the | |
36 | oddities of your processor and operating system. It creates the file | |
37 | `Makefile' (a script for the `make' program), which automates the | |
38 | process of building and installing Emacs. See INSTALL for more | |
39 | detailed information. | |
40 | ||
41 | The file `configure.in' is the input used by the autoconf program to | |
de93306b DL |
42 | construct the `configure' script. Since Emacs has some configuration |
43 | requirements that autoconf can't meet directly, and for historical | |
44 | reasons, `configure.in' uses an unholy marriage of custom-baked | |
45 | configuration code and autoconf macros. If you want to rebuild | |
46 | `configure' from `configure.in', you will need to install a recent | |
47 | version of autoconf and GNU m4. | |
49417719 | 48 | |
a4a9692d DL |
49 | The file `Makefile.in' is a template used by `configure' to create |
50 | `Makefile'. | |
51 | ||
52 | The file `make-dist' is a shell script to build a distribution tar | |
53 | file from the current Emacs tree, containing only those files | |
54 | appropriate for distribution. If you make extensive changes to Emacs, | |
55 | this script will help you distribute your version to others. | |
56 | ||
57 | There are several subdirectories: | |
58 | ||
b0a21bf9 | 59 | `src' holds the C code for Emacs (the Emacs Lisp interpreter and |
177c0ea7 | 60 | its primitives, the redisplay code, and some basic editing |
b0a21bf9 EZ |
61 | functions). |
62 | `lisp' holds the Emacs Lisp code for Emacs (most everything else). | |
177c0ea7 | 63 | `leim' holds the library of Emacs input methods, Lisp code and |
b0a21bf9 EZ |
64 | auxiliary data files required to type international characters |
65 | which can't be directly produced by your keyboard. | |
66 | `lib-src' holds the source code for some utility programs for use by or | |
67 | with Emacs, like movemail and etags. | |
1c8ca3e6 GM |
68 | `etc' holds miscellaneous architecture-independent data files Emacs |
69 | uses, like the tutorial text and tool bar images. | |
70 | The contents of the `lisp', `leim', `info', and `doc' | |
71 | subdirectories are architecture-independent too. | |
b0a21bf9 | 72 | `info' holds the Info documentation tree for Emacs. |
fe79fcb3 | 73 | `doc/emacs' holds the source code for the Emacs Manual. If you modify the |
b0a21bf9 EZ |
74 | manual sources, you will need the `makeinfo' program to produce |
75 | an updated manual. `makeinfo' is part of the GNU Texinfo | |
1c8ca3e6 | 76 | package; you need a suitably recent version of Texinfo. |
fe79fcb3 JL |
77 | `doc/lispref' holds the source code for the Emacs Lisp reference manual. |
78 | `doc/lispintro' holds the source code for the Introduction to Programming | |
79 | in Emacs Lisp manual. | |
b0a21bf9 | 80 | `msdos' holds configuration files for compiling Emacs under MSDOG. |
80c76d1b | 81 | `nextstep' holds instructions and some other files for compiling the |
3dcdb6ea | 82 | Nextstep port of Emacs, for GNUstep and Mac OS X Cocoa. |
b0a21bf9 EZ |
83 | `nt' holds various command files and documentation files that pertain |
84 | to building and running Emacs on Windows 9X/ME/NT/2000/XP. | |
2d61385a | 85 | `test' holds tests for various aspects of Emacs's functionality. |
49417719 | 86 | |
1c8ca3e6 GM |
87 | Building Emacs on non-Posix platforms requires tools that aren't part |
88 | of the standard distribution of the OS. The platform-specific README | |
89 | files and installation instructions should list the required tools. | |
7f6d64f8 GM |
90 | |
91 | \f | |
92 | This file is part of GNU Emacs. | |
93 | ||
b33ba812 | 94 | GNU Emacs is free software: you can redistribute it and/or modify |
7f6d64f8 | 95 | it under the terms of the GNU General Public License as published by |
b33ba812 GM |
96 | the Free Software Foundation, either version 3 of the License, or |
97 | (at your option) any later version. | |
7f6d64f8 GM |
98 | |
99 | GNU Emacs is distributed in the hope that it will be useful, | |
100 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
101 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
102 | GNU General Public License for more details. | |
103 | ||
104 | You should have received a copy of the GNU General Public License | |
b33ba812 | 105 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |