annotate README @ 74808:1dc5d7ba3c64

* info.el (Info-fontify-maximum-menu-size): Bump to 1000000. (Info-fontify-node): Do fontify indices.
author Chong Yidong <cyd@stupidchicken.com>
date Fri, 22 Dec 2006 19:48:59 +0000
parents 73ea4cc2cd07
children 509f6ba78c65
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
74759
73ea4cc2cd07 Bump version number to 22.0.92
Chong Yidong <cyd@stupidchicken.com>
parents: 74308
diff changeset
1 This directory tree holds version 22.0.92 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
74308
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
4 The file INSTALL in this directory says how to build and install GNU
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
5 Emacs on various systems, once you have unpacked or checked out the
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
6 entire Emacs file tree.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
7
36122
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
8 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
9 user-visible changes in recent versions of Emacs.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
10
Dave Love <fx@gnu.org>
parents:
diff changeset
11 The file etc/PROBLEMS contains information on many common problems that
Dave Love <fx@gnu.org>
parents:
diff changeset
12 occur in building, installing and running Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
13
74308
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
14 You may encounter bugs in this release. If you do, please report
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
15 them; your bug reports are valuable contributions to the FSF, since
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
16 they allow us to notice and fix problems on machines we don't have, or
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
17 in code we don't use often. Please send bug reports for released
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
18 versions of Emacs sent to the mailing list bug-gnu-emacs@gnu.org.
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
19 Please send bug reports for pretest versions of Emacs, and versions
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
20 from the Savannah.gnu.org repository, to emacs-pretest-bugs@gnu.org.
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
21
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
22 See the "Bugs" section of the Emacs manual for more information on how
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
23 to report bugs. (The file `BUGS' in this directory explains how you
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
24 can find and read that section using the Info files that come with
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
25 Emacs.) See `etc/MAILINGLISTS' for more information on mailing lists
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
26 relating to GNU packages.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
27
36792
f4f0878e1455 Minor changes from Kim Storm <storm@filanet.dk>.
Eli Zaretskii <eliz@gnu.org>
parents: 36541
diff changeset
28 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
29 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
30 Emacs.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
31
Dave Love <fx@gnu.org>
parents:
diff changeset
32 The file `configure' is a shell script to acclimate Emacs to the
Dave Love <fx@gnu.org>
parents:
diff changeset
33 oddities of your processor and operating system. It creates the file
Dave Love <fx@gnu.org>
parents:
diff changeset
34 `Makefile' (a script for the `make' program), which automates the
Dave Love <fx@gnu.org>
parents:
diff changeset
35 process of building and installing Emacs. See INSTALL for more
Dave Love <fx@gnu.org>
parents:
diff changeset
36 detailed information.
Dave Love <fx@gnu.org>
parents:
diff changeset
37
Dave Love <fx@gnu.org>
parents:
diff changeset
38 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
39 construct the `configure' script. Since Emacs has some configuration
475b449e3903 Amend autoconf/configure stuff.
Dave Love <fx@gnu.org>
parents: 36122
diff changeset
40 requirements that autoconf can't meet directly, and for historical
475b449e3903 Amend autoconf/configure stuff.
Dave Love <fx@gnu.org>
parents: 36122
diff changeset
41 reasons, `configure.in' uses an unholy marriage of custom-baked
475b449e3903 Amend autoconf/configure stuff.
Dave Love <fx@gnu.org>
parents: 36122
diff changeset
42 configuration code and autoconf macros. If you want to rebuild
475b449e3903 Amend autoconf/configure stuff.
Dave Love <fx@gnu.org>
parents: 36122
diff changeset
43 `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
44 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
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
42214
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
56 `src' holds the C code for Emacs (the Emacs Lisp interpreter and
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 47784
diff changeset
57 its primitives, the redisplay code, and some basic editing
42214
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
58 functions).
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
59 `lisp' holds the Emacs Lisp code for Emacs (most everything else).
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 47784
diff changeset
60 `leim' holds the library of Emacs input methods, Lisp code and
42214
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
61 auxiliary data files required to type international characters
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
62 which can't be directly produced by your keyboard.
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
63 `lib-src' holds the source code for some utility programs for use by or
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
64 with Emacs, like movemail and etags.
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
65 `etc' holds miscellaneous architecture-independent data files
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
66 Emacs uses, like the tutorial text and the Zippy the Pinhead
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
67 quote database. The contents of the `lisp', `leim', `info',
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
68 `man', `lispref', and `lispintro' subdirectories are
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
69 architecture-independent too.
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
70 `info' holds the Info documentation tree for Emacs.
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
71 `man' holds the source code for the Emacs Manual. If you modify the
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
72 manual sources, you will need the `makeinfo' program to produce
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
73 an updated manual. `makeinfo' is part of the GNU Texinfo
46404
24100426242b Mention Texinfo 4.2 needed.
Richard M. Stallman <rms@gnu.org>
parents: 45511
diff changeset
74 package; you need version 4.2 or later of Texinfo.
42214
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
75 `lispref' holds the source code for the Emacs Lisp reference manual.
41438
ae71c1ab060d Add lispintro.
Eli Zaretskii <eliz@gnu.org>
parents: 41050
diff changeset
76 `lispintro' holds the source code for the Introduction to Programming
ae71c1ab060d Add lispintro.
Eli Zaretskii <eliz@gnu.org>
parents: 41050
diff changeset
77 in Emacs Lisp manual.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
78
42214
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
79 `msdos' holds configuration files for compiling Emacs under MSDOG.
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
80 `vms' holds instructions and useful files for running Emacs under VMS.
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
81 `nt' holds various command files and documentation files that pertain
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
82 to building and running Emacs on Windows 9X/ME/NT/2000/XP.
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
83 `mac' holds instructions, sources, and other useful files for building
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
84 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
85
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
86 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
87 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
88 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
89 list the required tools.