Mercurial > emacs
annotate README @ 36208:898561c41ba0
FIx xref to Display Custom.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Mon, 19 Feb 2001 23:36:31 +0000 |
parents | e6572f8d3aa8 |
children | 475b449e3903 |
rev | line source |
---|---|
36104 | 1 This directory tree holds version 21.0.99 of GNU Emacs, the extensible, |
25856 | 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 | |
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 | 12 |
13 The file INSTALL in this directory says how to bring up GNU Emacs on | |
14 Unix, once you have loaded the entire subtree of this directory. | |
15 | |
16 The file etc/PROBLEMS contains information on many common problems that | |
17 occur in building, installing and running Emacs. | |
18 | |
19 Reports of bugs in Emacs should be sent to the mailing list | |
20 bug-gnu-emacs@gnu.org. See the "Bugs" section of the Emacs | |
21 manual for more information on how to report bugs. (The file `BUGS' | |
22 in this directory explains how you can find and read that section | |
23 using the Info files that come with Emacs.) See `etc/MAILINGLISTS' | |
24 for more information on mailing lists relating to GNU packages. | |
25 | |
26 The `etc' subdirectory contains several other files, named in | |
27 capital letters, which you should look at when installing GNU Emacs. | |
28 | |
29 The file `configure' is a shell script to acclimate Emacs to the | |
30 oddities of your processor and operating system. It creates the file | |
31 `Makefile' (a script for the `make' program), which automates the | |
32 process of building and installing Emacs. See INSTALL for more | |
33 detailed information. | |
34 | |
35 The file `configure.in' is the input used by the autoconf program to | |
36 construct the `configure' script. Since Emacs has configuration | |
37 requirements that autoconf can't meet, `configure.in' uses an unholy | |
38 marriage of custom-baked configuration code and autoconf macros; it | |
39 may be wise to avoid rebuilding `configure' from `configure.in' when | |
40 possible. | |
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 | 46 The file `Makefile.in' is a template used by `configure' to create |
47 `Makefile'. | |
48 | |
49 The file `make-dist' is a shell script to build a distribution tar | |
50 file from the current Emacs tree, containing only those files | |
51 appropriate for distribution. If you make extensive changes to Emacs, | |
52 this script will help you distribute your version to others. | |
53 | |
54 There are several subdirectories: | |
55 | |
56 `src' holds the C code for Emacs (the Emacs Lisp interpreter and its | |
57 primitives, the redisplay code, and some basic editing functions). | |
58 `lisp' holds the Emacs Lisp code for Emacs (most everything else). | |
59 `lib-src' holds the source code for some utility programs for use by | |
60 or with Emacs, like movemail and etags. | |
61 `etc' holds miscellaneous architecture-independent data files | |
62 Emacs uses, like the tutorial text and the Zippy the Pinhead quote | |
63 database. The contents of the `lisp', `info' and `man' | |
64 subdirectories are architecture-independent too. | |
65 | |
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 | 71 |
72 Note that the Emacs Lisp manual sources are distributed separately. | |
73 (They are twice as large as the Emacs manual in the man subdirectory.) | |
74 | |
75 `msdos' holds configuration files for compiling Emacs under MSDOG. | |
76 `vms' holds instructions and useful files for running Emacs under VMS. | |
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. |