annotate doc/lispref/README @ 94533:4bc924044f22

Remove unneeded TODO item in comment.
author Eric S. Raymond <esr@snark.thyrsus.com>
date Fri, 02 May 2008 03:23:53 +0000
parents 107ccd98fa12
children fde6f792a832
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
87649
107ccd98fa12 Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 84045
diff changeset
1 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
84045
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2 Free Software Foundation, Inc.
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3 See the end of the file for license conditions.
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6 README for Edition 2.9 of the Emacs Lisp Reference Manual.
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8 * This directory contains the texinfo source files for the Reference
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9 Manual, make-permuted-index, and the latest version of texinfo.tex,
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10 which handles forms that cannot be handled by the older versions of
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11 texinfo.tex.
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13 * Report Lisp Manual bugs to bug-lisp-manual@gnu.org. We don't read
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14 these bug reports until it's time for a new edition. To report other
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15 Emacs bugs, use bug-gnu-emacs@gnu.org. To ask questions, use the
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16 newsgroup gnu.emacs.help.
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
18 * The Emacs Lisp Reference Manual is quite large. It totals around
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19 1100 pages in smallbook format; the info files total over
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20 2.5 megabytes.
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22 * You can format this manual either for Info or for printing hardcopy
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
23 using TeX.
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
24
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
25 * You can buy nicely printed copies from the Free Software Foundation.
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
26 For info, send mail to gnu@gnu.org or phone 617-542-5942. Buying a
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
27 manual from the Free Software Foundation helps support our GNU
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
28 development work.
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
29
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
30 ** This distribution contains a Makefile that you can use with GNU Make.
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
31 Otherwise, here are detailed instructions:
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
32
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
33 ** HARDCOPY: A copy of the version of `texinfo.tex' that formats this
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
34 manual is included in this distribution.
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
35
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
36 The master file for formatting this manual for Tex is called
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
37 `elisp.texi'. It contains @include commands to include all the
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
38 chapters that make up the manual. In addition, `elisp.texi' has
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
39 the title page in a new format designed by Karl Berry, using the
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
40 @titlespec command.
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
41
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
42 To create a DVI file with a sorted index, execute the following
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
43 commands in the shell:
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
44
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
45 % ./configure
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
46 % make index.texi
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
47 % make elisp.dvi
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
48
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
49 *** To create a DVI file with a permuted index, you may experiment
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
50 with `make-permuted-index'.
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
51
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
52 ** To make an Info file, you need to install Texinfo, then run
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
53 `./configure' and `make info'. To install the Info files, run
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
54 `make install'.
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
55
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
56
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
57 This file is part of GNU Emacs.
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
58
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
59 GNU Emacs is free software; you can redistribute it and/or modify
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
60 it under the terms of the GNU General Public License as published by
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
61 the Free Software Foundation; either version 3, or (at your option)
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
62 any later version.
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
63
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
64 GNU Emacs is distributed in the hope that it will be useful,
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
65 but WITHOUT ANY WARRANTY; without even the implied warranty of
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
66 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
67 GNU General Public License for more details.
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
68
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
69 You should have received a copy of the GNU General Public License
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
70 along with GNU Emacs; see the file COPYING. If not, write to the
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
71 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
bea529b2b197 Move here from ../../lispref
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
72 Boston, MA 02110-1301, USA.