annotate README @ 26585:3ec5a485d0ab

*** empty log message ***
author Michael Kifer <kifer@cs.stonybrook.edu>
date Thu, 25 Nov 1999 04:34:23 +0000
parents 354e0c45cedf
children 6ea9f51b4d73
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
1 This directory tree holds version 20.0 of GNU Emacs, the extensible,
Dave Love <fx@gnu.org>
parents:
diff changeset
2 customizable, self-documenting real-time display editor.
Dave Love <fx@gnu.org>
parents:
diff changeset
3
Dave Love <fx@gnu.org>
parents:
diff changeset
4 You may encounter bugs in this release. If you do, please report
Dave Love <fx@gnu.org>
parents:
diff changeset
5 them; your bug reports are valuable contributions to the FSF, since
Dave Love <fx@gnu.org>
parents:
diff changeset
6 they allow us to notice and fix problems on machines we don't have, or
Dave Love <fx@gnu.org>
parents:
diff changeset
7 in code we don't use often. See the file BUGS for more information on
Dave Love <fx@gnu.org>
parents:
diff changeset
8 how to report bugs.
Dave Love <fx@gnu.org>
parents:
diff changeset
9
Dave Love <fx@gnu.org>
parents:
diff changeset
10 See the files `etc/NEWS' and `etc/news.texi' for information on new
Dave Love <fx@gnu.org>
parents:
diff changeset
11 features and other user-visible changes since the last version of
Dave Love <fx@gnu.org>
parents:
diff changeset
12 Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
13
Dave Love <fx@gnu.org>
parents:
diff changeset
14 The file INSTALL in this directory says how to bring up GNU Emacs on
Dave Love <fx@gnu.org>
parents:
diff changeset
15 Unix, once you have loaded the entire subtree of this directory.
Dave Love <fx@gnu.org>
parents:
diff changeset
16
Dave Love <fx@gnu.org>
parents:
diff changeset
17 The file etc/PROBLEMS contains information on many common problems that
Dave Love <fx@gnu.org>
parents:
diff changeset
18 occur in building, installing and running Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
19
Dave Love <fx@gnu.org>
parents:
diff changeset
20 Reports of bugs in Emacs should be sent to the mailing list
Dave Love <fx@gnu.org>
parents:
diff changeset
21 bug-gnu-emacs@gnu.org. See the "Bugs" section of the Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
22 manual for more information on how to report bugs. (The file `BUGS'
Dave Love <fx@gnu.org>
parents:
diff changeset
23 in this directory explains how you can find and read that section
Dave Love <fx@gnu.org>
parents:
diff changeset
24 using the Info files that come with Emacs.) See `etc/MAILINGLISTS'
Dave Love <fx@gnu.org>
parents:
diff changeset
25 for more information on mailing lists relating to GNU packages.
Dave Love <fx@gnu.org>
parents:
diff changeset
26
Dave Love <fx@gnu.org>
parents:
diff changeset
27 The `etc' subdirectory contains several other files, named in
Dave Love <fx@gnu.org>
parents:
diff changeset
28 capital letters, which you should look at when installing GNU Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
29
Dave Love <fx@gnu.org>
parents:
diff changeset
30 The file `configure' is a shell script to acclimate Emacs to the
Dave Love <fx@gnu.org>
parents:
diff changeset
31 oddities of your processor and operating system. It creates the file
Dave Love <fx@gnu.org>
parents:
diff changeset
32 `Makefile' (a script for the `make' program), which automates the
Dave Love <fx@gnu.org>
parents:
diff changeset
33 process of building and installing Emacs. See INSTALL for more
Dave Love <fx@gnu.org>
parents:
diff changeset
34 detailed information.
Dave Love <fx@gnu.org>
parents:
diff changeset
35
Dave Love <fx@gnu.org>
parents:
diff changeset
36 The file `configure.in' is the input used by the autoconf program to
Dave Love <fx@gnu.org>
parents:
diff changeset
37 construct the `configure' script. Since Emacs has configuration
Dave Love <fx@gnu.org>
parents:
diff changeset
38 requirements that autoconf can't meet, `configure.in' uses an unholy
Dave Love <fx@gnu.org>
parents:
diff changeset
39 marriage of custom-baked configuration code and autoconf macros; it
Dave Love <fx@gnu.org>
parents:
diff changeset
40 may be wise to avoid rebuilding `configure' from `configure.in' when
Dave Love <fx@gnu.org>
parents:
diff changeset
41 possible.
Dave Love <fx@gnu.org>
parents:
diff changeset
42
Dave Love <fx@gnu.org>
parents:
diff changeset
43 The file `Makefile.in' is a template used by `configure' to create
Dave Love <fx@gnu.org>
parents:
diff changeset
44 `Makefile'.
Dave Love <fx@gnu.org>
parents:
diff changeset
45
Dave Love <fx@gnu.org>
parents:
diff changeset
46 The file `make-dist' is a shell script to build a distribution tar
Dave Love <fx@gnu.org>
parents:
diff changeset
47 file from the current Emacs tree, containing only those files
Dave Love <fx@gnu.org>
parents:
diff changeset
48 appropriate for distribution. If you make extensive changes to Emacs,
Dave Love <fx@gnu.org>
parents:
diff changeset
49 this script will help you distribute your version to others.
Dave Love <fx@gnu.org>
parents:
diff changeset
50
Dave Love <fx@gnu.org>
parents:
diff changeset
51 There are several subdirectories:
Dave Love <fx@gnu.org>
parents:
diff changeset
52
Dave Love <fx@gnu.org>
parents:
diff changeset
53 `src' holds the C code for Emacs (the Emacs Lisp interpreter and its
Dave Love <fx@gnu.org>
parents:
diff changeset
54 primitives, the redisplay code, and some basic editing functions).
Dave Love <fx@gnu.org>
parents:
diff changeset
55 `lisp' holds the Emacs Lisp code for Emacs (most everything else).
Dave Love <fx@gnu.org>
parents:
diff changeset
56 `lib-src' holds the source code for some utility programs for use by
Dave Love <fx@gnu.org>
parents:
diff changeset
57 or with Emacs, like movemail and etags.
Dave Love <fx@gnu.org>
parents:
diff changeset
58 `etc' holds miscellaneous architecture-independent data files
Dave Love <fx@gnu.org>
parents:
diff changeset
59 Emacs uses, like the tutorial text and the Zippy the Pinhead quote
Dave Love <fx@gnu.org>
parents:
diff changeset
60 database. The contents of the `lisp', `info' and `man'
Dave Love <fx@gnu.org>
parents:
diff changeset
61 subdirectories are architecture-independent too.
Dave Love <fx@gnu.org>
parents:
diff changeset
62
Dave Love <fx@gnu.org>
parents:
diff changeset
63 `info' holds the Info documentation tree for Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
64 `man' holds the source code for the Emacs manual.
Dave Love <fx@gnu.org>
parents:
diff changeset
65
Dave Love <fx@gnu.org>
parents:
diff changeset
66 Note that the Emacs Lisp manual sources are distributed separately.
Dave Love <fx@gnu.org>
parents:
diff changeset
67 (They are twice as large as the Emacs manual in the man subdirectory.)
Dave Love <fx@gnu.org>
parents:
diff changeset
68
Dave Love <fx@gnu.org>
parents:
diff changeset
69 `msdos' holds configuration files for compiling Emacs under MSDOG.
Dave Love <fx@gnu.org>
parents:
diff changeset
70 `vms' holds instructions and useful files for running Emacs under VMS.
Dave Love <fx@gnu.org>
parents:
diff changeset
71 `nt' holds various command files and documentation files that pertain
Dave Love <fx@gnu.org>
parents:
diff changeset
72 to running Emacs on Windows NT.