Mercurial > emacs
annotate README @ 75587:68cfc1db0d26
Add copyright and permissions notices.
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Thu, 01 Feb 2007 03:10:42 +0000 |
parents | 509f6ba78c65 |
children | 92a0e87ff562 |
rev | line source |
---|---|
75587
68cfc1db0d26
Add copyright and permissions notices.
Glenn Morris <rgm@gnu.org>
parents:
75382
diff
changeset
|
1 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007 |
68cfc1db0d26
Add copyright and permissions notices.
Glenn Morris <rgm@gnu.org>
parents:
75382
diff
changeset
|
2 Free Software Foundation, Inc. |
68cfc1db0d26
Add copyright and permissions notices.
Glenn Morris <rgm@gnu.org>
parents:
75382
diff
changeset
|
3 Copying and distribution of this file, with or without modification, |
68cfc1db0d26
Add copyright and permissions notices.
Glenn Morris <rgm@gnu.org>
parents:
75382
diff
changeset
|
4 are permitted provided the copyright notice and this notice are preserved. |
68cfc1db0d26
Add copyright and permissions notices.
Glenn Morris <rgm@gnu.org>
parents:
75382
diff
changeset
|
5 |
68cfc1db0d26
Add copyright and permissions notices.
Glenn Morris <rgm@gnu.org>
parents:
75382
diff
changeset
|
6 |
75382
509f6ba78c65
Bump version to 22.0.93.
Chong Yidong <cyd@stupidchicken.com>
parents:
74759
diff
changeset
|
7 This directory tree holds version 22.0.93 of GNU Emacs, the extensible, |
25856 | 8 customizable, self-documenting real-time display editor. |
9 | |
74308
c3e14b761fe6
Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents:
74067
diff
changeset
|
10 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
|
11 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
|
12 entire Emacs file tree. |
25856 | 13 |
36122
e6572f8d3aa8
Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents:
36104
diff
changeset
|
14 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
|
15 user-visible changes in recent versions of Emacs. |
25856 | 16 |
17 The file etc/PROBLEMS contains information on many common problems that | |
18 occur in building, installing and running Emacs. | |
19 | |
74308
c3e14b761fe6
Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents:
74067
diff
changeset
|
20 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
|
21 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
|
22 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
|
23 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
|
24 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
|
25 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
|
26 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
|
27 |
c3e14b761fe6
Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents:
74067
diff
changeset
|
28 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
|
29 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
|
30 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
|
31 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
|
32 relating to GNU packages. |
25856 | 33 |
36792
f4f0878e1455
Minor changes from Kim Storm <storm@filanet.dk>.
Eli Zaretskii <eliz@gnu.org>
parents:
36541
diff
changeset
|
34 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
|
35 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
|
36 Emacs. |
25856 | 37 |
38 The file `configure' is a shell script to acclimate Emacs to the | |
39 oddities of your processor and operating system. It creates the file | |
40 `Makefile' (a script for the `make' program), which automates the | |
41 process of building and installing Emacs. See INSTALL for more | |
42 detailed information. | |
43 | |
44 The file `configure.in' is the input used by the autoconf program to | |
36268 | 45 construct the `configure' script. Since Emacs has some configuration |
46 requirements that autoconf can't meet directly, and for historical | |
47 reasons, `configure.in' uses an unholy marriage of custom-baked | |
48 configuration code and autoconf macros. If you want to rebuild | |
49 `configure' from `configure.in', you will need to install a recent | |
50 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
|
51 |
25856 | 52 The file `Makefile.in' is a template used by `configure' to create |
53 `Makefile'. | |
54 | |
55 The file `make-dist' is a shell script to build a distribution tar | |
56 file from the current Emacs tree, containing only those files | |
57 appropriate for distribution. If you make extensive changes to Emacs, | |
58 this script will help you distribute your version to others. | |
59 | |
60 There are several subdirectories: | |
61 | |
42214
515351759218
Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents:
41438
diff
changeset
|
62 `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
|
63 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
|
64 functions). |
515351759218
Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents:
41438
diff
changeset
|
65 `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
|
66 `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
|
67 auxiliary data files required to type international characters |
515351759218
Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents:
41438
diff
changeset
|
68 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
|
69 `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
|
70 with Emacs, like movemail and etags. |
515351759218
Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents:
41438
diff
changeset
|
71 `etc' holds miscellaneous architecture-independent data files |
515351759218
Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents:
41438
diff
changeset
|
72 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
|
73 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
|
74 `man', `lispref', and `lispintro' subdirectories are |
515351759218
Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents:
41438
diff
changeset
|
75 architecture-independent too. |
515351759218
Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents:
41438
diff
changeset
|
76 `info' holds the Info documentation tree for Emacs. |
515351759218
Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents:
41438
diff
changeset
|
77 `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
|
78 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
|
79 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
|
80 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
|
81 `lispref' holds the source code for the Emacs Lisp reference manual. |
41438 | 82 `lispintro' holds the source code for the Introduction to Programming |
83 in Emacs Lisp manual. | |
25856 | 84 |
42214
515351759218
Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents:
41438
diff
changeset
|
85 `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
|
86 `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
|
87 `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
|
88 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
|
89 `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
|
90 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
|
91 |
e6572f8d3aa8
Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents:
36104
diff
changeset
|
92 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
|
93 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
|
94 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
|
95 list the required tools. |