Mercurial > emacs
annotate README @ 105784:51992684b560
* emacs-lisp/checkdoc.el (checkdoc-proper-noun-region-engine): Use
help-xref-info-regexp and help-xref-url-regexp to identify links.
(Further to Bug#3921).
author | Kevin Ryde <user42@zip.com.au> |
---|---|
date | Tue, 27 Oct 2009 22:59:55 +0000 |
parents | ed6152fc596c |
children | 2400073344ef |
rev | line source |
---|---|
100959 | 1 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 |
75587
68cfc1db0d26
Add copyright and permissions notices.
Glenn Morris <rgm@gnu.org>
parents:
75382
diff
changeset
|
2 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 |
103502
ed6152fc596c
Bump version to 23.1.50.
Chong Yidong <cyd@stupidchicken.com>
parents:
103495
diff
changeset
|
6 This directory tree holds version 23.1.50 of GNU Emacs, the extensible, |
25856 | 7 customizable, self-documenting real-time display editor. |
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 | 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 | 15 |
16 The file etc/PROBLEMS contains information on many common problems that | |
17 occur in building, installing and running Emacs. | |
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 |
c3e14b761fe6
Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents:
74067
diff
changeset
|
22 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
|
23 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
|
24 Please send bug reports for pretest versions of Emacs, and versions |
97940
f0ed6bfc9789
Vin Shelton <acs at xemacs.org> (tiny change)
Glenn Morris <rgm@gnu.org>
parents:
97142
diff
changeset
|
25 from the Savannah.gnu.org repository, to emacs-pretest-bug@gnu.org. |
74308
c3e14b761fe6
Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents:
74067
diff
changeset
|
26 |
c3e14b761fe6
Clarify bug reporting. Delete VMS section.
Richard M. Stallman <rms@gnu.org>
parents:
74067
diff
changeset
|
27 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
|
28 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
|
29 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
|
30 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
|
31 relating to GNU packages. |
25856 | 32 |
36792
f4f0878e1455
Minor changes from Kim Storm <storm@filanet.dk>.
Eli Zaretskii <eliz@gnu.org>
parents:
36541
diff
changeset
|
33 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
|
34 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
|
35 Emacs. |
25856 | 36 |
37 The file `configure' is a shell script to acclimate Emacs to the | |
38 oddities of your processor and operating system. It creates the file | |
39 `Makefile' (a script for the `make' program), which automates the | |
40 process of building and installing Emacs. See INSTALL for more | |
41 detailed information. | |
42 | |
43 The file `configure.in' is the input used by the autoconf program to | |
36268 | 44 construct the `configure' script. Since Emacs has some configuration |
45 requirements that autoconf can't meet directly, and for historical | |
46 reasons, `configure.in' uses an unholy marriage of custom-baked | |
47 configuration code and autoconf macros. If you want to rebuild | |
48 `configure' from `configure.in', you will need to install a recent | |
49 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
|
50 |
25856 | 51 The file `Makefile.in' is a template used by `configure' to create |
52 `Makefile'. | |
53 | |
54 The file `make-dist' is a shell script to build a distribution tar | |
55 file from the current Emacs tree, containing only those files | |
56 appropriate for distribution. If you make extensive changes to Emacs, | |
57 this script will help you distribute your version to others. | |
58 | |
59 There are several subdirectories: | |
60 | |
42214
515351759218
Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents:
41438
diff
changeset
|
61 `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
|
62 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
|
63 functions). |
515351759218
Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents:
41438
diff
changeset
|
64 `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
|
65 `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
|
66 auxiliary data files required to type international characters |
515351759218
Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents:
41438
diff
changeset
|
67 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
|
68 `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
|
69 with Emacs, like movemail and etags. |
515351759218
Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents:
41438
diff
changeset
|
70 `etc' holds miscellaneous architecture-independent data files |
515351759218
Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents:
41438
diff
changeset
|
71 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
|
72 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
|
73 `man', `lispref', and `lispintro' subdirectories are |
515351759218
Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents:
41438
diff
changeset
|
74 architecture-independent too. |
515351759218
Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents:
41438
diff
changeset
|
75 `info' holds the Info documentation tree for Emacs. |
84412
acde5b207e40
Add doc/ to documentation directories.
Juri Linkov <juri@jurta.org>
parents:
83746
diff
changeset
|
76 `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
|
77 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
|
78 an updated manual. `makeinfo' is part of the GNU Texinfo |
78651 | 79 package; you need version 4.6 or later of Texinfo. |
84412
acde5b207e40
Add doc/ to documentation directories.
Juri Linkov <juri@jurta.org>
parents:
83746
diff
changeset
|
80 `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
|
81 `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
|
82 in Emacs Lisp manual. |
42214
515351759218
Add info about the `leim' directory
Eli Zaretskii <eliz@gnu.org>
parents:
41438
diff
changeset
|
83 `msdos' holds configuration files for compiling Emacs under MSDOG. |
98459 | 84 `nextstep' holds instructions and some other files for compiling the |
98512 | 85 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
|
86 `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
|
87 to building and running Emacs on Windows 9X/ME/NT/2000/XP. |
92341 | 88 `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
|
89 |
e6572f8d3aa8
Document that Texinfo 4.0 or later is required for producing the manual.
Eli Zaretskii <eliz@gnu.org>
parents:
36104
diff
changeset
|
90 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
|
91 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
|
92 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
|
93 list the required tools. |
75769
92a0e87ff562
Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents:
75587
diff
changeset
|
94 |
92a0e87ff562
Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents:
75587
diff
changeset
|
95 |
92a0e87ff562
Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents:
75587
diff
changeset
|
96 This file is part of GNU Emacs. |
92a0e87ff562
Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents:
75587
diff
changeset
|
97 |
94719
1a762a842f80
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
92795
diff
changeset
|
98 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
|
99 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
|
100 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
|
101 (at your option) any later version. |
75769
92a0e87ff562
Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents:
75587
diff
changeset
|
102 |
92a0e87ff562
Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents:
75587
diff
changeset
|
103 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
|
104 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
|
105 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
|
106 GNU General Public License for more details. |
92a0e87ff562
Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents:
75587
diff
changeset
|
107 |
92a0e87ff562
Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents:
75587
diff
changeset
|
108 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
|
109 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |