annotate README @ 36122:e6572f8d3aa8

Document that Texinfo 4.0 or later is required for producing the manual. Say that Autoconf needs GNU m4. Remove etc/news.texi which doesn't exist.
author Eli Zaretskii <eliz@gnu.org>
date Fri, 16 Feb 2001 13:49:36 +0000
parents 72d984e2a0c7
children 475b449e3903
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
36104
72d984e2a0c7 Increment version number.
Gerd Moellmann <gerd@gnu.org>
parents: 35745
diff changeset
1 This directory tree holds version 21.0.99 of GNU Emacs, the extensible,
25856
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
36122
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
10 See the file etc/NEWS for information on new features and other
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
11 user-visible changes since the last version of Emacs.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
12
Dave Love <fx@gnu.org>
parents:
diff changeset
13 The file INSTALL in this directory says how to bring up GNU Emacs on
Dave Love <fx@gnu.org>
parents:
diff changeset
14 Unix, once you have loaded the entire subtree of this directory.
Dave Love <fx@gnu.org>
parents:
diff changeset
15
Dave Love <fx@gnu.org>
parents:
diff changeset
16 The file etc/PROBLEMS contains information on many common problems that
Dave Love <fx@gnu.org>
parents:
diff changeset
17 occur in building, installing and running Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
18
Dave Love <fx@gnu.org>
parents:
diff changeset
19 Reports of bugs in Emacs should be sent to the mailing list
Dave Love <fx@gnu.org>
parents:
diff changeset
20 bug-gnu-emacs@gnu.org. See the "Bugs" section of the Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
21 manual for more information on how to report bugs. (The file `BUGS'
Dave Love <fx@gnu.org>
parents:
diff changeset
22 in this directory explains how you can find and read that section
Dave Love <fx@gnu.org>
parents:
diff changeset
23 using the Info files that come with Emacs.) See `etc/MAILINGLISTS'
Dave Love <fx@gnu.org>
parents:
diff changeset
24 for more information on mailing lists relating to GNU packages.
Dave Love <fx@gnu.org>
parents:
diff changeset
25
Dave Love <fx@gnu.org>
parents:
diff changeset
26 The `etc' subdirectory contains several other files, named in
Dave Love <fx@gnu.org>
parents:
diff changeset
27 capital letters, which you should look at when installing GNU Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
28
Dave Love <fx@gnu.org>
parents:
diff changeset
29 The file `configure' is a shell script to acclimate Emacs to the
Dave Love <fx@gnu.org>
parents:
diff changeset
30 oddities of your processor and operating system. It creates the file
Dave Love <fx@gnu.org>
parents:
diff changeset
31 `Makefile' (a script for the `make' program), which automates the
Dave Love <fx@gnu.org>
parents:
diff changeset
32 process of building and installing Emacs. See INSTALL for more
Dave Love <fx@gnu.org>
parents:
diff changeset
33 detailed information.
Dave Love <fx@gnu.org>
parents:
diff changeset
34
Dave Love <fx@gnu.org>
parents:
diff changeset
35 The file `configure.in' is the input used by the autoconf program to
Dave Love <fx@gnu.org>
parents:
diff changeset
36 construct the `configure' script. Since Emacs has configuration
Dave Love <fx@gnu.org>
parents:
diff changeset
37 requirements that autoconf can't meet, `configure.in' uses an unholy
Dave Love <fx@gnu.org>
parents:
diff changeset
38 marriage of custom-baked configuration code and autoconf macros; it
Dave Love <fx@gnu.org>
parents:
diff changeset
39 may be wise to avoid rebuilding `configure' from `configure.in' when
Dave Love <fx@gnu.org>
parents:
diff changeset
40 possible.
Dave Love <fx@gnu.org>
parents:
diff changeset
41
36122
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
42 If you do want to rebuild `configure' from `configure.in', you will
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
43 need to install autoconf and GNU m4 (the version of m4 supplied with
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
44 your system might not be enough).
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
45
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
46 The file `Makefile.in' is a template used by `configure' to create
Dave Love <fx@gnu.org>
parents:
diff changeset
47 `Makefile'.
Dave Love <fx@gnu.org>
parents:
diff changeset
48
Dave Love <fx@gnu.org>
parents:
diff changeset
49 The file `make-dist' is a shell script to build a distribution tar
Dave Love <fx@gnu.org>
parents:
diff changeset
50 file from the current Emacs tree, containing only those files
Dave Love <fx@gnu.org>
parents:
diff changeset
51 appropriate for distribution. If you make extensive changes to Emacs,
Dave Love <fx@gnu.org>
parents:
diff changeset
52 this script will help you distribute your version to others.
Dave Love <fx@gnu.org>
parents:
diff changeset
53
Dave Love <fx@gnu.org>
parents:
diff changeset
54 There are several subdirectories:
Dave Love <fx@gnu.org>
parents:
diff changeset
55
Dave Love <fx@gnu.org>
parents:
diff changeset
56 `src' holds the C code for Emacs (the Emacs Lisp interpreter and its
Dave Love <fx@gnu.org>
parents:
diff changeset
57 primitives, the redisplay code, and some basic editing functions).
Dave Love <fx@gnu.org>
parents:
diff changeset
58 `lisp' holds the Emacs Lisp code for Emacs (most everything else).
Dave Love <fx@gnu.org>
parents:
diff changeset
59 `lib-src' holds the source code for some utility programs for use by
Dave Love <fx@gnu.org>
parents:
diff changeset
60 or with Emacs, like movemail and etags.
Dave Love <fx@gnu.org>
parents:
diff changeset
61 `etc' holds miscellaneous architecture-independent data files
Dave Love <fx@gnu.org>
parents:
diff changeset
62 Emacs uses, like the tutorial text and the Zippy the Pinhead quote
Dave Love <fx@gnu.org>
parents:
diff changeset
63 database. The contents of the `lisp', `info' and `man'
Dave Love <fx@gnu.org>
parents:
diff changeset
64 subdirectories are architecture-independent too.
Dave Love <fx@gnu.org>
parents:
diff changeset
65
Dave Love <fx@gnu.org>
parents:
diff changeset
66 `info' holds the Info documentation tree for Emacs.
36122
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
67 `man' holds the source code for the Emacs manual. If you modify the
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
68 manual sources, you will need the `makeinfo' program to produce
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
69 an updated manual. `makeinfo' is part of the GNU Texinfo
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
70 package; you need version 4.0 or later of Texinfo.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
71
Dave Love <fx@gnu.org>
parents:
diff changeset
72 Note that the Emacs Lisp manual sources are distributed separately.
Dave Love <fx@gnu.org>
parents:
diff changeset
73 (They are twice as large as the Emacs manual in the man subdirectory.)
Dave Love <fx@gnu.org>
parents:
diff changeset
74
Dave Love <fx@gnu.org>
parents:
diff changeset
75 `msdos' holds configuration files for compiling Emacs under MSDOG.
Dave Love <fx@gnu.org>
parents:
diff changeset
76 `vms' holds instructions and useful files for running Emacs under VMS.
Dave Love <fx@gnu.org>
parents:
diff changeset
77 `nt' holds various command files and documentation files that pertain
36122
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
78 to running Emacs on Windows NT.
34292
788ba4b547d1 Mention the `mac' subdirectory.
Eli Zaretskii <eliz@gnu.org>
parents: 33973
diff changeset
79 `mac' holds instructions, sources, and other useful files for building
788ba4b547d1 Mention the `mac' subdirectory.
Eli Zaretskii <eliz@gnu.org>
parents: 33973
diff changeset
80 and running Emacs on the Mac.
36122
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
81
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
82 Building Emacs on non-Posix platforms requires to install tools
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
83 that aren't part of the standard distribution of the OS. The
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
84 platform-specific README files and installation instructions should
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
85 list the required tools.