annotate README @ 112412:647e164c1f3e

aclocal.m4: put this file back into repository This way, we don't have to assume that the maintainer has the automake package installed. See <http://lists.gnu.org/archive/html/emacs-devel/2011-01/msg00746.html>. * .bzrignore: Remove aclocal.m4, undoing the previous change. * Makefile.in (top_maintainer_clean): Do not remove aclocal.m4, undoing the previous change. * aclocal.m4: New file (actually, resurrected).
author Paul Eggert <eggert@cs.ucla.edu>
date Fri, 21 Jan 2011 23:18:23 -0800
parents 17e0028efc29
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
106802
b92c3979701c Replace emacs-pretest-bug with bug-gnu-emacs mailing list.
Glenn Morris <rgm@gnu.org>
parents: 106687
diff changeset
1 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
112218
376148b31b5e Add 2011 to FSF/AIST copyright years.
Glenn Morris <rgm@gnu.org>
parents: 111933
diff changeset
2 2010, 2011 Free Software Foundation, Inc.
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
3 See the end of the file for license conditions.
75587
68cfc1db0d26 Add copyright and permissions notices.
Glenn Morris <rgm@gnu.org>
parents: 75382
diff changeset
4
68cfc1db0d26 Add copyright and permissions notices.
Glenn Morris <rgm@gnu.org>
parents: 75382
diff changeset
5
111811
ced73eea562f Restore files that I seem to have mistakenly deleted.
Katsumi Yamaoka <yamaoka@jpl.org>
parents:
diff changeset
6 This directory tree holds version 24.0.50 of GNU Emacs, the extensible,
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
7 customizable, self-documenting real-time display editor.
Dave Love <fx@gnu.org>
parents:
diff changeset
8
74308
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
9 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
10 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
11 entire Emacs file tree.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
12
36122
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
13 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
14 user-visible changes in recent versions of Emacs.
25856
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
74308
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
19 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
20 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
21 they allow us to notice and fix problems on machines we don't have, or
106802
b92c3979701c Replace emacs-pretest-bug with bug-gnu-emacs mailing list.
Glenn Morris <rgm@gnu.org>
parents: 106687
diff changeset
22 in code we don't use often. Please send bug reports to the mailing
b92c3979701c Replace emacs-pretest-bug with bug-gnu-emacs mailing list.
Glenn Morris <rgm@gnu.org>
parents: 106687
diff changeset
23 list bug-gnu-emacs@gnu.org. If possible, use M-x report-emacs-bug.
74308
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
24
c3e14b761fe6 Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents: 74067
diff changeset
25 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
26 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
27 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
28 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
29 relating to GNU packages.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
30
36792
f4f0878e1455 Minor changes from Kim Storm <storm@filanet.dk>.
Eli Zaretskii <eliz@gnu.org>
parents: 36541
diff changeset
31 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
32 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
33 Emacs.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
34
Dave Love <fx@gnu.org>
parents:
diff changeset
35 The file `configure' is a shell script to acclimate Emacs to the
Dave Love <fx@gnu.org>
parents:
diff changeset
36 oddities of your processor and operating system. It creates the file
Dave Love <fx@gnu.org>
parents:
diff changeset
37 `Makefile' (a script for the `make' program), which automates the
Dave Love <fx@gnu.org>
parents:
diff changeset
38 process of building and installing Emacs. See INSTALL for more
Dave Love <fx@gnu.org>
parents:
diff changeset
39 detailed information.
Dave Love <fx@gnu.org>
parents:
diff changeset
40
Dave Love <fx@gnu.org>
parents:
diff changeset
41 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
42 construct the `configure' script. Since Emacs has some configuration
475b449e3903 Amend autoconf/configure stuff.
Dave Love <fx@gnu.org>
parents: 36122
diff changeset
43 requirements that autoconf can't meet directly, and for historical
475b449e3903 Amend autoconf/configure stuff.
Dave Love <fx@gnu.org>
parents: 36122
diff changeset
44 reasons, `configure.in' uses an unholy marriage of custom-baked
475b449e3903 Amend autoconf/configure stuff.
Dave Love <fx@gnu.org>
parents: 36122
diff changeset
45 configuration code and autoconf macros. If you want to rebuild
475b449e3903 Amend autoconf/configure stuff.
Dave Love <fx@gnu.org>
parents: 36122
diff changeset
46 `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
47 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
48
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
49 The file `Makefile.in' is a template used by `configure' to create
Dave Love <fx@gnu.org>
parents:
diff changeset
50 `Makefile'.
Dave Love <fx@gnu.org>
parents:
diff changeset
51
Dave Love <fx@gnu.org>
parents:
diff changeset
52 The file `make-dist' is a shell script to build a distribution tar
Dave Love <fx@gnu.org>
parents:
diff changeset
53 file from the current Emacs tree, containing only those files
Dave Love <fx@gnu.org>
parents:
diff changeset
54 appropriate for distribution. If you make extensive changes to Emacs,
Dave Love <fx@gnu.org>
parents:
diff changeset
55 this script will help you distribute your version to others.
Dave Love <fx@gnu.org>
parents:
diff changeset
56
Dave Love <fx@gnu.org>
parents:
diff changeset
57 There are several subdirectories:
Dave Love <fx@gnu.org>
parents:
diff changeset
58
42214
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
59 `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
60 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
61 functions).
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
62 `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
63 `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
64 auxiliary data files required to type international characters
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
65 which can't be directly produced by your keyboard.
112302
c428fb33aede Automate syncing from gnulib.
Paul Eggert <eggert@cs.ucla.edu>
parents: 111811
diff changeset
66 `lib' holds source code for libraries used by Emacs and its utilities
42214
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
67 `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
68 with Emacs, like movemail and etags.
110981
dbe481657418 * README: Updates.
Glenn Morris <rgm@gnu.org>
parents: 108372
diff changeset
69 `etc' holds miscellaneous architecture-independent data files Emacs
dbe481657418 * README: Updates.
Glenn Morris <rgm@gnu.org>
parents: 108372
diff changeset
70 uses, like the tutorial text and tool bar images.
dbe481657418 * README: Updates.
Glenn Morris <rgm@gnu.org>
parents: 108372
diff changeset
71 The contents of the `lisp', `leim', `info', and `doc'
dbe481657418 * README: Updates.
Glenn Morris <rgm@gnu.org>
parents: 108372
diff changeset
72 subdirectories are architecture-independent too.
42214
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
73 `info' holds the Info documentation tree for Emacs.
84412
acde5b207e40 Add doc/ to documentation directories.
Juri Linkov <juri@jurta.org>
parents: 83746
diff changeset
74 `doc/emacs' holds the source code for the Emacs Manual. If you modify the
42214
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
75 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
76 an updated manual. `makeinfo' is part of the GNU Texinfo
110981
dbe481657418 * README: Updates.
Glenn Morris <rgm@gnu.org>
parents: 108372
diff changeset
77 package; you need a suitably recent version of Texinfo.
84412
acde5b207e40 Add doc/ to documentation directories.
Juri Linkov <juri@jurta.org>
parents: 83746
diff changeset
78 `doc/lispref' holds the source code for the Emacs Lisp reference manual.
acde5b207e40 Add doc/ to documentation directories.
Juri Linkov <juri@jurta.org>
parents: 83746
diff changeset
79 `doc/lispintro' holds the source code for the Introduction to Programming
acde5b207e40 Add doc/ to documentation directories.
Juri Linkov <juri@jurta.org>
parents: 83746
diff changeset
80 in Emacs Lisp manual.
42214
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
81 `msdos' holds configuration files for compiling Emacs under MSDOG.
98459
f5f32edc5653 Add nextstep directory.
Glenn Morris <rgm@gnu.org>
parents: 97940
diff changeset
82 `nextstep' holds instructions and some other files for compiling the
98512
7d9a5b179102 Fix case of "GNUstep".
Glenn Morris <rgm@gnu.org>
parents: 98459
diff changeset
83 Nextstep port of Emacs, for GNUstep and Mac OS X Cocoa.
42214
515351759218 Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents: 41438
diff changeset
84 `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
85 to building and running Emacs on Windows 9X/ME/NT/2000/XP.
92341
7cf76b7f6146 Mention `test' directory.
Glenn Morris <rgm@gnu.org>
parents: 87649
diff changeset
86 `test' holds tests for various aspects of Emacs's functionality.
36122
e6572f8d3aa8 Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents: 36104
diff changeset
87
110981
dbe481657418 * README: Updates.
Glenn Morris <rgm@gnu.org>
parents: 108372
diff changeset
88 Building Emacs on non-Posix platforms requires tools that aren't part
dbe481657418 * README: Updates.
Glenn Morris <rgm@gnu.org>
parents: 108372
diff changeset
89 of the standard distribution of the OS. The platform-specific README
dbe481657418 * README: Updates.
Glenn Morris <rgm@gnu.org>
parents: 108372
diff changeset
90 files and installation instructions should list the required tools.
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
91
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
92
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
93 This file is part of GNU Emacs.
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
94
94719
1a762a842f80 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 92795
diff changeset
95 GNU Emacs is free software: you can redistribute it and/or modify
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
96 it under the terms of the GNU General Public License as published by
94719
1a762a842f80 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 92795
diff changeset
97 the Free Software Foundation, either version 3 of the License, or
1a762a842f80 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 92795
diff changeset
98 (at your option) any later version.
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
99
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
100 GNU Emacs is distributed in the hope that it will be useful,
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
101 but WITHOUT ANY WARRANTY; without even the implied warranty of
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
102 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
103 GNU General Public License for more details.
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
104
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75587
diff changeset
105 You should have received a copy of the GNU General Public License
94719
1a762a842f80 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 92795
diff changeset
106 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.