| 1 | This directory tree holds version 22.0.91 of GNU Emacs, the extensible, |
| 2 | customizable, self-documenting real-time display editor. |
| 3 | |
| 4 | You may encounter bugs in this release. If you do, please report |
| 5 | them; your bug reports are valuable contributions to the FSF, since |
| 6 | they allow us to notice and fix problems on machines we don't have, or |
| 7 | in code we don't use often. See the file BUGS for more information on |
| 8 | how to report bugs. |
| 9 | |
| 10 | See the file etc/NEWS for information on new features and other |
| 11 | user-visible changes in recent versions of Emacs. |
| 12 | |
| 13 | The file INSTALL in this directory says how to bring up GNU Emacs on |
| 14 | various systems, once you have loaded the entire subtree of this |
| 15 | directory. |
| 16 | |
| 17 | The file etc/PROBLEMS contains information on many common problems that |
| 18 | occur in building, installing and running Emacs. |
| 19 | |
| 20 | Reports of bugs in Emacs should be sent to the mailing list |
| 21 | bug-gnu-emacs@gnu.org. See the "Bugs" section of the Emacs |
| 22 | manual for more information on how to report bugs. (The file `BUGS' |
| 23 | in this directory explains how you can find and read that section |
| 24 | using the Info files that come with Emacs.) See `etc/MAILINGLISTS' |
| 25 | for more information on mailing lists relating to GNU packages. |
| 26 | |
| 27 | The `etc' subdirectory contains several other files, named in capital |
| 28 | letters, which you might consider looking at when installing GNU |
| 29 | Emacs. |
| 30 | |
| 31 | The file `configure' is a shell script to acclimate Emacs to the |
| 32 | oddities of your processor and operating system. It creates the file |
| 33 | `Makefile' (a script for the `make' program), which automates the |
| 34 | process of building and installing Emacs. See INSTALL for more |
| 35 | detailed information. |
| 36 | |
| 37 | The file `configure.in' is the input used by the autoconf program to |
| 38 | construct the `configure' script. Since Emacs has some configuration |
| 39 | requirements that autoconf can't meet directly, and for historical |
| 40 | reasons, `configure.in' uses an unholy marriage of custom-baked |
| 41 | configuration code and autoconf macros. If you want to rebuild |
| 42 | `configure' from `configure.in', you will need to install a recent |
| 43 | version of autoconf and GNU m4. |
| 44 | |
| 45 | The file `Makefile.in' is a template used by `configure' to create |
| 46 | `Makefile'. |
| 47 | |
| 48 | The file `make-dist' is a shell script to build a distribution tar |
| 49 | file from the current Emacs tree, containing only those files |
| 50 | appropriate for distribution. If you make extensive changes to Emacs, |
| 51 | this script will help you distribute your version to others. |
| 52 | |
| 53 | There are several subdirectories: |
| 54 | |
| 55 | `src' holds the C code for Emacs (the Emacs Lisp interpreter and |
| 56 | its primitives, the redisplay code, and some basic editing |
| 57 | functions). |
| 58 | `lisp' holds the Emacs Lisp code for Emacs (most everything else). |
| 59 | `leim' holds the library of Emacs input methods, Lisp code and |
| 60 | auxiliary data files required to type international characters |
| 61 | which can't be directly produced by your keyboard. |
| 62 | `lib-src' holds the source code for some utility programs for use by or |
| 63 | with Emacs, like movemail and etags. |
| 64 | `etc' holds miscellaneous architecture-independent data files |
| 65 | Emacs uses, like the tutorial text and the Zippy the Pinhead |
| 66 | quote database. The contents of the `lisp', `leim', `info', |
| 67 | `man', `lispref', and `lispintro' subdirectories are |
| 68 | architecture-independent too. |
| 69 | `info' holds the Info documentation tree for Emacs. |
| 70 | `man' holds the source code for the Emacs Manual. If you modify the |
| 71 | manual sources, you will need the `makeinfo' program to produce |
| 72 | an updated manual. `makeinfo' is part of the GNU Texinfo |
| 73 | package; you need version 4.2 or later of Texinfo. |
| 74 | `lispref' holds the source code for the Emacs Lisp reference manual. |
| 75 | `lispintro' holds the source code for the Introduction to Programming |
| 76 | in Emacs Lisp manual. |
| 77 | |
| 78 | `msdos' holds configuration files for compiling Emacs under MSDOG. |
| 79 | `vms' holds instructions and useful files for running Emacs under VMS. |
| 80 | `nt' holds various command files and documentation files that pertain |
| 81 | to building and running Emacs on Windows 9X/ME/NT/2000/XP. |
| 82 | `mac' holds instructions, sources, and other useful files for building |
| 83 | and running Emacs on the Mac. |
| 84 | |
| 85 | Building Emacs on non-Posix platforms requires to install tools |
| 86 | that aren't part of the standard distribution of the OS. The |
| 87 | platform-specific README files and installation instructions should |
| 88 | list the required tools. |
| 89 | |
| 90 | VMS info: |
| 91 | |
| 92 | Emacs 19.x and above do not compile out of the box on OpenVMS. |
| 93 | Richard Levitte <levitte@lp.se> is distributing and maintaining a |
| 94 | version of Emacs (currently based on version 19.28, but soon moving to |
| 95 | 19.34 and then 20.1) that compiles and works on OpenVMS 5.5 and above |
| 96 | on both VAX and Alpha architectures. For more information see |
| 97 | |
| 98 | http://www.lp.se/gnu-vms/software/released1/emacs.html |
| 99 | |
| 100 | There is also some effort going on with Emacs 21. Source code is |
| 101 | available at ftp://ftp.nvg.ntnu.no/pub/vms/emacs/. Look for most |
| 102 | recent stuff with ls -lta. |
| 103 | |
| 104 | It is a working "development" version (editing and much more works). |
| 105 | More developers are needed; contact roart@nvg.ntnu.no. |