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