Commit | Line | Data |
---|---|---|
ba318903 | 1 | Copyright (C) 2001-2014 Free Software Foundation, Inc. |
067d23c9 KY |
2 | See the end of the file for license conditions. |
3 | ||
4 | ||
052f924a | 5 | This directory tree holds version 24.3.50 of GNU Emacs, the extensible, |
067d23c9 KY |
6 | customizable, self-documenting real-time display editor. |
7 | ||
8 | The file INSTALL in this directory says how to build and install GNU | |
9 | Emacs on various systems, once you have unpacked or checked out the | |
10 | entire Emacs file tree. | |
11 | ||
12 | See the file etc/NEWS for information on new features and other | |
13 | user-visible changes in recent versions of Emacs. | |
14 | ||
15 | The file etc/PROBLEMS contains information on many common problems that | |
16 | occur in building, installing and running Emacs. | |
17 | ||
18 | You may encounter bugs in this release. If you do, please report | |
19 | them; your bug reports are valuable contributions to the FSF, since | |
20 | they allow us to notice and fix problems on machines we don't have, or | |
21 | in code we don't use often. Please send bug reports to the mailing | |
22 | list bug-gnu-emacs@gnu.org. If possible, use M-x report-emacs-bug. | |
23 | ||
24 | See the "Bugs" section of the Emacs manual for more information on how | |
25 | to report bugs. (The file `BUGS' in this directory explains how you | |
26 | can find and read that section using the Info files that come with | |
4efa3f1e GM |
27 | Emacs.) For a list of mailing lists related to Emacs, see |
28 | <http://savannah.gnu.org/mail/?group=emacs>. For the complete | |
29 | list of GNU mailing lists, see <http://lists.gnu.org/>. | |
067d23c9 KY |
30 | |
31 | The `etc' subdirectory contains several other files, named in capital | |
32 | letters, which you might consider looking at when installing GNU | |
33 | Emacs. | |
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 | ||
c4444d16 | 41 | The file `configure.ac' is the input used by the autoconf program to |
067d23c9 KY |
42 | construct the `configure' script. Since Emacs has some configuration |
43 | requirements that autoconf can't meet directly, and for historical | |
c4444d16 | 44 | reasons, `configure.ac' uses an unholy marriage of custom-baked |
b8b0239f PE |
45 | configuration code and autoconf macros. |
46 | ||
47 | The shell script `autogen.sh' generates 'configure' and other files by | |
48 | running the GNU build tools autoconf and automake, which in turn use | |
49 | GNU m4 and Perl. If you want to use it, you will need to install | |
50 | recent versions of these build tools. This should be needed only if | |
51 | you edit files like `configure.ac' that specify Emacs's autobuild | |
52 | procedure. | |
067d23c9 KY |
53 | |
54 | The file `Makefile.in' is a template used by `configure' to create | |
55 | `Makefile'. | |
56 | ||
57 | The file `make-dist' is a shell script to build a distribution tar | |
58 | file from the current Emacs tree, containing only those files | |
59 | appropriate for distribution. If you make extensive changes to Emacs, | |
60 | this script will help you distribute your version to others. | |
61 | ||
62 | There are several subdirectories: | |
63 | ||
64 | `src' holds the C code for Emacs (the Emacs Lisp interpreter and | |
65 | its primitives, the redisplay code, and some basic editing | |
66 | functions). | |
67 | `lisp' holds the Emacs Lisp code for Emacs (most everything else). | |
cb6c95a3 GM |
68 | `leim' holds the original source files for the generated files |
69 | in lisp/leim. These form the library of Emacs input methods, | |
70 | required to type international characters that can't be | |
71 | directly produced by your keyboard. | |
9a514d4a | 72 | `lib' holds source code for libraries used by Emacs and its utilities |
067d23c9 KY |
73 | `lib-src' holds the source code for some utility programs for use by or |
74 | with Emacs, like movemail and etags. | |
75 | `etc' holds miscellaneous architecture-independent data files Emacs | |
76 | uses, like the tutorial text and tool bar images. | |
77 | The contents of the `lisp', `leim', `info', and `doc' | |
78 | subdirectories are architecture-independent too. | |
79 | `info' holds the Info documentation tree for Emacs. | |
80 | `doc/emacs' holds the source code for the Emacs Manual. If you modify the | |
81 | manual sources, you will need the `makeinfo' program to produce | |
82 | an updated manual. `makeinfo' is part of the GNU Texinfo | |
83 | package; you need a suitably recent version of Texinfo. | |
84 | `doc/lispref' holds the source code for the Emacs Lisp reference manual. | |
85 | `doc/lispintro' holds the source code for the Introduction to Programming | |
86 | in Emacs Lisp manual. | |
87 | `msdos' holds configuration files for compiling Emacs under MSDOG. | |
88 | `nextstep' holds instructions and some other files for compiling the | |
89 | Nextstep port of Emacs, for GNUstep and Mac OS X Cocoa. | |
90 | `nt' holds various command files and documentation files that pertain | |
91 | to building and running Emacs on Windows 9X/ME/NT/2000/XP. | |
92 | `test' holds tests for various aspects of Emacs's functionality. | |
93 | ||
94 | Building Emacs on non-Posix platforms requires tools that aren't part | |
95 | of the standard distribution of the OS. The platform-specific README | |
96 | files and installation instructions should list the required tools. | |
97 | ||
98 | \f | |
0b5c5d82 GM |
99 | NOTE ON COPYRIGHT YEARS |
100 | ||
101 | In copyright notices where the copyright holder is the Free Software | |
102 | Foundation, then where a range of years appears, this is an inclusive | |
103 | range that applies to every year in the range. For example: 2005-2008 | |
104 | represents the years 2005, 2006, 2007, and 2008. | |
105 | ||
106 | \f | |
067d23c9 KY |
107 | This file is part of GNU Emacs. |
108 | ||
109 | GNU Emacs is free software: you can redistribute it and/or modify | |
110 | it under the terms of the GNU General Public License as published by | |
111 | the Free Software Foundation, either version 3 of the License, or | |
112 | (at your option) any later version. | |
113 | ||
114 | GNU Emacs is distributed in the hope that it will be useful, | |
115 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
116 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
117 | GNU General Public License for more details. | |
118 | ||
119 | You should have received a copy of the GNU General Public License | |
120 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |