annotate lispref/README @ 4799:6af5540f4e4e

Doc fix.
author Jim Blandy <jimb@redhat.com>
date Tue, 28 Sep 1993 09:56:06 +0000
parents 4a40e0433bf9
children 1a0e90f4d0d6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4184
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1 README for Edition 2.0.1 of the Emacs Lisp Reference Manual.
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3 * This directory contains the texinfo source files for the Reference
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4 Manual, make-permuted-index, and the latest version of texinfo.tex,
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5 which handles forms that cannot be handled by the older versions of
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6 texinfo.tex. Also, it contains makeinfo.c.
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
7
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8 * The Emacs Lisp Reference Manual is turning out bigger than we
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 expected. It totals over 750 pages when printed on 8.5 by 11 inch
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10 paper and the info files total almost two megabytes.
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12 * You can format this manual either for Info or for printing hardcopy
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13 using TeX.
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15 ** This distribution contains a Makefile that you can use with GNU Make.
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 Otherwise, here are detailed instructions:
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 ** HARDCOPY: A copy of the version of `texinfo.tex' that formats this
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19 manual is included in this distribution.
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 The master file for formatting this manual for Tex is called
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22 `elisp.texi'. It contains @include commands to include all the
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23 chapters that make up the manual. In addition, `elisp.texi' has
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24 the title page in a new format designed by Karl Berry, using the
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25 @titlespec command.
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27 To create a DVI file with a sorted index, execute the following
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
28 commands in the shell:
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30 % make index.texi
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 % make elisp.dvi
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33 *** To create a DVI file with a permuted index, you may experiment
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34 with `make-permuted-index'.
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 ** INFO: A copy of makeinfo.c that will format this manual for Info is
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 included in this distribution. This program is written in C and can
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38 be used separately from Emacs. `makeinfo' produces much better error
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39 messages than the old `texinfo-format-buffer'. You can run `makeinfo'
4a40e0433bf9 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40 it on the `elisp.texi' file.