annotate lisp/ediff/README @ 171:929b76928fce r20-3b12

Import from CVS: tag r20-3b12
author cvs
date Mon, 13 Aug 2007 09:47:52 +0200
parents 6a378aca36af
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1 **** EDIFF -- a comprehensive interface to diff for Emacs 19 and XEmacs 19
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2
82
6a378aca36af Import from CVS: tag r20-0b91
cvs
parents: 80
diff changeset
3 **** This version of Ediff requires *at least* Emacs 19.34 or XEmacs 19.14
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5 This directory:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 README -- This file
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8 Makefile -- Automated installation file
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9 ediff.texi -- Manual in Texinfo format
78
c7528f8e288d Import from CVS: tag r20-0b34
cvs
parents: 70
diff changeset
10 ediff, ediff-? -- The Info files
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11 ediff.dvi -- Manual in DVI format
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 ediff.el -- Ediff Emacs Lisp code
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 ediff-init.el -- Ediff Emacs Lisp code
80
1ce6082ce73f Import from CVS: tag r20-0b90
cvs
parents: 78
diff changeset
15 ediff-help.el -- Ediff Emacs Lisp code
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16 ediff-wind.el -- Ediff Emacs Lisp code
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17 ediff-util.el -- Ediff Emacs Lisp code
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18 ediff-diff.el -- Ediff Emacs Lisp code
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19 ediff-merg.el -- Ediff Emacs Lisp code
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20 ediff-mult.el -- Ediff Emacs Lisp code
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21 ediff-vers.el -- Ediff Emacs Lisp code
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22 ediff-ptch.el -- Ediff Emacs Lisp code
82
6a378aca36af Import from CVS: tag r20-0b91
cvs
parents: 80
diff changeset
23 ediff-tbar.el -- Ediff Emacs Lisp code -- for XEmacs only
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24 ediff-hook.el -- Ediff Emacs Lisp code
82
6a378aca36af Import from CVS: tag r20-0b91
cvs
parents: 80
diff changeset
25 toolbar/ -- Ediff toolbar icons -- for XEmacs only
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 To install Ediff do:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 uncompress ediff.tar.Z
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31 tar xf ediff.tar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34 Then do the following:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 1. To compile Lisp:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 make (or 'make all')
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 2. You can also type
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42 make install
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44 to do what "make all" does plus it will copy the files ediff*.elc
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45 into a suitable Lisp directory.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47 To make this happen, you will most likely have to change the PREFIX
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48 variable in Makefile and, possibly, one or more of these variables:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50 DATADIR, LISPDIR, INFODIR, ETCDIR, and VERSION
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52 if they don't point to the right directories in your installation.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53 You also need to have a write permission for all directories
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54 mentioned in LISPDIR, INFODIR, and ETCDIR.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56 3. XEmacs users must invoke `make' with the parameter EMACS=xemacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57 or whatever name is used to invoke XEmacs (some sites still use xemacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58 for Emacs 18). An even better thing would be to edit Makefile directly
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59 as indicated in the comments there.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60
82
6a378aca36af Import from CVS: tag r20-0b91
cvs
parents: 80
diff changeset
61 4. Under XEmacs, copy the icons in the `toolbar' directory into
6a378aca36af Import from CVS: tag r20-0b91
cvs
parents: 80
diff changeset
62 the-directory-where-xemacs-installed/etc/toolbar/
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63
82
6a378aca36af Import from CVS: tag r20-0b91
cvs
parents: 80
diff changeset
64 Normally, all Ediff menus and autoloads are already defined in Emacs, so you
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65 don't need to define anything in your .emacs to run Ediff.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66 However, if it was announced that this distribution of Ediff contains
82
6a378aca36af Import from CVS: tag r20-0b91
cvs
parents: 80
diff changeset
67 new features, you may need to put
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
69 (require 'ediff-hook)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
70
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
71 in your .emacs to take advantage of these new features. This doesn't load
82
6a378aca36af Import from CVS: tag r20-0b91
cvs
parents: 80
diff changeset
72 Ediff, but readies Emacs for the things to come. When this version of
6a378aca36af Import from CVS: tag r20-0b91
cvs
parents: 80
diff changeset
73 Ediff gets installed in the standard Emacs distribution, you can remove
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
74 the above require-statement (but leaving it in does no harm).