README 5.16 KB
Newer Older
1 2
Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
  2010  Free Software Foundation, Inc.
3
See the end of the file for license conditions.
4 5


6
This directory tree holds version 23.1.91 of GNU Emacs, the extensible,
Dave Love's avatar
#  
Dave Love committed
7 8
customizable, self-documenting real-time display editor.

9 10 11
The file INSTALL in this directory says how to build and install GNU
Emacs on various systems, once you have unpacked or checked out the
entire Emacs file tree.
Dave Love's avatar
#  
Dave Love committed
12

13
See the file etc/NEWS for information on new features and other
14
user-visible changes in recent versions of Emacs.
Dave Love's avatar
#  
Dave Love committed
15 16 17 18

The file etc/PROBLEMS contains information on many common problems that
occur in building, installing and running Emacs.

19 20 21
You may encounter bugs in this release.  If you do, please report
them; your bug reports are valuable contributions to the FSF, since
they allow us to notice and fix problems on machines we don't have, or
22 23
in code we don't use often.  Please send bug reports to the mailing
list bug-gnu-emacs@gnu.org.  If possible, use M-x report-emacs-bug.
24 25 26 27 28 29

See the "Bugs" section of the Emacs manual for more information on how
to report bugs.  (The file `BUGS' in this directory explains how you
can find and read that section using the Info files that come with
Emacs.)  See `etc/MAILINGLISTS' for more information on mailing lists
relating to GNU packages.
Dave Love's avatar
#  
Dave Love committed
30

31 32 33
The `etc' subdirectory contains several other files, named in capital
letters, which you might consider looking at when installing GNU
Emacs.
Dave Love's avatar
#  
Dave Love committed
34 35 36 37 38 39 40 41

The file `configure' is a shell script to acclimate Emacs to the
oddities of your processor and operating system.  It creates the file
`Makefile' (a script for the `make' program), which automates the
process of building and installing Emacs.  See INSTALL for more
detailed information.

The file `configure.in' is the input used by the autoconf program to
Dave Love's avatar
Dave Love committed
42 43 44 45 46 47
construct the `configure' script.  Since Emacs has some configuration
requirements that autoconf can't meet directly, and for historical
reasons, `configure.in' uses an unholy marriage of custom-baked
configuration code and autoconf macros.  If you want to rebuild
`configure' from `configure.in', you will need to install a recent
version of autoconf and GNU m4.
48

Dave Love's avatar
#  
Dave Love committed
49 50 51 52 53 54 55 56 57 58
The file `Makefile.in' is a template used by `configure' to create
`Makefile'.

The file `make-dist' is a shell script to build a distribution tar
file from the current Emacs tree, containing only those files
appropriate for distribution.  If you make extensive changes to Emacs,
this script will help you distribute your version to others.

There are several subdirectories:

59
`src'       holds the C code for Emacs (the Emacs Lisp interpreter and
60
            its primitives, the redisplay code, and some basic editing
61 62
            functions).
`lisp'      holds the Emacs Lisp code for Emacs (most everything else).
63
`leim'      holds the library of Emacs input methods, Lisp code and
64 65 66 67 68 69 70 71 72 73
            auxiliary data files required to type international characters
            which can't be directly produced by your keyboard.
`lib-src'   holds the source code for some utility programs for use by or
            with Emacs, like movemail and etags.
`etc'       holds miscellaneous architecture-independent data files
            Emacs uses, like the tutorial text and the Zippy the Pinhead
            quote database.  The contents of the `lisp', `leim', `info',
            `man', `lispref', and `lispintro' subdirectories are
            architecture-independent too.
`info'      holds the Info documentation tree for Emacs.
74
`doc/emacs' holds the source code for the Emacs Manual.  If you modify the
75 76
            manual sources, you will need the `makeinfo' program to produce
            an updated manual.  `makeinfo' is part of the GNU Texinfo
Eli Zaretskii's avatar
Eli Zaretskii committed
77
            package; you need version 4.6 or later of Texinfo.
78 79 80
`doc/lispref'   holds the source code for the Emacs Lisp reference manual.
`doc/lispintro' holds the source code for the Introduction to Programming
                in Emacs Lisp manual.
81
`msdos'     holds configuration files for compiling Emacs under MSDOG.
Glenn Morris's avatar
Glenn Morris committed
82
`nextstep'  holds instructions and some other files for compiling the
Glenn Morris's avatar
Glenn Morris committed
83
            Nextstep port of Emacs, for GNUstep and Mac OS X Cocoa.
84 85
`nt'        holds various command files and documentation files that pertain
            to building and running Emacs on Windows 9X/ME/NT/2000/XP.
Glenn Morris's avatar
Glenn Morris committed
86
`test'      holds tests for various aspects of Emacs's functionality.
87 88 89 90 91

   Building Emacs on non-Posix platforms requires to install tools
that aren't part of the standard distribution of the OS.  The
platform-specific README files and installation instructions should
list the required tools.
92 93 94 95


This file is part of GNU Emacs.

96
GNU Emacs is free software: you can redistribute it and/or modify
97
it under the terms of the GNU General Public License as published by
98 99
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
100 101 102 103 104 105 106

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
107
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.