]> code.delx.au - gnu-emacs/blobdiff - README
Texinfo 4.6 is required.
[gnu-emacs] / README
diff --git a/README b/README
index 8739720e9b80bead9e872cd513694cbc2794b3a0..59e509355bfced7292d3a0ef810f9b9495ca7ed1 100644 (file)
--- a/README
+++ b/README
@@ -1,30 +1,38 @@
-This directory tree holds version 21.0.99 of GNU Emacs, the extensible,
+Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007
+  Free Software Foundation, Inc.
+See the end of the file for license conditions.
+
+
+This directory tree holds version 22.1.50 of GNU Emacs, the extensible,
 customizable, self-documenting real-time display editor.
 
-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
-in code we don't use often.  See the file BUGS for more information on
-how to report bugs.
+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.
 
 See the file etc/NEWS for information on new features and other
-user-visible changes since the last version of Emacs.
-
-The file INSTALL in this directory says how to bring up GNU Emacs on
-Unix, once you have loaded the entire subtree of this directory.
+user-visible changes in recent versions of Emacs.
 
 The file etc/PROBLEMS contains information on many common problems that
 occur in building, installing and running Emacs.
 
-Reports of bugs in Emacs should be sent to the mailing list
-bug-gnu-emacs@gnu.org.  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.
+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
+in code we don't use often.  Please send bug reports for released
+versions of Emacs sent to the mailing list bug-gnu-emacs@gnu.org.
+Please send bug reports for pretest versions of Emacs, and versions
+from the Savannah.gnu.org repository, to emacs-pretest-bugs@gnu.org.
+
+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.
 
-The `etc' subdirectory contains several other files, named in
-capital letters, which you should look at when installing GNU Emacs.
+The `etc' subdirectory contains several other files, named in capital
+letters, which you might consider looking at when installing GNU
+Emacs.
 
 The file `configure' is a shell script to acclimate Emacs to the
 oddities of your processor and operating system.  It creates the file
@@ -33,15 +41,12 @@ 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
-construct the `configure' script.  Since Emacs has configuration
-requirements that autoconf can't meet, `configure.in' uses an unholy
-marriage of custom-baked configuration code and autoconf macros; it
-may be wise to avoid rebuilding `configure' from `configure.in' when
-possible.
-
-If you do want to rebuild `configure' from `configure.in', you will
-need to install autoconf and GNU m4 (the version of m4 supplied with
-your system might not be enough).
+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.
 
 The file `Makefile.in' is a template used by `configure' to create
 `Makefile'.
@@ -53,33 +58,55 @@ this script will help you distribute your version to others.
 
 There are several subdirectories:
 
-`src' holds the C code for Emacs (the Emacs Lisp interpreter and its
-    primitives, the redisplay code, and some basic editing functions).
-`lisp' holds the Emacs Lisp code for Emacs (most everything else).
-`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', `info' and `man'
-    subdirectories are architecture-independent too.
-
-`info' holds the Info documentation tree for Emacs.
-`man' holds the source code for the Emacs manual.  If you modify the
-      manual sources, you will need the `makeinfo' program to produce
-      an updated manual.  `makeinfo' is part of the GNU Texinfo
-      package; you need version 4.0 or later of Texinfo.
-
-   Note that the Emacs Lisp manual sources are distributed separately.
-(They are twice as large as the Emacs manual in the man subdirectory.)
-
-`msdos' holds configuration files for compiling Emacs under MSDOG.
-`vms' holds instructions and useful files for running Emacs under VMS.
-`nt' holds various command files and documentation files that pertain
-     to running Emacs on Windows NT.
-`mac' holds instructions, sources, and other useful files for building
-      and running Emacs on the Mac.
+`src'       holds the C code for Emacs (the Emacs Lisp interpreter and
+            its primitives, the redisplay code, and some basic editing
+            functions).
+`lisp'      holds the Emacs Lisp code for Emacs (most everything else).
+`leim'      holds the library of Emacs input methods, Lisp code and
+            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.
+`man'       holds the source code for the Emacs Manual.  If you modify the
+            manual sources, you will need the `makeinfo' program to produce
+            an updated manual.  `makeinfo' is part of the GNU Texinfo
+            package; you need version 4.6 or later of Texinfo.
+`lispref'   holds the source code for the Emacs Lisp reference manual.
+`lispintro' holds the source code for the Introduction to Programming
+            in Emacs Lisp manual.
+
+`msdos'     holds configuration files for compiling Emacs under MSDOG.
+`vms'       holds instructions and useful files for running Emacs under VMS.
+`nt'        holds various command files and documentation files that pertain
+            to building and running Emacs on Windows 9X/ME/NT/2000/XP.
+`mac'       holds instructions, sources, and other useful files for building
+            and running Emacs on the Mac.
 
    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.
+
+\f
+This file is part of GNU Emacs.
+
+GNU Emacs is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3, or (at your option)
+any later version.
+
+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
+along with GNU Emacs; see the file COPYING.  If not, write to the
+Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+Boston, MA 02110-1301, USA.