annotate lisp/ediff/README @ 12:bcdc7deadc19 r19-15b7

Import from CVS: tag r19-15b7
author cvs
date Mon, 13 Aug 2007 08:48:16 +0200
parents 376386a54a3c
children 9ee227acff29
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
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3 **** This version of Ediff requires *at least* Emacs 19.30 or XEmacs 19.14
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
12
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents: 0
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
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15 ediff-wind.el -- Ediff Emacs Lisp code
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16 ediff-util.el -- Ediff Emacs Lisp code
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17 ediff-diff.el -- Ediff Emacs Lisp code
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18 ediff-merg.el -- Ediff Emacs Lisp code
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19 ediff-mult.el -- Ediff Emacs Lisp code
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20 ediff-vers.el -- Ediff Emacs Lisp code
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21 ediff-ptch.el -- Ediff Emacs Lisp code
12
bcdc7deadc19 Import from CVS: tag r19-15b7
cvs
parents: 0
diff changeset
22 ediff-tbar.el -- Ediff Emacs Lisp code -- this one only for XEmacs
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23 ediff-hook.el -- Ediff Emacs Lisp code
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 To install Ediff do:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 uncompress ediff.tar.Z
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 tar xf ediff.tar
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32 Then do the following:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34 1. To compile Lisp:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 make (or 'make all')
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 2. You can also type
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 make install
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42 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
43 into a suitable Lisp directory.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45 To make this happen, you will most likely have to change the PREFIX
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46 variable in Makefile and, possibly, one or more of these variables:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48 DATADIR, LISPDIR, INFODIR, ETCDIR, and VERSION
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50 if they don't point to the right directories in your installation.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51 You also need to have a write permission for all directories
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52 mentioned in LISPDIR, INFODIR, and ETCDIR.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54 3. XEmacs users must invoke `make' with the parameter EMACS=xemacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55 or whatever name is used to invoke XEmacs (some sites still use xemacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56 for Emacs 18). An even better thing would be to edit Makefile directly
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57 as indicated in the comments there.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59 For manual installation, copy ediff*.elc into a directory on your load-path.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61 For more details, read documentation at the beginning of the file ediff.el
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63 To install on-line documentation, you need to install the Info files
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64 by copying
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66 ediff.info*
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68 into your Info directory (which is emacs-root-dir/info,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
69 if emacs-root-dir is the root directory of the installation).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
70
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
71 Then edit the file
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
72
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
73 emacs-root-dir/info/dir
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
74
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
75 to include the root menu item for Ediff (check how other menu
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
76 items look like in this file).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
77
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
78 In Emacs, this item should look like this:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
79
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
80 * Ediff: (ediff.info). A Visual Interface to Unix Diff and Patch Utilities
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
81
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
82 In XEmacs, it looks like:
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
83
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
84 * Ediff:: A Visual Interface to Unix Diff and Patch Utilities
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
85
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
86
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
87 Normally, all Ediff menus and autoloads are already defined in Emacs, so u
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
88 don't need to define anything in your .emacs to run Ediff.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
89 However, if it was announced that this distribution of Ediff contains
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
90 new features, you may have to put
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
91
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
92 (require 'ediff-hook)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
93
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
94 in your .emacs to take advantage of these new features. This doesn't load
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
95 Ediff, but readies it for any taks u assign to it. When this version of
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
96 Ediff gets installed in the standard Emacs distribution, you may remove
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
97 the above require-statement (but leaving it in does no harm).