annotate README @ 40992:15aec38184e1

*** empty log message ***
author Pavel Janík <Pavel@Janik.cz>
date Tue, 13 Nov 2001 07:09:22 +0000
parents 013e077e41d0
children af61f6964add
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
39875
013e077e41d0 Bump Emacs version to 21.1.50.
Eli Zaretskii <eliz@gnu.org>
parents: 39438
diff changeset
1 This directory tree holds version 21.1.50 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
36792
f4f0878e1455 Minor changes from Kim Storm <storm@filanet.dk>.
Eli Zaretskii <eliz@gnu.org>
parents: 36541
diff changeset
11 user-visible changes in recent versions 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
36792
f4f0878e1455 Minor changes from Kim Storm <storm@filanet.dk>.
Eli Zaretskii <eliz@gnu.org>
parents: 36541
diff changeset
14 various systems, once you have loaded the entire subtree of this
f4f0878e1455 Minor changes from Kim Storm <storm@filanet.dk>.
Eli Zaretskii <eliz@gnu.org>
parents: 36541
diff changeset
15 directory.
25856
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
36792
f4f0878e1455 Minor changes from Kim Storm <storm@filanet.dk>.
Eli Zaretskii <eliz@gnu.org>
parents: 36541
diff changeset
27 The `etc' subdirectory contains several other files, named in capital
f4f0878e1455 Minor changes from Kim Storm <storm@filanet.dk>.
Eli Zaretskii <eliz@gnu.org>
parents: 36541
diff changeset
28 letters, which you might consider looking at when installing GNU
f4f0878e1455 Minor changes from Kim Storm <storm@filanet.dk>.
Eli Zaretskii <eliz@gnu.org>
parents: 36541
diff changeset
29 Emacs.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
30
Dave Love <fx@gnu.org>
parents:
diff changeset
31 The file `configure' is a shell script to acclimate Emacs to the
Dave Love <fx@gnu.org>
parents:
diff changeset
32 oddities of your processor and operating system. It creates the file
Dave Love <fx@gnu.org>
parents:
diff changeset
33 `Makefile' (a script for the `make' program), which automates the
Dave Love <fx@gnu.org>
parents:
diff changeset
34 process of building and installing Emacs. See INSTALL for more
Dave Love <fx@gnu.org>
parents:
diff changeset
35 detailed information.
Dave Love <fx@gnu.org>
parents:
diff changeset
36
Dave Love <fx@gnu.org>
parents:
diff changeset
37 The file `configure.in' is the input used by the autoconf program to
36268
475b449e3903 Amend autoconf/configure stuff.
Dave Love <fx@gnu.org>
parents: 36122
diff changeset
38 construct the `configure' script. Since Emacs has some configuration
475b449e3903 Amend autoconf/configure stuff.
Dave Love <fx@gnu.org>
parents: 36122
diff changeset
39 requirements that autoconf can't meet directly, and for historical
475b449e3903 Amend autoconf/configure stuff.
Dave Love <fx@gnu.org>
parents: 36122
diff changeset
40 reasons, `configure.in' uses an unholy marriage of custom-baked
475b449e3903 Amend autoconf/configure stuff.
Dave Love <fx@gnu.org>
parents: 36122
diff changeset
41 configuration code and autoconf macros. If you want to rebuild
475b449e3903 Amend autoconf/configure stuff.
Dave Love <fx@gnu.org>
parents: 36122
diff changeset
42 `configure' from `configure.in', you will need to install a recent
475b449e3903 Amend autoconf/configure stuff.
Dave Love <fx@gnu.org>
parents: 36122
diff changeset
43 version of autoconf and GNU m4.
36122
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
44
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
45 The file `Makefile.in' is a template used by `configure' to create
Dave Love <fx@gnu.org>
parents:
diff changeset
46 `Makefile'.
Dave Love <fx@gnu.org>
parents:
diff changeset
47
Dave Love <fx@gnu.org>
parents:
diff changeset
48 The file `make-dist' is a shell script to build a distribution tar
Dave Love <fx@gnu.org>
parents:
diff changeset
49 file from the current Emacs tree, containing only those files
Dave Love <fx@gnu.org>
parents:
diff changeset
50 appropriate for distribution. If you make extensive changes to Emacs,
Dave Love <fx@gnu.org>
parents:
diff changeset
51 this script will help you distribute your version to others.
Dave Love <fx@gnu.org>
parents:
diff changeset
52
Dave Love <fx@gnu.org>
parents:
diff changeset
53 There are several subdirectories:
Dave Love <fx@gnu.org>
parents:
diff changeset
54
Dave Love <fx@gnu.org>
parents:
diff changeset
55 `src' holds the C code for Emacs (the Emacs Lisp interpreter and its
Dave Love <fx@gnu.org>
parents:
diff changeset
56 primitives, the redisplay code, and some basic editing functions).
Dave Love <fx@gnu.org>
parents:
diff changeset
57 `lisp' holds the Emacs Lisp code for Emacs (most everything else).
Dave Love <fx@gnu.org>
parents:
diff changeset
58 `lib-src' holds the source code for some utility programs for use by
Dave Love <fx@gnu.org>
parents:
diff changeset
59 or with Emacs, like movemail and etags.
Dave Love <fx@gnu.org>
parents:
diff changeset
60 `etc' holds miscellaneous architecture-independent data files
Dave Love <fx@gnu.org>
parents:
diff changeset
61 Emacs uses, like the tutorial text and the Zippy the Pinhead quote
Dave Love <fx@gnu.org>
parents:
diff changeset
62 database. The contents of the `lisp', `info' and `man'
Dave Love <fx@gnu.org>
parents:
diff changeset
63 subdirectories are architecture-independent too.
Dave Love <fx@gnu.org>
parents:
diff changeset
64
Dave Love <fx@gnu.org>
parents:
diff changeset
65 `info' holds the Info documentation tree for Emacs.
36814
6f69f0f12a7c Fix the names of Emacs manuals. From Kim Storm.
Eli Zaretskii <eliz@gnu.org>
parents: 36812
diff changeset
66 `man' holds the source code for the Emacs Manual. If you modify the
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 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
68 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
69 package; you need version 4.0 or later of Texinfo.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
70
36814
6f69f0f12a7c Fix the names of Emacs manuals. From Kim Storm.
Eli Zaretskii <eliz@gnu.org>
parents: 36812
diff changeset
71 Note that the Emacs Lisp Reference Manual sources are distributed
6f69f0f12a7c Fix the names of Emacs manuals. From Kim Storm.
Eli Zaretskii <eliz@gnu.org>
parents: 36812
diff changeset
72 separately. (They are twice as large as the Emacs Manual in the man
6f69f0f12a7c Fix the names of Emacs manuals. From Kim Storm.
Eli Zaretskii <eliz@gnu.org>
parents: 36812
diff changeset
73 subdirectory.)
25856
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.