README 5.06 KB
Newer Older
Eli Zaretskii's avatar
Eli Zaretskii committed
1
This directory tree holds version 21.3.50 of GNU Emacs, the extensible,
Dave Love's avatar
#  
Dave Love committed
2 3 4 5 6 7 8 9
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.

10
See the file etc/NEWS for information on new features and other
11
user-visible changes in recent versions of Emacs.
Dave Love's avatar
#  
Dave Love committed
12 13

The file INSTALL in this directory says how to bring up GNU Emacs on
14 15
various systems, once you have loaded the entire subtree of this
directory.
Dave Love's avatar
#  
Dave Love committed
16 17 18 19 20 21 22 23 24 25 26

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.

27 28 29
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
30 31 32 33 34 35 36 37

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
38 39 40 41 42 43
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.
44

Dave Love's avatar
#  
Dave Love committed
45 46 47 48 49 50 51 52 53 54
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:

55
`src'       holds the C code for Emacs (the Emacs Lisp interpreter and
56
            its primitives, the redisplay code, and some basic editing
57 58
            functions).
`lisp'      holds the Emacs Lisp code for Emacs (most everything else).
59
`leim'      holds the library of Emacs input methods, Lisp code and
60 61 62 63 64 65 66 67 68 69 70 71 72
            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
73
            package; you need version 4.2 or later of Texinfo.
74
`lispref'   holds the source code for the Emacs Lisp reference manual.
Eli Zaretskii's avatar
Eli Zaretskii committed
75 76
`lispintro' holds the source code for the Introduction to Programming
            in Emacs Lisp manual.
Dave Love's avatar
#  
Dave Love committed
77

78 79 80 81 82 83
`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.
84 85 86 87 88

   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.
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105

VMS info:

Emacs 19.x and above do not compile out of the box on OpenVMS.
Richard Levitte <levitte@lp.se> is distributing and maintaining a
version of Emacs (currently based on version 19.28, but soon moving to
19.34 and then 20.1) that compiles and works on OpenVMS 5.5 and above
on both VAX and Alpha architectures.  For more information see

  http://vms.gnu.org/software/released1/emacs.html#get_emacs_1928_kit

There is also some effort going on with Emacs 21.  Source code is
available at ftp://ftp.nvg.ntnu.no/pub/vms/emacs/.  Look for most
recent stuff with ls -lta.

It is a working "development" version (editing and much more works).
More developers are needed; contact roart@nvg.ntnu.no.