README

   1 Copyright (C) 2001-2012  Free Software Foundation, Inc.
   2 See the end of the file for license conditions.
   3
   4
   5 This directory tree holds version 24.2 of GNU Emacs, the extensible,
   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
  27 Emacs.)  See `etc/MAILINGLISTS' for more information on mailing lists
  28 relating to GNU packages.
  29
  30 The `etc' subdirectory contains several other files, named in capital
  31 letters, which you might consider looking at when installing GNU
  32 Emacs.
  33
  34 The file `configure' is a shell script to acclimate Emacs to the
  35 oddities of your processor and operating system.  It creates the file
  36 `Makefile' (a script for the `make' program), which automates the
  37 process of building and installing Emacs.  See INSTALL for more
  38 detailed information.
  39
  40 The file `configure.in' is the input used by the autoconf program to
  41 construct the `configure' script.  Since Emacs has some configuration
  42 requirements that autoconf can't meet directly, and for historical
  43 reasons, `configure.in' uses an unholy marriage of custom-baked
  44 configuration code and autoconf macros.  If you want to rebuild
  45 `configure' from `configure.in', you will need to install a recent
  46 version of autoconf and GNU m4.
  47
  48 The file `Makefile.in' is a template used by `configure' to create
  49 `Makefile'.
  50
  51 The file `make-dist' is a shell script to build a distribution tar
  52 file from the current Emacs tree, containing only those files
  53 appropriate for distribution.  If you make extensive changes to Emacs,
  54 this script will help you distribute your version to others.
  55
  56 There are several subdirectories:
  57
  58 `src'       holds the C code for Emacs (the Emacs Lisp interpreter and
  59             its primitives, the redisplay code, and some basic editing
  60             functions).
  61 `lisp'      holds the Emacs Lisp code for Emacs (most everything else).
  62 `leim'      holds the library of Emacs input methods, Lisp code and
  63             auxiliary data files required to type international characters
  64             which can't be directly produced by your keyboard.
  65 `lib'       holds source code for libraries used by Emacs and its utilities
  66 `lib-src'   holds the source code for some utility programs for use by or
  67             with Emacs, like movemail and etags.
  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.
  72 `info'      holds the Info documentation tree for Emacs.
  73 `doc/emacs' holds the source code for the Emacs Manual.  If you modify the
  74             manual sources, you will need the `makeinfo' program to produce
  75             an updated manual.  `makeinfo' is part of the GNU Texinfo
  76             package; you need a suitably recent version of Texinfo.
  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.
  80 `msdos'     holds configuration files for compiling Emacs under MSDOG.
  81 `nextstep'  holds instructions and some other files for compiling the
  82             Nextstep port of Emacs, for GNUstep and Mac OS X Cocoa.
  83 `nt'        holds various command files and documentation files that pertain
  84             to building and running Emacs on Windows 9X/ME/NT/2000/XP.
  85 `test'      holds tests for various aspects of Emacs's functionality.
  86
  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.
  90
  91 \f
  92 NOTE ON COPYRIGHT YEARS
  93
  94 In copyright notices where the copyright holder is the Free Software
  95 Foundation, then where a range of years appears, this is an inclusive
  96 range that applies to every year in the range.  For example: 2005-2008
  97 represents the years 2005, 2006, 2007, and 2008.
  98
  99 \f
 100 This file is part of GNU Emacs.
 101
 102 GNU Emacs is free software: you can redistribute it and/or modify
 103 it under the terms of the GNU General Public License as published by
 104 the Free Software Foundation, either version 3 of the License, or
 105 (at your option) any later version.
 106
 107 GNU Emacs is distributed in the hope that it will be useful,
 108 but WITHOUT ANY WARRANTY; without even the implied warranty of
 109 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 110 GNU General Public License for more details.
 111
 112 You should have received a copy of the GNU General Public License
 113 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.