annotate man/ediff.texi @ 79214:3b63a434eea0

*** empty log message ***
author Jason Rumney <jasonr@gnu.org>
date Wed, 24 Oct 2007 13:57:45 +0000
parents c056e53b30f8
children 02b9a9aa5b0c e6fdae9180d4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1 \input texinfo @c -*-texinfo-*-
Dave Love <fx@gnu.org>
parents:
diff changeset
2 @c documentation for Ediff
Dave Love <fx@gnu.org>
parents:
diff changeset
3 @c Written by Michael Kifer
Dave Love <fx@gnu.org>
parents:
diff changeset
4
Dave Love <fx@gnu.org>
parents:
diff changeset
5 @comment %**start of header (This is for running Texinfo on a region.)
Dave Love <fx@gnu.org>
parents:
diff changeset
6
Dave Love <fx@gnu.org>
parents:
diff changeset
7 @comment Using ediff.info instead of ediff in setfilename breaks DOS.
Dave Love <fx@gnu.org>
parents:
diff changeset
8 @comment @setfilename ediff
Dave Love <fx@gnu.org>
parents:
diff changeset
9 @comment @setfilename ediff.info
Dave Love <fx@gnu.org>
parents:
diff changeset
10 @setfilename ../info/ediff
Dave Love <fx@gnu.org>
parents:
diff changeset
11
Dave Love <fx@gnu.org>
parents:
diff changeset
12 @settitle Ediff User's Manual
Dave Love <fx@gnu.org>
parents:
diff changeset
13 @synindex vr cp
Dave Love <fx@gnu.org>
parents:
diff changeset
14 @synindex fn cp
Dave Love <fx@gnu.org>
parents:
diff changeset
15 @synindex pg cp
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
16 @synindex ky cp
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
17
Dave Love <fx@gnu.org>
parents:
diff changeset
18 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
19 @finalout
Dave Love <fx@gnu.org>
parents:
diff changeset
20 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
21 @c @smallbook
Dave Love <fx@gnu.org>
parents:
diff changeset
22 @comment %**end of header (This is for running Texinfo on a region.)
Dave Love <fx@gnu.org>
parents:
diff changeset
23
47737
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
24 @copying
42288
3ce98f3e0608 2001-12-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 38865
diff changeset
25 This file documents Ediff, a comprehensive visual interface to Unix diff
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
26 and patch utilities.
Dave Love <fx@gnu.org>
parents:
diff changeset
27
64890
3723093a21fd Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 63676
diff changeset
28 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
75348
3d45362f1d38 Add 2007 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 71383
diff changeset
29 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
30
47737
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
31 @quotation
37404
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 36381
diff changeset
32 Permission is granted to copy, distribute and/or modify this document
65555
69b3598a61c5 Update all manuals to specify GFDL version 1.2.
Romain Francoise <romain@orebokech.com>
parents: 64890
diff changeset
33 under the terms of the GNU Free Documentation License, Version 1.2 or
37404
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 36381
diff changeset
34 any later version published by the Free Software Foundation; with no
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 36381
diff changeset
35 Invariant Sections, with the Front-Cover texts being ``A GNU
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 36381
diff changeset
36 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 36381
diff changeset
37 license is included in the section entitled ``GNU Free Documentation
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 36381
diff changeset
38 License'' in the Emacs manual.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
39
37404
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 36381
diff changeset
40 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 36381
diff changeset
41 this GNU Manual, like GNU software. Copies published by the Free
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 36381
diff changeset
42 Software Foundation raise funds for GNU development.''
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 36381
diff changeset
43
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 36381
diff changeset
44 This document is part of a collection distributed under the GNU Free
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 36381
diff changeset
45 Documentation License. If you want to distribute this document
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 36381
diff changeset
46 separately from the collection, you can do so by adding a copy of the
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 36381
diff changeset
47 license to the document, as described in section 6 of the license.
47737
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
48 @end quotation
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
49 @end copying
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
50
47737
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
51 @dircategory Emacs
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
52 @direntry
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
53 * Ediff: (ediff). A visual interface for comparing and merging programs.
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
54 @end direntry
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
55
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
56 @titlepage
Dave Love <fx@gnu.org>
parents:
diff changeset
57 @title Ediff User's Manual
Dave Love <fx@gnu.org>
parents:
diff changeset
58 @sp 4
77242
c056e53b30f8 Update ediff version and date.
Chong Yidong <cyd@stupidchicken.com>
parents: 77235
diff changeset
59 @subtitle Ediff version 2.81.1
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
60 @sp 1
77242
c056e53b30f8 Update ediff version and date.
Chong Yidong <cyd@stupidchicken.com>
parents: 77235
diff changeset
61 @subtitle April 2007
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
62 @sp 5
Dave Love <fx@gnu.org>
parents:
diff changeset
63 @author Michael Kifer
Dave Love <fx@gnu.org>
parents:
diff changeset
64 @page
Dave Love <fx@gnu.org>
parents:
diff changeset
65
Dave Love <fx@gnu.org>
parents:
diff changeset
66 @vskip 0pt plus 1filll
47737
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
67 @insertcopying
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
68 @end titlepage
37404
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 36381
diff changeset
69
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
70
Dave Love <fx@gnu.org>
parents:
diff changeset
71 @node Top, Introduction, (dir), (dir)
Dave Love <fx@gnu.org>
parents:
diff changeset
72
Dave Love <fx@gnu.org>
parents:
diff changeset
73
Dave Love <fx@gnu.org>
parents:
diff changeset
74 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
75 * Introduction:: About Ediff.
Dave Love <fx@gnu.org>
parents:
diff changeset
76 * Major Entry Points:: How to use Ediff.
Dave Love <fx@gnu.org>
parents:
diff changeset
77 * Session Commands:: Ediff commands used within a session.
Dave Love <fx@gnu.org>
parents:
diff changeset
78 * Registry of Ediff Sessions:: Keeping track of multiple Ediff sessions.
Dave Love <fx@gnu.org>
parents:
diff changeset
79 * Session Groups:: Comparing and merging directories.
Dave Love <fx@gnu.org>
parents:
diff changeset
80 * Remote and Compressed Files:: You may want to know about this.
Dave Love <fx@gnu.org>
parents:
diff changeset
81 * Customization:: How to make Ediff work the way YOU want.
Dave Love <fx@gnu.org>
parents:
diff changeset
82 * Credits:: Thanks to those who helped.
77235
88224dc74061 Include GFDL.
Chong Yidong <cyd@stupidchicken.com>
parents: 75348
diff changeset
83 * GNU Free Documentation License:: The license for this documentation.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
84 * Index::
Dave Love <fx@gnu.org>
parents:
diff changeset
85 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
86
Dave Love <fx@gnu.org>
parents:
diff changeset
87 @node Introduction, Major Entry Points, Top, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
88 @chapter Introduction
Dave Love <fx@gnu.org>
parents:
diff changeset
89
Dave Love <fx@gnu.org>
parents:
diff changeset
90 @cindex Comparing files and buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
91 @cindex Merging files and buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
92 @cindex Patching files and buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
93 @cindex Finding differences
Dave Love <fx@gnu.org>
parents:
diff changeset
94
Dave Love <fx@gnu.org>
parents:
diff changeset
95 Ediff provides a convenient way for simultaneous browsing through
Dave Love <fx@gnu.org>
parents:
diff changeset
96 the differences between a pair (or a triple) of files or buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
97 (which are called @samp{variants} for our purposes). The
Dave Love <fx@gnu.org>
parents:
diff changeset
98 files being compared, file-A, file-B, and file-C (if applicable) are
Dave Love <fx@gnu.org>
parents:
diff changeset
99 shown in separate windows (side by side, one above the another, or in
Dave Love <fx@gnu.org>
parents:
diff changeset
100 separate frames), and the differences are highlighted as you step
Dave Love <fx@gnu.org>
parents:
diff changeset
101 through them. You can also copy difference regions from one buffer to
Dave Love <fx@gnu.org>
parents:
diff changeset
102 another (and recover old differences if you change your mind).
Dave Love <fx@gnu.org>
parents:
diff changeset
103
Dave Love <fx@gnu.org>
parents:
diff changeset
104 Another powerful feature is the ability to merge a pair of files into a
Dave Love <fx@gnu.org>
parents:
diff changeset
105 third buffer. Merging with an ancestor file is also supported.
Dave Love <fx@gnu.org>
parents:
diff changeset
106 Furthermore, Ediff is equipped with directory-level capabilities that
Dave Love <fx@gnu.org>
parents:
diff changeset
107 allow the user to conveniently launch browsing or merging sessions on
Dave Love <fx@gnu.org>
parents:
diff changeset
108 groups of files in two (or three) different directories.
Dave Love <fx@gnu.org>
parents:
diff changeset
109
42288
3ce98f3e0608 2001-12-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 38865
diff changeset
110 In addition, Ediff can apply a patch to a file and then let you step through
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
111 both files, the patched and the original one, simultaneously,
Dave Love <fx@gnu.org>
parents:
diff changeset
112 difference-by-difference. You can even apply a patch right out of a mail
Dave Love <fx@gnu.org>
parents:
diff changeset
113 buffer, i.e., patches received by mail don't even have to be saved. Since
Dave Love <fx@gnu.org>
parents:
diff changeset
114 Ediff lets you copy differences between variants, you can, in effect, apply
Dave Love <fx@gnu.org>
parents:
diff changeset
115 patches selectively (i.e., you can copy a difference region from
Dave Love <fx@gnu.org>
parents:
diff changeset
116 @file{file.orig} to @file{file}, thereby undoing any particular patch that
Dave Love <fx@gnu.org>
parents:
diff changeset
117 you don't like).
Dave Love <fx@gnu.org>
parents:
diff changeset
118
Dave Love <fx@gnu.org>
parents:
diff changeset
119 Ediff even understands multi-file patches and can apply them interactively!
Dave Love <fx@gnu.org>
parents:
diff changeset
120 (Ediff can recognize multi-file patches only if they are in the context
Dave Love <fx@gnu.org>
parents:
diff changeset
121 format or GNU unified format. All other patches are treated as 1-file
33021
9fd41b036b84 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 33019
diff changeset
122 patches. Ediff is [hopefully] using the same algorithm as @code{patch} to
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
123 determine which files need to be patched.)
Dave Love <fx@gnu.org>
parents:
diff changeset
124
Dave Love <fx@gnu.org>
parents:
diff changeset
125 Ediff is aware of version control, which lets you compare
Dave Love <fx@gnu.org>
parents:
diff changeset
126 files with their older versions. Ediff also works with remote and
Dave Love <fx@gnu.org>
parents:
diff changeset
127 compressed files, automatically ftp'ing them over and uncompressing them.
Dave Love <fx@gnu.org>
parents:
diff changeset
128 @xref{Remote and Compressed Files}, for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
129
Dave Love <fx@gnu.org>
parents:
diff changeset
130 This package builds upon ideas borrowed from Emerge, and several of Ediff's
Dave Love <fx@gnu.org>
parents:
diff changeset
131 functions are adaptations from Emerge. Although Ediff subsumes and greatly
Dave Love <fx@gnu.org>
parents:
diff changeset
132 extends Emerge, much of the functionality in Ediff is influenced by Emerge.
Dave Love <fx@gnu.org>
parents:
diff changeset
133 The architecture and the interface are, of course, drastically different.
Dave Love <fx@gnu.org>
parents:
diff changeset
134
Dave Love <fx@gnu.org>
parents:
diff changeset
135 @node Major Entry Points, Session Commands, Introduction, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
136 @chapter Major Entry Points
Dave Love <fx@gnu.org>
parents:
diff changeset
137
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
138 When Ediff starts up, it displays a small control window, which accepts the
71118
fde97bba5e37 Fix typos.
Eli Zaretskii <eliz@gnu.org>
parents: 69681
diff changeset
139 Ediff commands, and two or three windows displaying the files to be compared
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
140 or merged. The control window can be in its own small frame or it can be
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
141 part of a bigger frame that displays other buffers. In any case, it is
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
142 important that the control window be active (i.e., be the one receiving the
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
143 keystrokes) when you use Ediff. You can switch to other Emacs buffers at
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
144 will and even edit the files currently being compared with Ediff and then
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
145 switch back to Ediff at any time by activating the appropriate Emacs windows.
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
146
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
147 Ediff can be invoked interactively using the following functions, which can
Dave Love <fx@gnu.org>
parents:
diff changeset
148 be run either from the minibuffer or from the menu bar. In the menu bar,
Dave Love <fx@gnu.org>
parents:
diff changeset
149 all Ediff's entry points belong to three submenus of the Tools menu:
Dave Love <fx@gnu.org>
parents:
diff changeset
150 Compare, Merge, and Apply Patch.
Dave Love <fx@gnu.org>
parents:
diff changeset
151
Dave Love <fx@gnu.org>
parents:
diff changeset
152 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
153 @item ediff-files
Dave Love <fx@gnu.org>
parents:
diff changeset
154 @itemx ediff
Dave Love <fx@gnu.org>
parents:
diff changeset
155 @findex ediff-files
Dave Love <fx@gnu.org>
parents:
diff changeset
156 @findex ediff
Dave Love <fx@gnu.org>
parents:
diff changeset
157 Compare two files.
Dave Love <fx@gnu.org>
parents:
diff changeset
158
62356
25867a9e5444 added documentation for ediff-backup
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 60151
diff changeset
159 @item ediff-backup
25867a9e5444 added documentation for ediff-backup
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 60151
diff changeset
160 @findex ediff-backup
25867a9e5444 added documentation for ediff-backup
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 60151
diff changeset
161 Compare a file with its backup. If there are several numerical backups, use
25867a9e5444 added documentation for ediff-backup
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 60151
diff changeset
162 the latest. If the file is itself a backup, then compare it with its
25867a9e5444 added documentation for ediff-backup
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 60151
diff changeset
163 original.
25867a9e5444 added documentation for ediff-backup
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 60151
diff changeset
164
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
165 @item ediff-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
166 @findex ediff-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
167 Compare two buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
168
Dave Love <fx@gnu.org>
parents:
diff changeset
169 @item ediff-files3
Dave Love <fx@gnu.org>
parents:
diff changeset
170 @itemx ediff3
Dave Love <fx@gnu.org>
parents:
diff changeset
171 @findex ediff-files3
Dave Love <fx@gnu.org>
parents:
diff changeset
172 @findex ediff3
Dave Love <fx@gnu.org>
parents:
diff changeset
173 Compare three files.
Dave Love <fx@gnu.org>
parents:
diff changeset
174
Dave Love <fx@gnu.org>
parents:
diff changeset
175 @item ediff-buffers3
Dave Love <fx@gnu.org>
parents:
diff changeset
176 @findex ediff-buffers3
Dave Love <fx@gnu.org>
parents:
diff changeset
177 Compare three buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
178
Dave Love <fx@gnu.org>
parents:
diff changeset
179 @item edirs
Dave Love <fx@gnu.org>
parents:
diff changeset
180 @itemx ediff-directories
Dave Love <fx@gnu.org>
parents:
diff changeset
181 @findex edirs
Dave Love <fx@gnu.org>
parents:
diff changeset
182 @findex ediff-directories
Dave Love <fx@gnu.org>
parents:
diff changeset
183 Compare files common to two directories.
Dave Love <fx@gnu.org>
parents:
diff changeset
184 @item edirs3
Dave Love <fx@gnu.org>
parents:
diff changeset
185 @itemx ediff-directories3
Dave Love <fx@gnu.org>
parents:
diff changeset
186 @findex edirs3
Dave Love <fx@gnu.org>
parents:
diff changeset
187 @findex ediff-directories3
Dave Love <fx@gnu.org>
parents:
diff changeset
188 Compare files common to three directories.
Dave Love <fx@gnu.org>
parents:
diff changeset
189 @item edir-revisions
Dave Love <fx@gnu.org>
parents:
diff changeset
190 @itemx ediff-directory-revisions
Dave Love <fx@gnu.org>
parents:
diff changeset
191 @findex ediff-directory-revisions
Dave Love <fx@gnu.org>
parents:
diff changeset
192 @findex edir-revisions
Dave Love <fx@gnu.org>
parents:
diff changeset
193 Compare versions of files in a given directory. Ediff selects only the
Dave Love <fx@gnu.org>
parents:
diff changeset
194 files that are under version control.
Dave Love <fx@gnu.org>
parents:
diff changeset
195 @item edir-merge-revisions
Dave Love <fx@gnu.org>
parents:
diff changeset
196 @itemx ediff-merge-directory-revisions
Dave Love <fx@gnu.org>
parents:
diff changeset
197 @findex edir-merge-revisions
Dave Love <fx@gnu.org>
parents:
diff changeset
198 @findex ediff-merge-directory-revisions
Dave Love <fx@gnu.org>
parents:
diff changeset
199 Merge versions of files in a given directory. Ediff selects only the
Dave Love <fx@gnu.org>
parents:
diff changeset
200 files that are under version control.
Dave Love <fx@gnu.org>
parents:
diff changeset
201 @item edir-merge-revisions-with-ancestor
Dave Love <fx@gnu.org>
parents:
diff changeset
202 @itemx ediff-merge-directory-revisions-with-ancestor
Dave Love <fx@gnu.org>
parents:
diff changeset
203 @findex edir-merge-revisions-with-ancestor
Dave Love <fx@gnu.org>
parents:
diff changeset
204 @findex ediff-merge-directory-revisions-with-ancestor
Dave Love <fx@gnu.org>
parents:
diff changeset
205 Merge versions of files in a given directory using other versions as
Dave Love <fx@gnu.org>
parents:
diff changeset
206 ancestors. Ediff selects only the files that are under version control.
Dave Love <fx@gnu.org>
parents:
diff changeset
207
Dave Love <fx@gnu.org>
parents:
diff changeset
208 @item ediff-windows-wordwise
Dave Love <fx@gnu.org>
parents:
diff changeset
209 @findex ediff-windows-wordwise
Dave Love <fx@gnu.org>
parents:
diff changeset
210 Compare windows word-by-word.
Dave Love <fx@gnu.org>
parents:
diff changeset
211
Dave Love <fx@gnu.org>
parents:
diff changeset
212 @item ediff-windows-linewise
Dave Love <fx@gnu.org>
parents:
diff changeset
213 @findex ediff-windows-linewise
Dave Love <fx@gnu.org>
parents:
diff changeset
214 Compare windows line-by-line.
Dave Love <fx@gnu.org>
parents:
diff changeset
215
Dave Love <fx@gnu.org>
parents:
diff changeset
216 @item ediff-regions-wordwise
Dave Love <fx@gnu.org>
parents:
diff changeset
217 @findex ediff-regions-wordwise
42602
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
218 Compare regions word-by-word. The regions can come from the same buffer
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
219 and they can even overlap. You will be asked to specify the buffers that
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
220 contain the regions, which you want to compare. For each buffer, you will
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
221 also be asked to mark the regions to be compared. Pay attention to the
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
222 messages that appear in the minibuffer.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
223
Dave Love <fx@gnu.org>
parents:
diff changeset
224 @item ediff-regions-linewise
Dave Love <fx@gnu.org>
parents:
diff changeset
225 @findex ediff-regions-linewise
42602
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
226 Similar to @code{ediff-windows-linewise}, but compares the regions
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
227 line-by-line. See @code{ediff-windows-linewise} for more details.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
228
Dave Love <fx@gnu.org>
parents:
diff changeset
229 @item ediff-revision
Dave Love <fx@gnu.org>
parents:
diff changeset
230 @findex ediff-revision
Dave Love <fx@gnu.org>
parents:
diff changeset
231 Compare versions of the current buffer, if the buffer is visiting
Dave Love <fx@gnu.org>
parents:
diff changeset
232 a file under version control.
Dave Love <fx@gnu.org>
parents:
diff changeset
233
Dave Love <fx@gnu.org>
parents:
diff changeset
234 @item ediff-patch-file
Dave Love <fx@gnu.org>
parents:
diff changeset
235 @itemx epatch
Dave Love <fx@gnu.org>
parents:
diff changeset
236 @findex ediff-patch-file
Dave Love <fx@gnu.org>
parents:
diff changeset
237 @findex epatch
Dave Love <fx@gnu.org>
parents:
diff changeset
238
Dave Love <fx@gnu.org>
parents:
diff changeset
239 Patch a file or multiple files, then compare. If the patch applies to just
Dave Love <fx@gnu.org>
parents:
diff changeset
240 one file, Ediff will invoke a regular comparison session. If it is a
Dave Love <fx@gnu.org>
parents:
diff changeset
241 multi-file patch, then a session group interface will be used and the user
Dave Love <fx@gnu.org>
parents:
diff changeset
242 will be able to patch the files selectively. @xref{Session Groups}, for
Dave Love <fx@gnu.org>
parents:
diff changeset
243 more details.
Dave Love <fx@gnu.org>
parents:
diff changeset
244
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
245 Since the patch might be in a buffer or a file, you will be asked which is
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
246 the case. To avoid this extra prompt, you can invoke this command with a
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
247 prefix argument. With an odd prefix argument, Ediff assumes the patch
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
248 is in a file; with an even argument, a buffer is assumed.
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
249
33021
9fd41b036b84 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 33019
diff changeset
250 Note that @code{ediff-patch-file} will actually use the @code{patch}
36331
8132338647ad (Major Entry Points): Remove doubled `the'.
Gerd Moellmann <gerd@gnu.org>
parents: 36043
diff changeset
251 utility to change the original files on disk. This is not that
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
252 dangerous, since you will always have the original contents of the file
Dave Love <fx@gnu.org>
parents:
diff changeset
253 saved in another file that has the extension @file{.orig}.
Dave Love <fx@gnu.org>
parents:
diff changeset
254 Furthermore, if the file is under version control, then you can always back
46918
82d113655734 Minor spelling and grammar corrections.
Paul Eggert <eggert@twinsun.com>
parents: 44615
diff changeset
255 out to one of the previous versions (see the section on Version Control in
82d113655734 Minor spelling and grammar corrections.
Paul Eggert <eggert@twinsun.com>
parents: 44615
diff changeset
256 the Emacs manual).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
257
Dave Love <fx@gnu.org>
parents:
diff changeset
258 @code{ediff-patch-file} is careful about versions control: if the file
Dave Love <fx@gnu.org>
parents:
diff changeset
259 to be patched is checked in, then Ediff will offer to check it out, because
Dave Love <fx@gnu.org>
parents:
diff changeset
260 failing to do so may result in the loss of the changes when the file is
Dave Love <fx@gnu.org>
parents:
diff changeset
261 checked out the next time.
Dave Love <fx@gnu.org>
parents:
diff changeset
262
Dave Love <fx@gnu.org>
parents:
diff changeset
263 If you don't intend to modify the file via the patch and just want to see
Dave Love <fx@gnu.org>
parents:
diff changeset
264 what the patch is all about (and decide later), then
Dave Love <fx@gnu.org>
parents:
diff changeset
265 @code{ediff-patch-buffer} might be a better choice.
Dave Love <fx@gnu.org>
parents:
diff changeset
266
Dave Love <fx@gnu.org>
parents:
diff changeset
267 @item ediff-patch-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
268 @itemx epatch-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
269 @findex ediff-patch-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
270 @findex epatch-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
271 Patch a buffer, then compare. The buffer being patched and the file visited
Dave Love <fx@gnu.org>
parents:
diff changeset
272 by that buffer (if any) is @emph{not} modified. The result of the patch
Dave Love <fx@gnu.org>
parents:
diff changeset
273 appears in some other buffer that has the name ending with @emph{_patched}.
Dave Love <fx@gnu.org>
parents:
diff changeset
274
Dave Love <fx@gnu.org>
parents:
diff changeset
275 This function would refuse to apply a multifile patch to a buffer. Use
Dave Love <fx@gnu.org>
parents:
diff changeset
276 @code{ediff-patch-file} for that (and when you want the original file to be
33021
9fd41b036b84 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 33019
diff changeset
277 modified by the @code{patch} utility).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
278
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
279 Since the patch might be in a buffer or a file, you will be asked which is
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
280 the case. To avoid this extra prompt, you can invoke this command with a
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
281 prefix argument. With an odd prefix argument, Ediff assumes the patch
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
282 is in a file; with an even argument, a buffer is assumed.
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
283
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
284 @item ediff-merge-files
Dave Love <fx@gnu.org>
parents:
diff changeset
285 @itemx ediff-merge
Dave Love <fx@gnu.org>
parents:
diff changeset
286 @findex ediff-merge-files
Dave Love <fx@gnu.org>
parents:
diff changeset
287 @findex ediff-merge
Dave Love <fx@gnu.org>
parents:
diff changeset
288 Merge two files.
Dave Love <fx@gnu.org>
parents:
diff changeset
289
Dave Love <fx@gnu.org>
parents:
diff changeset
290 @item ediff-merge-files-with-ancestor
Dave Love <fx@gnu.org>
parents:
diff changeset
291 @itemx ediff-merge-with-ancestor
Dave Love <fx@gnu.org>
parents:
diff changeset
292 @findex ediff-merge-files-with-ancestor
Dave Love <fx@gnu.org>
parents:
diff changeset
293 @findex ediff-merge-with-ancestor
Dave Love <fx@gnu.org>
parents:
diff changeset
294 Like @code{ediff-merge}, but with a third ancestor file.
Dave Love <fx@gnu.org>
parents:
diff changeset
295
Dave Love <fx@gnu.org>
parents:
diff changeset
296 @item ediff-merge-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
297 @findex ediff-merge-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
298 Merge two buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
299
Dave Love <fx@gnu.org>
parents:
diff changeset
300 @item ediff-merge-buffers-with-ancestor
Dave Love <fx@gnu.org>
parents:
diff changeset
301 @findex ediff-merge-buffers-with-ancestor
Dave Love <fx@gnu.org>
parents:
diff changeset
302 Same but with ancestor.
Dave Love <fx@gnu.org>
parents:
diff changeset
303
Dave Love <fx@gnu.org>
parents:
diff changeset
304
Dave Love <fx@gnu.org>
parents:
diff changeset
305 @item edirs-merge
Dave Love <fx@gnu.org>
parents:
diff changeset
306 @itemx ediff-merge-directories
Dave Love <fx@gnu.org>
parents:
diff changeset
307 @findex edirs-merge
Dave Love <fx@gnu.org>
parents:
diff changeset
308 @findex ediff-merge-directories
Dave Love <fx@gnu.org>
parents:
diff changeset
309 Merge files common to two directories.
Dave Love <fx@gnu.org>
parents:
diff changeset
310 @item edirs-merge-with-ancestor
Dave Love <fx@gnu.org>
parents:
diff changeset
311 @itemx ediff-merge-directories-with-ancestor
Dave Love <fx@gnu.org>
parents:
diff changeset
312 @findex edirs-merge-with-ancestor
Dave Love <fx@gnu.org>
parents:
diff changeset
313 @findex ediff-merge-directories-with-ancestor
Dave Love <fx@gnu.org>
parents:
diff changeset
314 Same but using files in a third directory as ancestors.
Dave Love <fx@gnu.org>
parents:
diff changeset
315 If a pair of files doesn't have an ancestor in the ancestor-directory, you
Dave Love <fx@gnu.org>
parents:
diff changeset
316 will still be able to merge them without the ancestor.
Dave Love <fx@gnu.org>
parents:
diff changeset
317
Dave Love <fx@gnu.org>
parents:
diff changeset
318 @item ediff-merge-revisions
Dave Love <fx@gnu.org>
parents:
diff changeset
319 @findex ediff-merge-revisions
Dave Love <fx@gnu.org>
parents:
diff changeset
320 Merge two versions of the file visited by the current buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
321
Dave Love <fx@gnu.org>
parents:
diff changeset
322 @item ediff-merge-revisions-with-ancestor
Dave Love <fx@gnu.org>
parents:
diff changeset
323 @findex ediff-merge-revisions-with-ancestor
Dave Love <fx@gnu.org>
parents:
diff changeset
324 Same but with ancestor.
Dave Love <fx@gnu.org>
parents:
diff changeset
325
Dave Love <fx@gnu.org>
parents:
diff changeset
326 @item ediff-documentation
Dave Love <fx@gnu.org>
parents:
diff changeset
327 @findex ediff-documentation
Dave Love <fx@gnu.org>
parents:
diff changeset
328 Brings up this manual.
Dave Love <fx@gnu.org>
parents:
diff changeset
329
Dave Love <fx@gnu.org>
parents:
diff changeset
330 @item ediff-show-registry
Dave Love <fx@gnu.org>
parents:
diff changeset
331 @itemx eregistry
Dave Love <fx@gnu.org>
parents:
diff changeset
332 Brings up Ediff session registry. This feature enables you to quickly find
Dave Love <fx@gnu.org>
parents:
diff changeset
333 and restart active Ediff sessions.
Dave Love <fx@gnu.org>
parents:
diff changeset
334 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
335
Dave Love <fx@gnu.org>
parents:
diff changeset
336 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
337 If you want Ediff to be loaded from the very beginning of your Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
338 session, you should put this line in your @file{~/.emacs} file:
Dave Love <fx@gnu.org>
parents:
diff changeset
339
Dave Love <fx@gnu.org>
parents:
diff changeset
340 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
341 (require 'ediff)
Dave Love <fx@gnu.org>
parents:
diff changeset
342 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
343
Dave Love <fx@gnu.org>
parents:
diff changeset
344 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
345 Otherwise, Ediff will be loaded automatically when you use one of the
Dave Love <fx@gnu.org>
parents:
diff changeset
346 above functions, either directly or through the menus.
Dave Love <fx@gnu.org>
parents:
diff changeset
347
Dave Love <fx@gnu.org>
parents:
diff changeset
348 When the above functions are invoked, the user is prompted for all the
Dave Love <fx@gnu.org>
parents:
diff changeset
349 necessary information---typically the files or buffers to compare, merge, or
Dave Love <fx@gnu.org>
parents:
diff changeset
350 patch. Ediff tries to be smart about these prompts. For instance, in
Dave Love <fx@gnu.org>
parents:
diff changeset
351 comparing/merging files, it will offer the visible buffers as defaults. In
Dave Love <fx@gnu.org>
parents:
diff changeset
352 prompting for files, if the user enters a directory, the previously input
Dave Love <fx@gnu.org>
parents:
diff changeset
353 file name will be appended to that directory. In addition, if the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
354 @code{ediff-use-last-dir} is not @code{nil}, Ediff will offer
Dave Love <fx@gnu.org>
parents:
diff changeset
355 previously entered directories as defaults (which will be maintained
Dave Love <fx@gnu.org>
parents:
diff changeset
356 separately for each type of file, A, B, or C).
Dave Love <fx@gnu.org>
parents:
diff changeset
357 @vindex @code{ediff-use-last-dir}
Dave Love <fx@gnu.org>
parents:
diff changeset
358
Dave Love <fx@gnu.org>
parents:
diff changeset
359 All the above functions use the POSIX @code{diff} or @code{diff3} programs
Dave Love <fx@gnu.org>
parents:
diff changeset
360 to find differences between two files. They process the @code{diff} output
Dave Love <fx@gnu.org>
parents:
diff changeset
361 and display it in a convenient form. At present, Ediff understands only
Dave Love <fx@gnu.org>
parents:
diff changeset
362 the plain output from diff. Options such as @samp{-c} are not supported,
Dave Love <fx@gnu.org>
parents:
diff changeset
363 nor is the format produced by incompatible file comparison programs such as
Dave Love <fx@gnu.org>
parents:
diff changeset
364 the VMS version of @code{diff}.
Dave Love <fx@gnu.org>
parents:
diff changeset
365
Dave Love <fx@gnu.org>
parents:
diff changeset
366 The functions @code{ediff-files}, @code{ediff-buffers},
Dave Love <fx@gnu.org>
parents:
diff changeset
367 @code{ediff-files3}, @code{ediff-buffers3} first display the coarse,
33021
9fd41b036b84 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 33019
diff changeset
368 line-based difference regions, as reported by the @code{diff} program. The
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
369 total number of difference regions and the current difference number are
Dave Love <fx@gnu.org>
parents:
diff changeset
370 always displayed in the mode line of the control window.
Dave Love <fx@gnu.org>
parents:
diff changeset
371
Dave Love <fx@gnu.org>
parents:
diff changeset
372 Since @code{diff} may report fairly large chunks of text as being different,
Dave Love <fx@gnu.org>
parents:
diff changeset
373 even though the difference may be localized to just a few words or even
Dave Love <fx@gnu.org>
parents:
diff changeset
374 to the white space or line breaks, Ediff further @emph{refines} the
Dave Love <fx@gnu.org>
parents:
diff changeset
375 regions to indicate which exact words differ. If the only difference is
Dave Love <fx@gnu.org>
parents:
diff changeset
376 in the white space and line breaks, Ediff says so.
Dave Love <fx@gnu.org>
parents:
diff changeset
377
Dave Love <fx@gnu.org>
parents:
diff changeset
378 On a color display, fine differences are highlighted with color; on a
Dave Love <fx@gnu.org>
parents:
diff changeset
379 monochrome display, they are underlined. @xref{Highlighting Difference
Dave Love <fx@gnu.org>
parents:
diff changeset
380 Regions}, for information on how to customize this.
Dave Love <fx@gnu.org>
parents:
diff changeset
381
42602
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
382 The commands @code{ediff-windows-wordwise},
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
383 @code{ediff-windows-linewise}, @code{ediff-regions-wordwise} and
Dave Love <fx@gnu.org>
parents:
diff changeset
384 @code{ediff-regions-linewise} do comparison on parts of existing Emacs
42602
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
385 buffers. The commands @code{ediff-windows-wordwise} and
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
386 @code{ediff-regions-wordwise} are intended for relatively small segments
42602
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
387 of buffers (e.g., up to 100 lines, depending on the speed of your machine),
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
388 as they perform comparison on the basis of words rather than lines.
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
389 (Word-wise comparison of large chunks of text can be slow.)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
390
Dave Love <fx@gnu.org>
parents:
diff changeset
391 To compare large regions, use @code{ediff-regions-linewise}. This
Dave Love <fx@gnu.org>
parents:
diff changeset
392 command displays differences much like @code{ediff-files} and
Dave Love <fx@gnu.org>
parents:
diff changeset
393 @code{ediff-buffers}.
Dave Love <fx@gnu.org>
parents:
diff changeset
394
Dave Love <fx@gnu.org>
parents:
diff changeset
395 The functions @code{ediff-patch-file} and @code{ediff-patch-buffer} apply a
Dave Love <fx@gnu.org>
parents:
diff changeset
396 patch to a file or a buffer and then run Ediff on the appropriate
Dave Love <fx@gnu.org>
parents:
diff changeset
397 files/buffers, displaying the difference regions.
Dave Love <fx@gnu.org>
parents:
diff changeset
398
Dave Love <fx@gnu.org>
parents:
diff changeset
399 The entry points @code{ediff-directories}, @code{ediff-merge-directories},
Dave Love <fx@gnu.org>
parents:
diff changeset
400 etc., provide a convenient interface for comparing and merging files in
Dave Love <fx@gnu.org>
parents:
diff changeset
401 different directories. The user is presented with Dired-like interface from
Dave Love <fx@gnu.org>
parents:
diff changeset
402 which one can run a group of related Ediff sessions.
Dave Love <fx@gnu.org>
parents:
diff changeset
403
Dave Love <fx@gnu.org>
parents:
diff changeset
404 For files under version control, @code{ediff-revision} lets you compare
Dave Love <fx@gnu.org>
parents:
diff changeset
405 the file visited by the current buffer to one of its checked-in versions.
Dave Love <fx@gnu.org>
parents:
diff changeset
406 You can also compare two checked-in versions of the visited file.
Dave Love <fx@gnu.org>
parents:
diff changeset
407 Moreover, the functions @code{ediff-directory-revisions},
Dave Love <fx@gnu.org>
parents:
diff changeset
408 @code{ediff-merge-directory-revisions}, etc., let you run a group of
Dave Love <fx@gnu.org>
parents:
diff changeset
409 related Ediff sessions by taking a directory and comparing (or merging)
Dave Love <fx@gnu.org>
parents:
diff changeset
410 versions of files in that directory.
Dave Love <fx@gnu.org>
parents:
diff changeset
411
Dave Love <fx@gnu.org>
parents:
diff changeset
412 @node Session Commands, Registry of Ediff Sessions, Major Entry Points, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
413 @chapter Session Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
414
Dave Love <fx@gnu.org>
parents:
diff changeset
415 All Ediff commands are displayed in a Quick Help window, unless you type
Dave Love <fx@gnu.org>
parents:
diff changeset
416 @kbd{?} to shrink the window to just one line. You can redisplay the help
Dave Love <fx@gnu.org>
parents:
diff changeset
417 window by typing @kbd{?} again. The Quick Help commands are detailed below.
Dave Love <fx@gnu.org>
parents:
diff changeset
418
Dave Love <fx@gnu.org>
parents:
diff changeset
419 Many Ediff commands take numeric prefix arguments. For instance, if you
Dave Love <fx@gnu.org>
parents:
diff changeset
420 type a number, say 3, and then @kbd{j} (@code{ediff-jump-to-difference}),
Dave Love <fx@gnu.org>
parents:
diff changeset
421 Ediff moves to the third difference region. Typing 3 and then @kbd{a}
Dave Love <fx@gnu.org>
parents:
diff changeset
422 (@code{ediff-diff-to-diff}) copies the 3d difference region from variant A
Dave Love <fx@gnu.org>
parents:
diff changeset
423 to variant B. Likewise, 4 followed by @kbd{ra} restores the 4th difference
Dave Love <fx@gnu.org>
parents:
diff changeset
424 region in buffer A (if it was previously written over via the command
Dave Love <fx@gnu.org>
parents:
diff changeset
425 @kbd{a}).
Dave Love <fx@gnu.org>
parents:
diff changeset
426
Dave Love <fx@gnu.org>
parents:
diff changeset
427 Some commands take negative prefix arguments as well. For instance, typing
Dave Love <fx@gnu.org>
parents:
diff changeset
428 @kbd{-} and then @kbd{j} will make the last difference region
Dave Love <fx@gnu.org>
parents:
diff changeset
429 current. Typing @kbd{-2} then @kbd{j} makes the penultimate difference
Dave Love <fx@gnu.org>
parents:
diff changeset
430 region current, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
431
Dave Love <fx@gnu.org>
parents:
diff changeset
432 Without the prefix argument, all commands operate on the currently
Dave Love <fx@gnu.org>
parents:
diff changeset
433 selected difference region. You can make any difference region
Dave Love <fx@gnu.org>
parents:
diff changeset
434 current using the various commands explained below.
Dave Love <fx@gnu.org>
parents:
diff changeset
435
Dave Love <fx@gnu.org>
parents:
diff changeset
436 For some commands, the actual value of the prefix argument is
Dave Love <fx@gnu.org>
parents:
diff changeset
437 immaterial. However, if supplied, the prefix argument may modify the
Dave Love <fx@gnu.org>
parents:
diff changeset
438 command (see @kbd{ga}, @kbd{gb}, and @kbd{gc}).
Dave Love <fx@gnu.org>
parents:
diff changeset
439
Dave Love <fx@gnu.org>
parents:
diff changeset
440 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
441 * Quick Help Commands:: Frequently used commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
442 * Other Session Commands:: Commands that are not bound to keys.
Dave Love <fx@gnu.org>
parents:
diff changeset
443 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
444
Dave Love <fx@gnu.org>
parents:
diff changeset
445 @node Quick Help Commands,Other Session Commands,,Session Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
446 @section Quick Help Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
447
Dave Love <fx@gnu.org>
parents:
diff changeset
448 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
449 @item ?
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
450 @kindex ?
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
451 Toggles the Ediff Quick Help window ON and OFF.
Dave Love <fx@gnu.org>
parents:
diff changeset
452 @item G
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
453 @kindex G
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
454 Prepares a mail buffer for sending a praise or a curse to the Ediff maintainer.
Dave Love <fx@gnu.org>
parents:
diff changeset
455
Dave Love <fx@gnu.org>
parents:
diff changeset
456 @item E
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
457 @kindex E
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
458 Brings up the top node of this manual, where you can find further
Dave Love <fx@gnu.org>
parents:
diff changeset
459 information on the various Ediff functions and advanced issues, such as
Dave Love <fx@gnu.org>
parents:
diff changeset
460 customization, session groups, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
461
Dave Love <fx@gnu.org>
parents:
diff changeset
462 @item v
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
463 @kindex v
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
464 Scrolls up buffers A and B (and buffer C where appropriate) in a
Dave Love <fx@gnu.org>
parents:
diff changeset
465 coordinated fashion.
Dave Love <fx@gnu.org>
parents:
diff changeset
466 @item V
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
467 @kindex V
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
468 Scrolls the buffers down.
Dave Love <fx@gnu.org>
parents:
diff changeset
469
Dave Love <fx@gnu.org>
parents:
diff changeset
470 @item <
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
471 @kindex <
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
472 Scrolls the buffers to the left simultaneously.
Dave Love <fx@gnu.org>
parents:
diff changeset
473 @item >
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
474 @kindex >
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
475 Scrolls buffers to the right.
Dave Love <fx@gnu.org>
parents:
diff changeset
476
Dave Love <fx@gnu.org>
parents:
diff changeset
477 @item wd
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
478 @kindex wd
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
479 Saves the output from the diff utility, for further reference.
Dave Love <fx@gnu.org>
parents:
diff changeset
480
33021
9fd41b036b84 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 33019
diff changeset
481 With prefix argument, saves the plain output from @code{diff} (see
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
482 @code{ediff-diff-program} and @code{ediff-diff-options}). Without the
33021
9fd41b036b84 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 33019
diff changeset
483 argument, it saves customized @code{diff} output (see
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
484 @code{ediff-custom-diff-program} and @code{ediff-custom-diff-options}), if
Dave Love <fx@gnu.org>
parents:
diff changeset
485 it is available.
Dave Love <fx@gnu.org>
parents:
diff changeset
486
Dave Love <fx@gnu.org>
parents:
diff changeset
487 @item wa
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
488 @kindex wa
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
489 Saves buffer A, if it was modified.
Dave Love <fx@gnu.org>
parents:
diff changeset
490 @item wb
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
491 @kindex wb
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
492 Saves buffer B, if it was modified.
Dave Love <fx@gnu.org>
parents:
diff changeset
493 @item wc
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
494 @kindex wc
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
495 Saves buffer C, if it was modified (if you are in a session that
Dave Love <fx@gnu.org>
parents:
diff changeset
496 compares three files simultaneously).
Dave Love <fx@gnu.org>
parents:
diff changeset
497
Dave Love <fx@gnu.org>
parents:
diff changeset
498 @item a
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
499 @kindex a
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
500 @emph{In comparison sessions:}
Dave Love <fx@gnu.org>
parents:
diff changeset
501 Copies the current difference region (or the region specified as the prefix
Dave Love <fx@gnu.org>
parents:
diff changeset
502 to this command) from buffer A to buffer B.
Dave Love <fx@gnu.org>
parents:
diff changeset
503 Ediff saves the old contents of buffer B's region; it can
Dave Love <fx@gnu.org>
parents:
diff changeset
504 be restored via the command @kbd{rb}, which see.
Dave Love <fx@gnu.org>
parents:
diff changeset
505
Dave Love <fx@gnu.org>
parents:
diff changeset
506 @emph{In merge sessions:}
Dave Love <fx@gnu.org>
parents:
diff changeset
507 Copies the current difference region (or the region specified as the prefix
Dave Love <fx@gnu.org>
parents:
diff changeset
508 to this command) from buffer A to the merge buffer. The old contents of
Dave Love <fx@gnu.org>
parents:
diff changeset
509 this region in buffer C can be restored via the command @kbd{r}.
Dave Love <fx@gnu.org>
parents:
diff changeset
510
Dave Love <fx@gnu.org>
parents:
diff changeset
511 @item b
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
512 @kindex b
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
513 Works similarly, but copies the current difference region from buffer B to
Dave Love <fx@gnu.org>
parents:
diff changeset
514 buffer A (in @emph{comparison sessions}) or the merge buffer (in
Dave Love <fx@gnu.org>
parents:
diff changeset
515 @emph{merge sessions}).
Dave Love <fx@gnu.org>
parents:
diff changeset
516
Dave Love <fx@gnu.org>
parents:
diff changeset
517 Ediff saves the old contents of the difference region copied over; it can
Dave Love <fx@gnu.org>
parents:
diff changeset
518 be reinstated via the command @kbd{ra} in comparison sessions and
Dave Love <fx@gnu.org>
parents:
diff changeset
519 @kbd{r} in merge sessions.
Dave Love <fx@gnu.org>
parents:
diff changeset
520
Dave Love <fx@gnu.org>
parents:
diff changeset
521 @item ab
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
522 @kindex ab
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
523 Copies the current difference region (or the region specified as the prefix
Dave Love <fx@gnu.org>
parents:
diff changeset
524 to this command) from buffer A to buffer B. This (and the next five)
Dave Love <fx@gnu.org>
parents:
diff changeset
525 command is enabled only in sessions that compare three files
Dave Love <fx@gnu.org>
parents:
diff changeset
526 simultaneously. The old region in buffer B is saved and can be restored
Dave Love <fx@gnu.org>
parents:
diff changeset
527 via the command @kbd{rb}.
Dave Love <fx@gnu.org>
parents:
diff changeset
528 @item ac
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
529 @kindex ac
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
530 Copies the difference region from buffer A to buffer C.
Dave Love <fx@gnu.org>
parents:
diff changeset
531 The old region in buffer C is saved and can be restored via the command
Dave Love <fx@gnu.org>
parents:
diff changeset
532 @kbd{rc}.
Dave Love <fx@gnu.org>
parents:
diff changeset
533 @item ba
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
534 @kindex ba
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
535 Copies the difference region from buffer B to buffer A.
Dave Love <fx@gnu.org>
parents:
diff changeset
536 The old region in buffer A is saved and can be restored via the command
Dave Love <fx@gnu.org>
parents:
diff changeset
537 @kbd{ra}.
Dave Love <fx@gnu.org>
parents:
diff changeset
538 @item bc
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
539 @kindex bc
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
540 Copies the difference region from buffer B to buffer C.
Dave Love <fx@gnu.org>
parents:
diff changeset
541 The command @kbd{rc} undoes this.
Dave Love <fx@gnu.org>
parents:
diff changeset
542 @item ca
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
543 @kindex ca
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
544 Copies the difference region from buffer C to buffer A.
Dave Love <fx@gnu.org>
parents:
diff changeset
545 The command @kbd{ra} undoes this.
Dave Love <fx@gnu.org>
parents:
diff changeset
546 @item cb
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
547 @kindex cb
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
548 Copies the difference region from buffer C to buffer B.
Dave Love <fx@gnu.org>
parents:
diff changeset
549 The command @kbd{rb} undoes this.
Dave Love <fx@gnu.org>
parents:
diff changeset
550
Dave Love <fx@gnu.org>
parents:
diff changeset
551 @item p
Dave Love <fx@gnu.org>
parents:
diff changeset
552 @itemx DEL
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
553 @kindex p
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
554 @kindex DEL
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
555 Makes the previous difference region current.
Dave Love <fx@gnu.org>
parents:
diff changeset
556 @item n
Dave Love <fx@gnu.org>
parents:
diff changeset
557 @itemx SPC
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
558 @kindex n
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
559 @kindex SPC
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
560 Makes the next difference region current.
Dave Love <fx@gnu.org>
parents:
diff changeset
561
Dave Love <fx@gnu.org>
parents:
diff changeset
562 @item j
Dave Love <fx@gnu.org>
parents:
diff changeset
563 @itemx -j
Dave Love <fx@gnu.org>
parents:
diff changeset
564 @itemx Nj
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
565 @kindex j
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
566 Makes the very first difference region current.
Dave Love <fx@gnu.org>
parents:
diff changeset
567
Dave Love <fx@gnu.org>
parents:
diff changeset
568 @kbd{-j} makes the last region current. Typing a number, N, and then `j'
Dave Love <fx@gnu.org>
parents:
diff changeset
569 makes the difference region N current. Typing -N (a negative number) then
Dave Love <fx@gnu.org>
parents:
diff changeset
570 `j' makes current the region Last - N.
Dave Love <fx@gnu.org>
parents:
diff changeset
571
Dave Love <fx@gnu.org>
parents:
diff changeset
572 @item ga
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
573 @kindex ga
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
574 Makes current the difference region closest to the position of the point in
Dave Love <fx@gnu.org>
parents:
diff changeset
575 buffer A.
Dave Love <fx@gnu.org>
parents:
diff changeset
576
Dave Love <fx@gnu.org>
parents:
diff changeset
577 However, with a prefix argument, Ediff would position all variants
Dave Love <fx@gnu.org>
parents:
diff changeset
578 around the area indicated by the current point in buffer A: if
Dave Love <fx@gnu.org>
parents:
diff changeset
579 the point is inside a difference region, then the variants will be
Dave Love <fx@gnu.org>
parents:
diff changeset
580 positioned at this difference region. If the point is not in any difference
Dave Love <fx@gnu.org>
parents:
diff changeset
581 region, then it is in an area where all variants agree with each other. In
Dave Love <fx@gnu.org>
parents:
diff changeset
582 this case, the variants will be positioned so that each would display this
Dave Love <fx@gnu.org>
parents:
diff changeset
583 area (of agreement).
Dave Love <fx@gnu.org>
parents:
diff changeset
584 @item gb
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
585 @kindex gb
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
586 Makes current the difference region closest to the position of the point in
Dave Love <fx@gnu.org>
parents:
diff changeset
587 buffer B.
Dave Love <fx@gnu.org>
parents:
diff changeset
588
Dave Love <fx@gnu.org>
parents:
diff changeset
589 With a prefix argument, behaves like @kbd{ga}, but with respect to buffer B.
Dave Love <fx@gnu.org>
parents:
diff changeset
590 @item gc
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
591 @kindex gc
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
592 @emph{In merge sessions:}
Dave Love <fx@gnu.org>
parents:
diff changeset
593 makes current the difference region closest to the point in the merge buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
594
Dave Love <fx@gnu.org>
parents:
diff changeset
595 @emph{In 3-file comparison sessions:}
Dave Love <fx@gnu.org>
parents:
diff changeset
596 makes current the region closest to the point in buffer C.
Dave Love <fx@gnu.org>
parents:
diff changeset
597
Dave Love <fx@gnu.org>
parents:
diff changeset
598 With a prefix argument, behaves like @kbd{ga}, but with respect to buffer C.
Dave Love <fx@gnu.org>
parents:
diff changeset
599
Dave Love <fx@gnu.org>
parents:
diff changeset
600 @item !
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
601 @kindex !
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
602 Recomputes the difference regions, bringing them up to date. This is often
Dave Love <fx@gnu.org>
parents:
diff changeset
603 needed because it is common to do all sorts of editing during Ediff
Dave Love <fx@gnu.org>
parents:
diff changeset
604 sessions, so after a while, the highlighted difference regions may no
Dave Love <fx@gnu.org>
parents:
diff changeset
605 longer reflect the actual differences among the buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
606
Dave Love <fx@gnu.org>
parents:
diff changeset
607 @item *
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
608 @kindex *
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
609 Forces refinement of the current difference region, which highlights the exact
Dave Love <fx@gnu.org>
parents:
diff changeset
610 words of disagreement among the buffers. With a negative prefix argument,
Dave Love <fx@gnu.org>
parents:
diff changeset
611 unhighlights the current region.
Dave Love <fx@gnu.org>
parents:
diff changeset
612
Dave Love <fx@gnu.org>
parents:
diff changeset
613 Forceful refinement may be needed if Ediff encounters a difference region
Dave Love <fx@gnu.org>
parents:
diff changeset
614 that is larger than @code{ediff-auto-refine-limit}. In this situation,
Dave Love <fx@gnu.org>
parents:
diff changeset
615 Ediff doesn't do automatic refinement in order to improve response time.
Dave Love <fx@gnu.org>
parents:
diff changeset
616 (Ediff doesn't auto-refine on dumb terminals as well, but @kbd{*} still
Dave Love <fx@gnu.org>
parents:
diff changeset
617 works there. However, the only useful piece of information it can tell you
Dave Love <fx@gnu.org>
parents:
diff changeset
618 is whether or not the difference regions disagree only in the amount of
Dave Love <fx@gnu.org>
parents:
diff changeset
619 white space.)
Dave Love <fx@gnu.org>
parents:
diff changeset
620
Dave Love <fx@gnu.org>
parents:
diff changeset
621 This command is also useful when the highlighted fine differences are
Dave Love <fx@gnu.org>
parents:
diff changeset
622 no longer current, due to user editing.
Dave Love <fx@gnu.org>
parents:
diff changeset
623
Dave Love <fx@gnu.org>
parents:
diff changeset
624 @item m
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
625 @kindex m
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
626 Displays the current Ediff session in a frame as wide as the physical
Dave Love <fx@gnu.org>
parents:
diff changeset
627 display. This is useful when comparing files side-by-side. Typing `m' again
Dave Love <fx@gnu.org>
parents:
diff changeset
628 restores the original size of the frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
629
Dave Love <fx@gnu.org>
parents:
diff changeset
630 @item |
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
631 @kindex |
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
632 Toggles the horizontal/vertical split of the Ediff display. Horizontal
Dave Love <fx@gnu.org>
parents:
diff changeset
633 split is convenient when it is possible to compare files
Dave Love <fx@gnu.org>
parents:
diff changeset
634 side-by-side. If the frame in which files are displayed is too narrow
Dave Love <fx@gnu.org>
parents:
diff changeset
635 and lines are cut off, typing @kbd{m} may help some.
Dave Love <fx@gnu.org>
parents:
diff changeset
636
Dave Love <fx@gnu.org>
parents:
diff changeset
637 @item @@
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
638 @kindex @@
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
639 Toggles auto-refinement of difference regions (i.e., automatic highlighting
Dave Love <fx@gnu.org>
parents:
diff changeset
640 of the exact words that differ among the variants). Auto-refinement is
Dave Love <fx@gnu.org>
parents:
diff changeset
641 turned off on devices where Emacs doesn't support highlighting.
Dave Love <fx@gnu.org>
parents:
diff changeset
642
Dave Love <fx@gnu.org>
parents:
diff changeset
643 On slow machines, it may be advantageous to turn auto-refinement off. The
Dave Love <fx@gnu.org>
parents:
diff changeset
644 user can always forcefully refine specific difference regions by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
645 @kbd{*}.
Dave Love <fx@gnu.org>
parents:
diff changeset
646
Dave Love <fx@gnu.org>
parents:
diff changeset
647 @item h
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
648 @kindex h
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
649 Cycles between full highlighting, the mode where fine differences are not
Dave Love <fx@gnu.org>
parents:
diff changeset
650 highlighted (but computed), and the mode where highlighting is done with
52979
3649390c0f91 Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents: 52704
diff changeset
651 @acronym{ASCII} strings. The latter is not really recommended, unless on a dumb TTY.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
652
Dave Love <fx@gnu.org>
parents:
diff changeset
653 @item r
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
654 @kindex r
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
655 Restores the old contents of the region in the merge buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
656 (If you copied a difference region from buffer A or B into the merge buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
657 using the commands @kbd{a} or @kbd{b}, Ediff saves the old contents of the
Dave Love <fx@gnu.org>
parents:
diff changeset
658 region in case you change your mind.)
Dave Love <fx@gnu.org>
parents:
diff changeset
659
Dave Love <fx@gnu.org>
parents:
diff changeset
660 This command is enabled in merge sessions only.
Dave Love <fx@gnu.org>
parents:
diff changeset
661
Dave Love <fx@gnu.org>
parents:
diff changeset
662 @item ra
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
663 @kindex ra
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
664 Restores the old contents of the current difference region in buffer A,
Dave Love <fx@gnu.org>
parents:
diff changeset
665 which was previously saved when the user invoked one of these commands:
Dave Love <fx@gnu.org>
parents:
diff changeset
666 @kbd{b}, @kbd{ba}, @kbd{ca}, which see. This command is enabled in
Dave Love <fx@gnu.org>
parents:
diff changeset
667 comparison sessions only.
Dave Love <fx@gnu.org>
parents:
diff changeset
668 @item rb
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
669 @kindex rb
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
670 Restores the old contents of the current difference region in buffer B,
Dave Love <fx@gnu.org>
parents:
diff changeset
671 which was previously saved when the user invoked one of these commands:
Dave Love <fx@gnu.org>
parents:
diff changeset
672 @kbd{a}, @kbd{ab}, @kbd{cb}, which see. This command is enabled in
Dave Love <fx@gnu.org>
parents:
diff changeset
673 comparison sessions only.
Dave Love <fx@gnu.org>
parents:
diff changeset
674 @item rc
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
675 @kindex rc
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
676 Restores the old contents of the current difference region in buffer C,
Dave Love <fx@gnu.org>
parents:
diff changeset
677 which was previously saved when the user invoked one of these commands:
Dave Love <fx@gnu.org>
parents:
diff changeset
678 @kbd{ac}, @kbd{bc}, which see. This command is enabled in 3-file
Dave Love <fx@gnu.org>
parents:
diff changeset
679 comparison sessions only.
Dave Love <fx@gnu.org>
parents:
diff changeset
680
Dave Love <fx@gnu.org>
parents:
diff changeset
681 @item ##
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
682 @kindex ##
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
683 Tell Ediff to skip over regions that disagree among themselves only in the
Dave Love <fx@gnu.org>
parents:
diff changeset
684 amount of white space and line breaks.
Dave Love <fx@gnu.org>
parents:
diff changeset
685
Dave Love <fx@gnu.org>
parents:
diff changeset
686 Even though such regions will be skipped over, you can still jump to any
Dave Love <fx@gnu.org>
parents:
diff changeset
687 one of them by typing the region number and then `j'. Typing @kbd{##}
Dave Love <fx@gnu.org>
parents:
diff changeset
688 again puts Ediff back in the original state.
Dave Love <fx@gnu.org>
parents:
diff changeset
689
68997
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
690 @item #c
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
691 @kindex #c
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
692 @vindex ediff-ignore-case-option
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
693 @vindex ediff-ignore-case-option3
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
694 @vindex ediff-ignore-case
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
695 Toggle case sensitivity in the diff program. All diffs are recomputed.
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
696 Case sensitivity is controlled by the variables
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
697 @code{ediff-ignore-case-option}, @code{ediff-ignore-case-option3},
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
698 and @code{ediff-ignore-case}, which are explained elsewhere.
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
699
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
700 @item #h
Dave Love <fx@gnu.org>
parents:
diff changeset
701 @itemx #f
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
702 @kindex #f
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
703 @kindex #h
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
704 Ediff works hard to ameliorate the effects of boredom in the workplace...
Dave Love <fx@gnu.org>
parents:
diff changeset
705
Dave Love <fx@gnu.org>
parents:
diff changeset
706 Quite often differences are due to identical replacements (e.g., the word
Dave Love <fx@gnu.org>
parents:
diff changeset
707 `foo' is replaced with the word `bar' everywhere). If the number of regions
Dave Love <fx@gnu.org>
parents:
diff changeset
708 with such boring differences exceeds your tolerance threshold, you may be
Dave Love <fx@gnu.org>
parents:
diff changeset
709 tempted to tell Ediff to skip these regions altogether (you will still be able
Dave Love <fx@gnu.org>
parents:
diff changeset
710 to jump to them via the command @kbd{j}). The above commands, @kbd{#h}
Dave Love <fx@gnu.org>
parents:
diff changeset
711 and @kbd{#f}, may well save your day!
Dave Love <fx@gnu.org>
parents:
diff changeset
712
Dave Love <fx@gnu.org>
parents:
diff changeset
713 @kbd{#h} prompts you to specify regular expressions for each
Dave Love <fx@gnu.org>
parents:
diff changeset
714 variant. Difference regions where each variant's region matches the
Dave Love <fx@gnu.org>
parents:
diff changeset
715 corresponding regular expression will be skipped from then on. (You can
Dave Love <fx@gnu.org>
parents:
diff changeset
716 also tell Ediff to skip regions where at least one variant matches its
Dave Love <fx@gnu.org>
parents:
diff changeset
717 regular expression.)
Dave Love <fx@gnu.org>
parents:
diff changeset
718
Dave Love <fx@gnu.org>
parents:
diff changeset
719 @kbd{#f} does dual job: it focuses on regions that match the corresponding
Dave Love <fx@gnu.org>
parents:
diff changeset
720 regular expressions. All other regions will be skipped
Dave Love <fx@gnu.org>
parents:
diff changeset
721 over. @xref{Selective Browsing}, for more.
Dave Love <fx@gnu.org>
parents:
diff changeset
722
Dave Love <fx@gnu.org>
parents:
diff changeset
723 @item A
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
724 @kindex A
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
725 Toggles the read-only property in buffer A.
Dave Love <fx@gnu.org>
parents:
diff changeset
726 If file A is under version control and is checked in, it is checked out
Dave Love <fx@gnu.org>
parents:
diff changeset
727 (with your permission).
Dave Love <fx@gnu.org>
parents:
diff changeset
728 @item B
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
729 @kindex B
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
730 Toggles the read-only property in buffer B.
Dave Love <fx@gnu.org>
parents:
diff changeset
731 If file B is under version control and is checked in, it is checked out.
Dave Love <fx@gnu.org>
parents:
diff changeset
732 @item C
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
733 @kindex C
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
734 Toggles the read-only property in buffer C (in 3-file comparison sessions).
Dave Love <fx@gnu.org>
parents:
diff changeset
735 If file C is under version control and is checked in, it is checked out.
Dave Love <fx@gnu.org>
parents:
diff changeset
736
Dave Love <fx@gnu.org>
parents:
diff changeset
737 @item ~
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
738 @kindex ~
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
739 Swaps the windows where buffers A and B are displayed. If you are comparing
Dave Love <fx@gnu.org>
parents:
diff changeset
740 three buffers at once, then this command would rotate the windows among
Dave Love <fx@gnu.org>
parents:
diff changeset
741 buffers A, B, and C.
Dave Love <fx@gnu.org>
parents:
diff changeset
742
Dave Love <fx@gnu.org>
parents:
diff changeset
743 @item i
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
744 @kindex i
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
745 Displays all kinds of useful data about the current Ediff session.
Dave Love <fx@gnu.org>
parents:
diff changeset
746 @item D
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
747 @kindex D
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
748 Runs @code{ediff-custom-diff-program} on the variants and displays the
Dave Love <fx@gnu.org>
parents:
diff changeset
749 buffer containing the output. This is useful when you must send the output
Dave Love <fx@gnu.org>
parents:
diff changeset
750 to your Mom.
Dave Love <fx@gnu.org>
parents:
diff changeset
751
33021
9fd41b036b84 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 33019
diff changeset
752 With a prefix argument, displays the plain @code{diff} output.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
753 @xref{Patch and Diff Programs}, for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
754
Dave Love <fx@gnu.org>
parents:
diff changeset
755 @item R
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
756 @kindex R
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
757 Displays a list of currently active Ediff sessions---the Ediff Registry.
Dave Love <fx@gnu.org>
parents:
diff changeset
758 You can then restart any of these sessions by either clicking on a session
Dave Love <fx@gnu.org>
parents:
diff changeset
759 record or by putting the cursor over it and then typing the return key.
Dave Love <fx@gnu.org>
parents:
diff changeset
760
Dave Love <fx@gnu.org>
parents:
diff changeset
761 (Some poor souls leave so many active Ediff sessions around that they loose
Dave Love <fx@gnu.org>
parents:
diff changeset
762 track of them completely... The `R' command is designed to save these
Dave Love <fx@gnu.org>
parents:
diff changeset
763 people from the recently discovered Ediff Proficiency Syndrome.)
Dave Love <fx@gnu.org>
parents:
diff changeset
764
Dave Love <fx@gnu.org>
parents:
diff changeset
765 Typing @kbd{R} brings up Ediff Registry only if it is typed into an Ediff
Dave Love <fx@gnu.org>
parents:
diff changeset
766 Control Panel. If you don't have a control panel handy, type this in the
Dave Love <fx@gnu.org>
parents:
diff changeset
767 minibuffer: @kbd{M-x eregistry}. @xref{Registry of Ediff Sessions}.
Dave Love <fx@gnu.org>
parents:
diff changeset
768
Dave Love <fx@gnu.org>
parents:
diff changeset
769 @item M
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
770 @kindex M
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
771 Shows the session group buffer that invoked the current Ediff session.
Dave Love <fx@gnu.org>
parents:
diff changeset
772 @xref{Session Groups}, for more information on session groups.
Dave Love <fx@gnu.org>
parents:
diff changeset
773
Dave Love <fx@gnu.org>
parents:
diff changeset
774 @item z
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
775 @kindex z
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
776 Suspends the current Ediff session. (If you develop a condition known as
Dave Love <fx@gnu.org>
parents:
diff changeset
777 Repetitive Ediff Injury---a serious but curable illness---you must change
Dave Love <fx@gnu.org>
parents:
diff changeset
778 your current activity. This command tries hard to hide all Ediff-related
Dave Love <fx@gnu.org>
parents:
diff changeset
779 buffers.)
Dave Love <fx@gnu.org>
parents:
diff changeset
780
Dave Love <fx@gnu.org>
parents:
diff changeset
781 The easiest way to resume a suspended Ediff session is through the registry
Dave Love <fx@gnu.org>
parents:
diff changeset
782 of active sessions. @xref{Registry of Ediff Sessions}, for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
783 @item q
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
784 @kindex q
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
785 Terminates this Ediff session. With a prefix argument (e.g.,@kbd{1q}), asks
Dave Love <fx@gnu.org>
parents:
diff changeset
786 if you also want to delete the buffers of the variants.
Dave Love <fx@gnu.org>
parents:
diff changeset
787 Modified files and the results of merges are never deleted.
Dave Love <fx@gnu.org>
parents:
diff changeset
788
Dave Love <fx@gnu.org>
parents:
diff changeset
789 @item %
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
790 @kindex %
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
791 Toggles narrowing in Ediff buffers. Ediff buffers may be narrowed if you
Dave Love <fx@gnu.org>
parents:
diff changeset
792 are comparing only parts of these buffers via the commands
Dave Love <fx@gnu.org>
parents:
diff changeset
793 @code{ediff-windows-*} and @code{ediff-regions-*}, which see.
Dave Love <fx@gnu.org>
parents:
diff changeset
794
Dave Love <fx@gnu.org>
parents:
diff changeset
795 @item C-l
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
796 @kindex C-l
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
797 Restores the usual Ediff window setup. This is the quickest way to resume
Dave Love <fx@gnu.org>
parents:
diff changeset
798 an Ediff session, but it works only if the control panel of that session is
Dave Love <fx@gnu.org>
parents:
diff changeset
799 visible.
Dave Love <fx@gnu.org>
parents:
diff changeset
800
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
801 @item $$
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
802 @kindex $$
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
803 While merging with an ancestor file, Ediff is determined to reduce user's
Dave Love <fx@gnu.org>
parents:
diff changeset
804 wear and tear by saving him and her much of unproductive, repetitive
Dave Love <fx@gnu.org>
parents:
diff changeset
805 typing. If it notices that, say, file A's difference region is identical to
Dave Love <fx@gnu.org>
parents:
diff changeset
806 the same difference region in the ancestor file, then the merge buffer will
Dave Love <fx@gnu.org>
parents:
diff changeset
807 automatically get the difference region taken from buffer B. The rationale
Dave Love <fx@gnu.org>
parents:
diff changeset
808 is that this difference region in buffer A is as old as that in the
Dave Love <fx@gnu.org>
parents:
diff changeset
809 ancestor buffer, so the contents of that region in buffer B represents real
Dave Love <fx@gnu.org>
parents:
diff changeset
810 change.
Dave Love <fx@gnu.org>
parents:
diff changeset
811
Dave Love <fx@gnu.org>
parents:
diff changeset
812 You may want to ignore such `obvious' merges and concentrate on difference
Dave Love <fx@gnu.org>
parents:
diff changeset
813 regions where both files `clash' with the ancestor, since this means that
Dave Love <fx@gnu.org>
parents:
diff changeset
814 two different people have been changing this region independently and they
Dave Love <fx@gnu.org>
parents:
diff changeset
815 had different ideas on how to do this.
Dave Love <fx@gnu.org>
parents:
diff changeset
816
Dave Love <fx@gnu.org>
parents:
diff changeset
817 The above command does this for you by skipping the regions where only one
Dave Love <fx@gnu.org>
parents:
diff changeset
818 of the variants clashes with the ancestor but the other variant agrees with
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
819 it. Typing @kbd{$$} again undoes this setting.
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
820
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
821 @item $*
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
822 @kindex $*
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
823 When merging files with large number of differences, it is sometimes
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
824 convenient to be able to skip the difference regions for which you already
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
825 decided which variant is most appropriate. Typing @kbd{$*} will accomplish
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
826 precisely this.
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
827
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
828 To be more precise, this toggles the check for whether the current merge is
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
829 identical to its default setting, as originally decided by Ediff. For
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
830 instance, if Ediff is merging according to the `combined' policy, then the
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
831 merge region is skipped over if it is different from the combination of the
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
832 regions in buffers A and B. (Warning: swapping buffers A and B will confuse
71118
fde97bba5e37 Fix typos.
Eli Zaretskii <eliz@gnu.org>
parents: 69681
diff changeset
833 things in this respect.) If the merge region is marked as `prefer-A' then
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
834 this region will be skipped if it differs from the current difference
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
835 region in buffer A, etc.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
836
Dave Love <fx@gnu.org>
parents:
diff changeset
837 @item /
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
838 @kindex /
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
839 Displays the ancestor file during merges.
Dave Love <fx@gnu.org>
parents:
diff changeset
840 @item &
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
841 @kindex &
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
842 In some situations, such as when one of the files agrees with the ancestor file
Dave Love <fx@gnu.org>
parents:
diff changeset
843 on a difference region and the other doesn't, Ediff knows what to do: it copies
Dave Love <fx@gnu.org>
parents:
diff changeset
844 the current difference region from the second buffer into the merge buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
845
Dave Love <fx@gnu.org>
parents:
diff changeset
846 In other cases, the right course of action is not that clearcut, and Ediff
Dave Love <fx@gnu.org>
parents:
diff changeset
847 would use a default action. The above command changes the default action.
Dave Love <fx@gnu.org>
parents:
diff changeset
848 The default action can be @samp{default-A} (choose the region from buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
849 A), @samp{default-B} (choose the region from buffer B), or @samp{combined}
Dave Love <fx@gnu.org>
parents:
diff changeset
850 (combine the regions from the two buffers).
Dave Love <fx@gnu.org>
parents:
diff changeset
851 @xref{Merging and diff3}, for further details.
Dave Love <fx@gnu.org>
parents:
diff changeset
852
Dave Love <fx@gnu.org>
parents:
diff changeset
853 The command @kbd{&} also affects the regions in the merge buffers that have
Dave Love <fx@gnu.org>
parents:
diff changeset
854 @samp{default-A}, @samp{default-B}, or @samp{combined} status, provided
Dave Love <fx@gnu.org>
parents:
diff changeset
855 they weren't changed with respect to the original. For instance, if such a
Dave Love <fx@gnu.org>
parents:
diff changeset
856 region has the status @samp{default-A} then changing the default action to
Dave Love <fx@gnu.org>
parents:
diff changeset
857 @samp{default-B} will also replace this merge-buffer's region with the
Dave Love <fx@gnu.org>
parents:
diff changeset
858 corresponding region from buffer B.
Dave Love <fx@gnu.org>
parents:
diff changeset
859
Dave Love <fx@gnu.org>
parents:
diff changeset
860 @item s
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
861 @kindex s
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
862 Causes the merge window shrink to its minimum size, thereby exposing as much
Dave Love <fx@gnu.org>
parents:
diff changeset
863 of the variant buffers as possible. Typing `s' again restores
Dave Love <fx@gnu.org>
parents:
diff changeset
864 the original size of that window.
Dave Love <fx@gnu.org>
parents:
diff changeset
865
Dave Love <fx@gnu.org>
parents:
diff changeset
866 With a positive prefix argument, this command enlarges the merge window.
Dave Love <fx@gnu.org>
parents:
diff changeset
867 E.g., @kbd{4s} increases the size of the window by about 4 lines, if
Dave Love <fx@gnu.org>
parents:
diff changeset
868 possible. With a negative numeric argument, the size of the merge window
Dave Love <fx@gnu.org>
parents:
diff changeset
869 shrinks by that many lines, if possible. Thus, @kbd{-s} shrinks the window
Dave Love <fx@gnu.org>
parents:
diff changeset
870 by about 1 line and @kbd{-3s} by about 3 lines.
Dave Love <fx@gnu.org>
parents:
diff changeset
871
Dave Love <fx@gnu.org>
parents:
diff changeset
872 This command is intended only for temporary viewing; therefore, Ediff
Dave Love <fx@gnu.org>
parents:
diff changeset
873 restores window C to its original size whenever it makes any other change
Dave Love <fx@gnu.org>
parents:
diff changeset
874 in the window configuration. However, redisplaying (@kbd{C-l}) or jumping
Dave Love <fx@gnu.org>
parents:
diff changeset
875 to another difference does not affect window C's size.
Dave Love <fx@gnu.org>
parents:
diff changeset
876
Dave Love <fx@gnu.org>
parents:
diff changeset
877 The split between the merge window and the variant windows is controlled by
Dave Love <fx@gnu.org>
parents:
diff changeset
878 the variable @code{ediff-merge-window-share}, which see.
Dave Love <fx@gnu.org>
parents:
diff changeset
879
Dave Love <fx@gnu.org>
parents:
diff changeset
880 @item +
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
881 @kindex +
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
882 Combines the difference regions from buffers A and B and copies the
Dave Love <fx@gnu.org>
parents:
diff changeset
883 result into the merge buffer. @xref{Merging and diff3}, and the
Dave Love <fx@gnu.org>
parents:
diff changeset
884 variables @code{ediff-combine-diffs} and @code{ediff-combination-pattern}.
Dave Love <fx@gnu.org>
parents:
diff changeset
885
Dave Love <fx@gnu.org>
parents:
diff changeset
886
Dave Love <fx@gnu.org>
parents:
diff changeset
887 @item =
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
888 @kindex =
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
889 You may run into situations when a large chunk of text in one file has been
Dave Love <fx@gnu.org>
parents:
diff changeset
890 edited and then moved to a different place in another file. In such a case,
Dave Love <fx@gnu.org>
parents:
diff changeset
891 these two chunks of text are unlikely to belong to the same difference
Dave Love <fx@gnu.org>
parents:
diff changeset
892 region, so the refinement feature of Ediff will not be able to tell you
Dave Love <fx@gnu.org>
parents:
diff changeset
893 what exactly differs inside these chunks. Since eyeballing large pieces of
Dave Love <fx@gnu.org>
parents:
diff changeset
894 text is contrary to human nature, Ediff has a special command to help
Dave Love <fx@gnu.org>
parents:
diff changeset
895 reduce the risk of developing a cataract.
Dave Love <fx@gnu.org>
parents:
diff changeset
896
44029
aa071cceb8e0 described the new "=" fiture.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43715
diff changeset
897 In other situations, the currently highlighted region might be big and you
aa071cceb8e0 described the new "=" fiture.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43715
diff changeset
898 might want to reconcile of them interactively.
aa071cceb8e0 described the new "=" fiture.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43715
diff changeset
899
46918
82d113655734 Minor spelling and grammar corrections.
Paul Eggert <eggert@twinsun.com>
parents: 44615
diff changeset
900 All of this can be done with the above command, @kbd{=}, which
44029
aa071cceb8e0 described the new "=" fiture.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43715
diff changeset
901 compares regions within Ediff buffers. Typing @kbd{=} creates a
aa071cceb8e0 described the new "=" fiture.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43715
diff changeset
902 child Ediff session for comparing regions in buffers A, B, or
aa071cceb8e0 described the new "=" fiture.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43715
diff changeset
903 C as follows.
aa071cceb8e0 described the new "=" fiture.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43715
diff changeset
904
aa071cceb8e0 described the new "=" fiture.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43715
diff changeset
905 First, you will be asked whether you want to compare the fine differences
aa071cceb8e0 described the new "=" fiture.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43715
diff changeset
906 between the currently highlighted buffers on a word-by-word basis. If you
aa071cceb8e0 described the new "=" fiture.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43715
diff changeset
907 accept, a child Ediff session will start using the currently highlighted
aa071cceb8e0 described the new "=" fiture.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43715
diff changeset
908 regions. Ediff will let you step over the differences word-wise.
aa071cceb8e0 described the new "=" fiture.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43715
diff changeset
909
aa071cceb8e0 described the new "=" fiture.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43715
diff changeset
910 If you reject the offer, you will be asked to select regions of your choice.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
911
Dave Love <fx@gnu.org>
parents:
diff changeset
912 @emph{If you are comparing 2 files or buffers:}
43715
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
913 Ediff will ask you to select regions in buffers A and B.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
914
43715
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
915 @emph{If you are comparing 3 files or buffers simultaneously:} Ediff will
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
916 ask you to choose buffers and then select regions inside those buffers.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
917
Dave Love <fx@gnu.org>
parents:
diff changeset
918 @emph{If you are merging files or buffers (with or without ancestor):}
43715
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
919 Ediff will ask you to choose which buffer (A or B) to compare with the
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
920 merge buffer and then select regions in those buffers.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
921
Dave Love <fx@gnu.org>
parents:
diff changeset
922 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
923
Dave Love <fx@gnu.org>
parents:
diff changeset
924 @node Other Session Commands,,Quick Help Commands,Session Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
925 @section Other Session Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
926
Dave Love <fx@gnu.org>
parents:
diff changeset
927 The following commands can be invoked from within any Ediff session,
Dave Love <fx@gnu.org>
parents:
diff changeset
928 although some of them are not bound to a key.
Dave Love <fx@gnu.org>
parents:
diff changeset
929
Dave Love <fx@gnu.org>
parents:
diff changeset
930 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
931 @item eregistry
Dave Love <fx@gnu.org>
parents:
diff changeset
932 @itemx ediff-show-registry
Dave Love <fx@gnu.org>
parents:
diff changeset
933 @findex eregistry
Dave Love <fx@gnu.org>
parents:
diff changeset
934 @findex ediff-show-registry
Dave Love <fx@gnu.org>
parents:
diff changeset
935 This command brings up the registry of active Ediff sessions. Ediff
Dave Love <fx@gnu.org>
parents:
diff changeset
936 registry is a device that can be used to resume any active Ediff session
Dave Love <fx@gnu.org>
parents:
diff changeset
937 (which may have been postponed because the user switched to some other
Dave Love <fx@gnu.org>
parents:
diff changeset
938 activity). This command is also useful for switching between multiple
Dave Love <fx@gnu.org>
parents:
diff changeset
939 active Ediff sessions that are run at the same time. The function
Dave Love <fx@gnu.org>
parents:
diff changeset
940 @code{eregistry} is an alias for @code{ediff-show-registry}.
Dave Love <fx@gnu.org>
parents:
diff changeset
941 @xref{Registry of Ediff Sessions}, for more information on this registry.
Dave Love <fx@gnu.org>
parents:
diff changeset
942
Dave Love <fx@gnu.org>
parents:
diff changeset
943 @item ediff-toggle-multiframe
Dave Love <fx@gnu.org>
parents:
diff changeset
944 @findex ediff-toggle-multiframe
Dave Love <fx@gnu.org>
parents:
diff changeset
945 Changes the display from the multi-frame mode (where the quick help window
Dave Love <fx@gnu.org>
parents:
diff changeset
946 is in a separate frame) to the single-frame mode (where all Ediff buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
947 share the same frame), and vice versa. See
Dave Love <fx@gnu.org>
parents:
diff changeset
948 @code{ediff-window-setup-function} for details on how to make either of
Dave Love <fx@gnu.org>
parents:
diff changeset
949 these modes the default one.
Dave Love <fx@gnu.org>
parents:
diff changeset
950
Dave Love <fx@gnu.org>
parents:
diff changeset
951 This function can also be invoked from the Menubar. However, in some
Dave Love <fx@gnu.org>
parents:
diff changeset
952 cases, the change will take place only after you execute one of the Ediff
Dave Love <fx@gnu.org>
parents:
diff changeset
953 commands, such as going to the next difference or redisplaying.
Dave Love <fx@gnu.org>
parents:
diff changeset
954
42602
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
955 @item ediff-toggle-use-toolbar
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
956 @findex ediff-toggle-use-toolbar
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
957 Available in XEmacs only. The Ediff toolbar provides quick access to some
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
958 of the common Ediff functions. This function toggles the display of the
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
959 toolbar. If invoked from the menubar, the function may take sometimes
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
960 effect only after you execute an Ediff command, such as going to the next
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
961 difference.
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
962
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
963 @item ediff-use-toolbar-p
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
964 @vindex ediff-use-toolbar-p
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
965 The use of the toolbar can also be specified via the variable
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
966 @code{ediff-use-toolbar-p} (default is @code{t}). This variable can be set
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
967 only in @file{.emacs} --- do @strong{not} change it interactively. Use the
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
968 function @code{ediff-toggle-use-toolbar} instead.
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
969
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
970 @item ediff-revert-buffers-then-recompute-diffs
Dave Love <fx@gnu.org>
parents:
diff changeset
971 @findex ediff-revert-buffers-then-recompute-diffs
Dave Love <fx@gnu.org>
parents:
diff changeset
972 This command reverts the buffers you are comparing and recomputes their
Dave Love <fx@gnu.org>
parents:
diff changeset
973 differences. It is useful when, after making changes, you decided to
Dave Love <fx@gnu.org>
parents:
diff changeset
974 make a fresh start, or if at some point you changed the files being
Dave Love <fx@gnu.org>
parents:
diff changeset
975 compared but want to discard any changes to comparison buffers that were
Dave Love <fx@gnu.org>
parents:
diff changeset
976 done since then.
Dave Love <fx@gnu.org>
parents:
diff changeset
977
Dave Love <fx@gnu.org>
parents:
diff changeset
978 This command normally asks for confirmation before reverting files.
Dave Love <fx@gnu.org>
parents:
diff changeset
979 With a prefix argument, it reverts files without asking.
Dave Love <fx@gnu.org>
parents:
diff changeset
980
Dave Love <fx@gnu.org>
parents:
diff changeset
981
Dave Love <fx@gnu.org>
parents:
diff changeset
982 @item ediff-profile
Dave Love <fx@gnu.org>
parents:
diff changeset
983 @findex ediff-profile
Dave Love <fx@gnu.org>
parents:
diff changeset
984 Ediff has an admittedly primitive (but useful) facility for profiling
Dave Love <fx@gnu.org>
parents:
diff changeset
985 Ediff's commands. It is meant for Ediff maintenance---specifically, for
Dave Love <fx@gnu.org>
parents:
diff changeset
986 making it run faster. The function @code{ediff-profile} toggles
Dave Love <fx@gnu.org>
parents:
diff changeset
987 profiling of ediff commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
988 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
989
Dave Love <fx@gnu.org>
parents:
diff changeset
990 @node Registry of Ediff Sessions, Session Groups, Session Commands, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
991 @chapter Registry of Ediff Sessions
Dave Love <fx@gnu.org>
parents:
diff changeset
992
Dave Love <fx@gnu.org>
parents:
diff changeset
993 Ediff maintains a registry of all its invocations that are
Dave Love <fx@gnu.org>
parents:
diff changeset
994 still @emph{active}. This feature is very convenient for switching among
Dave Love <fx@gnu.org>
parents:
diff changeset
995 active Ediff sessions or for quickly restarting a suspended Ediff session.
Dave Love <fx@gnu.org>
parents:
diff changeset
996
Dave Love <fx@gnu.org>
parents:
diff changeset
997 The focal point of this activity is a buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
998 called @emph{*Ediff Registry*}. You can display this buffer by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
999 @kbd{R} in any Ediff Control Buffer or Session Group Buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1000 (@pxref{Session Groups}), or by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
1001 @kbd{M-x eregistry} into the Minibuffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1002 The latter would be the fastest way to bring up the registry
Dave Love <fx@gnu.org>
parents:
diff changeset
1003 buffer if no control or group buffer is displayed in any of the visible
Dave Love <fx@gnu.org>
parents:
diff changeset
1004 Emacs windows.
Dave Love <fx@gnu.org>
parents:
diff changeset
1005 If you are in a habit of running multiple long Ediff sessions and often need to
Dave Love <fx@gnu.org>
parents:
diff changeset
1006 suspend, resume, or switch between them, it may be a good idea to have the
Dave Love <fx@gnu.org>
parents:
diff changeset
1007 registry buffer permanently displayed in a separate, dedicated window.
Dave Love <fx@gnu.org>
parents:
diff changeset
1008
Dave Love <fx@gnu.org>
parents:
diff changeset
1009 The registry buffer has several convenient key bindings.
Dave Love <fx@gnu.org>
parents:
diff changeset
1010 For instance, clicking mouse button 2 or typing
Dave Love <fx@gnu.org>
parents:
diff changeset
1011 @kbd{RET} or @kbd{v} over any session record resumes that session.
Dave Love <fx@gnu.org>
parents:
diff changeset
1012 Session records in the registry buffer provide a fairly complete
Dave Love <fx@gnu.org>
parents:
diff changeset
1013 description of each session, so it is usually easy to identify the right
Dave Love <fx@gnu.org>
parents:
diff changeset
1014 session to resume.
Dave Love <fx@gnu.org>
parents:
diff changeset
1015
Dave Love <fx@gnu.org>
parents:
diff changeset
1016 Other useful commands are bound to @kbd{SPC} (next registry record)
Dave Love <fx@gnu.org>
parents:
diff changeset
1017 and @kbd{DEL} (previous registry record). There are other commands as well,
Dave Love <fx@gnu.org>
parents:
diff changeset
1018 but you don't need to memorize them, since they are listed at the top of
Dave Love <fx@gnu.org>
parents:
diff changeset
1019 the registry buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1020
Dave Love <fx@gnu.org>
parents:
diff changeset
1021 @node Session Groups, Remote and Compressed Files, Registry of Ediff Sessions, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
1022 @chapter Session Groups
Dave Love <fx@gnu.org>
parents:
diff changeset
1023
Dave Love <fx@gnu.org>
parents:
diff changeset
1024 Several major entries of Ediff perform comparison and merging on
Dave Love <fx@gnu.org>
parents:
diff changeset
1025 directories. On entering @code{ediff-directories},
Dave Love <fx@gnu.org>
parents:
diff changeset
1026 @code{ediff-directories3},
Dave Love <fx@gnu.org>
parents:
diff changeset
1027 @code{ediff-merge-directories},
Dave Love <fx@gnu.org>
parents:
diff changeset
1028 @code{ediff-merge-directories-with-ancestor},
Dave Love <fx@gnu.org>
parents:
diff changeset
1029 @code{ediff-directory-revisions},
Dave Love <fx@gnu.org>
parents:
diff changeset
1030 @code{ediff-merge-directory-revisions}, or
Dave Love <fx@gnu.org>
parents:
diff changeset
1031 @code{ediff-merge-directory-revisions-with-ancestor},
Dave Love <fx@gnu.org>
parents:
diff changeset
1032 the user is presented with a
Dave Love <fx@gnu.org>
parents:
diff changeset
1033 Dired-like buffer that lists files common to the directories involved along
Dave Love <fx@gnu.org>
parents:
diff changeset
1034 with their sizes. (The list of common files can be further filtered through
Dave Love <fx@gnu.org>
parents:
diff changeset
1035 a regular expression, which the user is prompted for.) We call this buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1036 @emph{Session Group Panel} because all Ediff sessions associated with the
Dave Love <fx@gnu.org>
parents:
diff changeset
1037 listed files will have this buffer as a common focal point.
Dave Love <fx@gnu.org>
parents:
diff changeset
1038
Dave Love <fx@gnu.org>
parents:
diff changeset
1039 Clicking button 2 or typing @kbd{RET} or @kbd{v} over a
Dave Love <fx@gnu.org>
parents:
diff changeset
1040 record describing files invokes Ediff in the appropriate mode on these
Dave Love <fx@gnu.org>
parents:
diff changeset
1041 files. You can come back to the session group buffer associated with a
Dave Love <fx@gnu.org>
parents:
diff changeset
1042 particular invocation of Ediff by typing @kbd{M} in Ediff control buffer of
Dave Love <fx@gnu.org>
parents:
diff changeset
1043 that invocation.
Dave Love <fx@gnu.org>
parents:
diff changeset
1044
Dave Love <fx@gnu.org>
parents:
diff changeset
1045 Many commands are available in the session group buffer; some are
Dave Love <fx@gnu.org>
parents:
diff changeset
1046 applicable only to certain types of work. The relevant commands are always
Dave Love <fx@gnu.org>
parents:
diff changeset
1047 listed at the top of each session group buffer, so there is no need to
Dave Love <fx@gnu.org>
parents:
diff changeset
1048 memorize them.
Dave Love <fx@gnu.org>
parents:
diff changeset
1049
Dave Love <fx@gnu.org>
parents:
diff changeset
1050 In directory comparison or merging, a session group panel displays only the
Dave Love <fx@gnu.org>
parents:
diff changeset
1051 files common to all directories involved. The differences are kept in a
43715
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
1052 separate @emph{directory difference buffer} and are conveniently displayed
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
1053 by typing @kbd{D} to the corresponding session group panel. Thus, as an
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
1054 added benefit, Ediff can be used to compare the contents of up to three
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
1055 directories.
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
1056
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
1057 @cindex Directory difference buffer
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
1058 Sometimes it is desirable to copy some files from one directory to another
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
1059 without exiting Ediff. The @emph{directory difference buffer}, which is
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
1060 displayed by typing @kbd{D} as discussed above, can be used for this
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
1061 purpose. If a file is, say, in Ediff's Directory A, but is missing in
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
1062 Ediff's Directory B (Ediff will refuse to override existing files), then
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
1063 typing @kbd{C} or clicking mouse button 2 over that file (which must be
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
1064 displayed in directory difference buffer) will copy that file from
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
1065 Directory A to Directory B.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1066
Dave Love <fx@gnu.org>
parents:
diff changeset
1067 Session records in session group panels are also marked with @kbd{+}, for
Dave Love <fx@gnu.org>
parents:
diff changeset
1068 active sessions, and with @kbd{-}, for finished sessions.
Dave Love <fx@gnu.org>
parents:
diff changeset
1069
Dave Love <fx@gnu.org>
parents:
diff changeset
1070 Sometimes, it is convenient to exclude certain sessions from a group.
Dave Love <fx@gnu.org>
parents:
diff changeset
1071 Usually this happens when the user doesn't intend to run Ediff of certain
Dave Love <fx@gnu.org>
parents:
diff changeset
1072 files in the group, and the corresponding session records just add clutter
Dave Love <fx@gnu.org>
parents:
diff changeset
1073 to the session group buffer. To help alleviate this problem, the user can
Dave Love <fx@gnu.org>
parents:
diff changeset
1074 type @kbd{h} to mark a session as a candidate for exclusion and @kbd{x} to
Dave Love <fx@gnu.org>
parents:
diff changeset
1075 actually hide the marked sessions. There actions are reversible: with a
Dave Love <fx@gnu.org>
parents:
diff changeset
1076 prefix argument, @kbd{h} unmarks the session under the cursor, and @kbd{x}
Dave Love <fx@gnu.org>
parents:
diff changeset
1077 brings the hidden sessions into the view (@kbd{x} doesn't unmark them,
Dave Love <fx@gnu.org>
parents:
diff changeset
1078 though, so the user has to explicitly unmark the sessions of interest).
Dave Love <fx@gnu.org>
parents:
diff changeset
1079
Dave Love <fx@gnu.org>
parents:
diff changeset
1080 Group sessions also understand the command @kbd{m}, which marks sessions
Dave Love <fx@gnu.org>
parents:
diff changeset
1081 for future operations (other than hiding) on a group of sessions. At present,
Dave Love <fx@gnu.org>
parents:
diff changeset
1082 the only such group-level operation is the creation of a multi-file patch.
Dave Love <fx@gnu.org>
parents:
diff changeset
1083
Dave Love <fx@gnu.org>
parents:
diff changeset
1084 @vindex ediff-autostore-merges
Dave Love <fx@gnu.org>
parents:
diff changeset
1085 For group sessions created to merge files, Ediff can store all merges
Dave Love <fx@gnu.org>
parents:
diff changeset
1086 automatically in a directory. The user is asked to specify such directory
56279
b1ae5333057a * ses.texi, viper.texi, search.texi, flymake.texi, faq.texi:
Jesper Harder <harder@ifa.au.dk>
parents: 52979
diff changeset
1087 if the value of @code{ediff-autostore-merges} is non-@code{nil}. If the value is
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1088 @code{nil}, nothing is done to the merge buffers---it will be the user's
Dave Love <fx@gnu.org>
parents:
diff changeset
1089 responsibility to save them. If the value is @code{t}, the user will be
Dave Love <fx@gnu.org>
parents:
diff changeset
1090 asked where to save the merge buffers in all merge jobs, even those that do
Dave Love <fx@gnu.org>
parents:
diff changeset
1091 not originate from a session group. It the value is neither @code{nil} nor
Dave Love <fx@gnu.org>
parents:
diff changeset
1092 @code{t}, the merge buffer is saved @emph{only} if this merge session was
Dave Love <fx@gnu.org>
parents:
diff changeset
1093 invoked from a session group. This behavior is implemented in the function
Dave Love <fx@gnu.org>
parents:
diff changeset
1094 @code{ediff-maybe-save-and-delete-merge}, which is a hook in
Dave Love <fx@gnu.org>
parents:
diff changeset
1095 @code{ediff-quit-merge-hook}. The user can supply a different hook, if
Dave Love <fx@gnu.org>
parents:
diff changeset
1096 necessary.
Dave Love <fx@gnu.org>
parents:
diff changeset
1097
Dave Love <fx@gnu.org>
parents:
diff changeset
1098 The variable @code{ediff-autostore-merges} is buffer-local, so it can be
29165
641e43bad886 2000-05-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 29107
diff changeset
1099 set on a per-buffer basis. Therefore, use @code{setq-default} to change
641e43bad886 2000-05-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 29107
diff changeset
1100 this variable globally.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1101
Dave Love <fx@gnu.org>
parents:
diff changeset
1102 @cindex Multi-file patches
42288
3ce98f3e0608 2001-12-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 38865
diff changeset
1103 A multi-file patch is a concatenated output of several runs of the Unix
33021
9fd41b036b84 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 33019
diff changeset
1104 @code{diff} command (some versions of @code{diff} let you create a
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1105 multi-file patch in just one run). Ediff facilitates creation of
Dave Love <fx@gnu.org>
parents:
diff changeset
1106 multi-file patches as follows. If you are in a session group buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1107 created in response to @code{ediff-directories} or
Dave Love <fx@gnu.org>
parents:
diff changeset
1108 @code{ediff-directory-revisions}, you can mark (by typing @kbd{m}) the
Dave Love <fx@gnu.org>
parents:
diff changeset
1109 desired Ediff sessions and then type @kbd{P} to create a
Dave Love <fx@gnu.org>
parents:
diff changeset
1110 multi-file patch of those marked sessions.
Dave Love <fx@gnu.org>
parents:
diff changeset
1111 Ediff will then display a buffer containing the patch.
33021
9fd41b036b84 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 33019
diff changeset
1112 The patch is generated by invoking @code{diff} on all marked individual
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1113 sessions (represented by files) and session groups (represented by
Dave Love <fx@gnu.org>
parents:
diff changeset
1114 directories). Ediff will also recursively descend into any @emph{unmarked}
Dave Love <fx@gnu.org>
parents:
diff changeset
1115 session group and will search for marked sessions there. In this way, you
Dave Love <fx@gnu.org>
parents:
diff changeset
1116 can create multi-file patches that span file subtrees that grow out of
Dave Love <fx@gnu.org>
parents:
diff changeset
1117 any given directory.
Dave Love <fx@gnu.org>
parents:
diff changeset
1118
Dave Love <fx@gnu.org>
parents:
diff changeset
1119 In an @code{ediff-directories} session, it is enough to just mark the
Dave Love <fx@gnu.org>
parents:
diff changeset
1120 requisite sessions. In @code{ediff-directory-revisions} revisions, the
Dave Love <fx@gnu.org>
parents:
diff changeset
1121 marked sessions must also be active, or else Ediff will refuse to produce a
Dave Love <fx@gnu.org>
parents:
diff changeset
1122 multi-file patch. This is because, in the latter-style sessions, there are
Dave Love <fx@gnu.org>
parents:
diff changeset
1123 many ways to create diff output, and it is easier to handle by running
Dave Love <fx@gnu.org>
parents:
diff changeset
1124 Ediff on the inactive sessions.
Dave Love <fx@gnu.org>
parents:
diff changeset
1125
60151
905bf9de87af * ediff.el (ediff-set-diff-overlays-in-one-buffer,
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 56279
diff changeset
1126 Last, but not least, by typing @kbd{==}, you can quickly find out which
905bf9de87af * ediff.el (ediff-set-diff-overlays-in-one-buffer,
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 56279
diff changeset
1127 sessions have identical entries, so you won't have to run Ediff on those
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1128 sessions. This, however, works only on local, uncompressed files.
Dave Love <fx@gnu.org>
parents:
diff changeset
1129 For compressed or remote files, this command won't report anything.
60151
905bf9de87af * ediff.el (ediff-set-diff-overlays-in-one-buffer,
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 56279
diff changeset
1130 Likewise, you can use @kbd{=h} to mark sessions with identical entries
905bf9de87af * ediff.el (ediff-set-diff-overlays-in-one-buffer,
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 56279
diff changeset
1131 for hiding or, with @kbd{=m}, for further operations.
905bf9de87af * ediff.el (ediff-set-diff-overlays-in-one-buffer,
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 56279
diff changeset
1132
905bf9de87af * ediff.el (ediff-set-diff-overlays-in-one-buffer,
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 56279
diff changeset
1133 The comparison operations @kbd{==}, @kbd{=h}, and @kbd{=m} can recurse into
905bf9de87af * ediff.el (ediff-set-diff-overlays-in-one-buffer,
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 56279
diff changeset
1134 subdirectories to see if they have identical contents (so the user will not
905bf9de87af * ediff.el (ediff-set-diff-overlays-in-one-buffer,
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 56279
diff changeset
1135 need to descend into those subdirectories manually). These commands ask the
905bf9de87af * ediff.el (ediff-set-diff-overlays-in-one-buffer,
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 56279
diff changeset
1136 user whether or not to do a recursive descent.
905bf9de87af * ediff.el (ediff-set-diff-overlays-in-one-buffer,
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 56279
diff changeset
1137
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1138
Dave Love <fx@gnu.org>
parents:
diff changeset
1139
Dave Love <fx@gnu.org>
parents:
diff changeset
1140 @node Remote and Compressed Files, Customization, Session Groups, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
1141 @chapter Remote and Compressed Files
Dave Love <fx@gnu.org>
parents:
diff changeset
1142
Dave Love <fx@gnu.org>
parents:
diff changeset
1143 Ediff works with remote, compressed, and encrypted files. Ediff
Dave Love <fx@gnu.org>
parents:
diff changeset
1144 supports @file{ange-ftp.el}, @file{jka-compr.el}, @file{uncompress.el}
Dave Love <fx@gnu.org>
parents:
diff changeset
1145 and @file{crypt++.el}, but it may work with other similar packages as
Dave Love <fx@gnu.org>
parents:
diff changeset
1146 well. This means that you can compare files residing on another
Dave Love <fx@gnu.org>
parents:
diff changeset
1147 machine, or you can apply a patch to a file on another machine. Even
Dave Love <fx@gnu.org>
parents:
diff changeset
1148 the patch itself can be a remote file!
Dave Love <fx@gnu.org>
parents:
diff changeset
1149
Dave Love <fx@gnu.org>
parents:
diff changeset
1150 When patching compressed or remote files, Ediff does not rename the source
Dave Love <fx@gnu.org>
parents:
diff changeset
1151 file (unlike what the @code{patch} utility would usually do). Instead, the
Dave Love <fx@gnu.org>
parents:
diff changeset
1152 source file retains its name and the result of applying the patch is placed
Dave Love <fx@gnu.org>
parents:
diff changeset
1153 in a temporary file that has the suffix @file{_patched} attached.
Dave Love <fx@gnu.org>
parents:
diff changeset
1154 Generally, this applies to files that are handled using black magic, such
Dave Love <fx@gnu.org>
parents:
diff changeset
1155 as special file handlers (ange-ftp and some compression and encryption
Dave Love <fx@gnu.org>
parents:
diff changeset
1156 packages also use this method).
Dave Love <fx@gnu.org>
parents:
diff changeset
1157
Dave Love <fx@gnu.org>
parents:
diff changeset
1158 Regular files are treated by the @code{patch} utility in the usual manner,
Dave Love <fx@gnu.org>
parents:
diff changeset
1159 i.e., the original is renamed into @file{source-name.orig} and the result
Dave Love <fx@gnu.org>
parents:
diff changeset
1160 of the patch is placed into the file source-name (@file{_orig} is used
Dave Love <fx@gnu.org>
parents:
diff changeset
1161 on systems like VMS, DOS, etc.)
Dave Love <fx@gnu.org>
parents:
diff changeset
1162
Dave Love <fx@gnu.org>
parents:
diff changeset
1163 @node Customization, Credits, Remote and Compressed Files, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
1164 @chapter Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
1165
Dave Love <fx@gnu.org>
parents:
diff changeset
1166 Ediff has a rather self-explanatory interface, and in most cases you
Dave Love <fx@gnu.org>
parents:
diff changeset
1167 won't need to change anything. However, should the need arise, there are
Dave Love <fx@gnu.org>
parents:
diff changeset
1168 extensive facilities for changing the default behavior.
Dave Love <fx@gnu.org>
parents:
diff changeset
1169
Dave Love <fx@gnu.org>
parents:
diff changeset
1170 Most of the customization can be done by setting various variables in the
Dave Love <fx@gnu.org>
parents:
diff changeset
1171 @file{.emacs} file. Some customization (mostly window-related
Dave Love <fx@gnu.org>
parents:
diff changeset
1172 customization and faces) can be done by putting appropriate lines in
Dave Love <fx@gnu.org>
parents:
diff changeset
1173 @file{.Xdefaults}, @file{.xrdb}, or whatever X resource file is in use.
Dave Love <fx@gnu.org>
parents:
diff changeset
1174
Dave Love <fx@gnu.org>
parents:
diff changeset
1175 With respect to the latter, please note that the X resource
Dave Love <fx@gnu.org>
parents:
diff changeset
1176 for Ediff customization is `Ediff', @emph{not} `emacs'.
Dave Love <fx@gnu.org>
parents:
diff changeset
1177 @xref{Window and Frame Configuration},
Dave Love <fx@gnu.org>
parents:
diff changeset
1178 @xref{Highlighting Difference Regions}, for further details. Please also
Dave Love <fx@gnu.org>
parents:
diff changeset
1179 refer to Emacs manual for the information on how to set Emacs X resources.
Dave Love <fx@gnu.org>
parents:
diff changeset
1180
Dave Love <fx@gnu.org>
parents:
diff changeset
1181 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1182 * Hooks:: Customization via the hooks.
Dave Love <fx@gnu.org>
parents:
diff changeset
1183 * Quick Help Customization:: How to customize Ediff's quick help feature.
Dave Love <fx@gnu.org>
parents:
diff changeset
1184 * Window and Frame Configuration:: Controlling the way Ediff displays things.
Dave Love <fx@gnu.org>
parents:
diff changeset
1185 * Selective Browsing:: Advanced browsing through difference regions.
Dave Love <fx@gnu.org>
parents:
diff changeset
1186 * Highlighting Difference Regions:: Controlling highlighting.
Dave Love <fx@gnu.org>
parents:
diff changeset
1187 * Narrowing:: Comparing regions, windows, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
1188 * Refinement of Difference Regions:: How to control the refinement process.
Dave Love <fx@gnu.org>
parents:
diff changeset
1189 * Patch and Diff Programs:: Changing the utilities that compute differences
Dave Love <fx@gnu.org>
parents:
diff changeset
1190 and apply patches.
Dave Love <fx@gnu.org>
parents:
diff changeset
1191 * Merging and diff3:: How to customize Ediff in its Merge Mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
1192 * Support for Version Control:: Changing the version control package.
Dave Love <fx@gnu.org>
parents:
diff changeset
1193 You are not likely to do that.
Dave Love <fx@gnu.org>
parents:
diff changeset
1194 * Customizing the Mode Line:: Changing the look of the mode line in Ediff.
Dave Love <fx@gnu.org>
parents:
diff changeset
1195 * Miscellaneous:: Other customization.
Dave Love <fx@gnu.org>
parents:
diff changeset
1196 * Notes on Heavy-duty Customization:: Customization for the gurus.
Dave Love <fx@gnu.org>
parents:
diff changeset
1197 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1198
Dave Love <fx@gnu.org>
parents:
diff changeset
1199 @node Hooks, Quick Help Customization, Customization, Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
1200 @section Hooks
Dave Love <fx@gnu.org>
parents:
diff changeset
1201
Dave Love <fx@gnu.org>
parents:
diff changeset
1202 The bulk of customization can be done via the following hooks:
Dave Love <fx@gnu.org>
parents:
diff changeset
1203
Dave Love <fx@gnu.org>
parents:
diff changeset
1204 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
1205 @item ediff-load-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1206 @vindex ediff-load-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1207 This hook can be used to change defaults after Ediff is loaded.
Dave Love <fx@gnu.org>
parents:
diff changeset
1208
33019
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
1209 @item ediff-before-setup-hook
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
1210 @vindex ediff-before-setup-hook
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
1211 Hook that is run just before Ediff rearranges windows to its liking.
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
1212 Can be used to save windows configuration.
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
1213
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1214 @item ediff-keymap-setup-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1215 @vindex ediff-keymap-setup-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1216 @vindex ediff-mode-map
Dave Love <fx@gnu.org>
parents:
diff changeset
1217 This hook can be used to alter bindings in Ediff's keymap,
Dave Love <fx@gnu.org>
parents:
diff changeset
1218 @code{ediff-mode-map}. These hooks are
Dave Love <fx@gnu.org>
parents:
diff changeset
1219 run right after the default bindings are set but before
Dave Love <fx@gnu.org>
parents:
diff changeset
1220 @code{ediff-load-hook}. The regular user needs not be concerned with this
Dave Love <fx@gnu.org>
parents:
diff changeset
1221 hook---it is provided for implementors of other Emacs packages built on top
Dave Love <fx@gnu.org>
parents:
diff changeset
1222 of Ediff.
Dave Love <fx@gnu.org>
parents:
diff changeset
1223
Dave Love <fx@gnu.org>
parents:
diff changeset
1224 @item ediff-before-setup-windows-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1225 @itemx ediff-after-setup-windows-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1226 @vindex ediff-before-setup-windows-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1227 @vindex ediff-after-setup-windows-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1228 These two hooks are called before and after Ediff sets up its window
33019
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
1229 configuration. These hooks are run each time Ediff rearranges windows to
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
1230 its liking. This happens whenever it detects that the user changed the
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
1231 windows setup.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1232
Dave Love <fx@gnu.org>
parents:
diff changeset
1233 @item ediff-suspend-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1234 @itemx ediff-quit-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1235 @vindex ediff-suspend-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1236 @vindex ediff-quit-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1237 These two hooks are run when you suspend or quit Ediff. They can be
Dave Love <fx@gnu.org>
parents:
diff changeset
1238 used to set desired window configurations, delete files Ediff didn't
Dave Love <fx@gnu.org>
parents:
diff changeset
1239 want to clean up after exiting, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
1240
Dave Love <fx@gnu.org>
parents:
diff changeset
1241 By default, @code{ediff-quit-hook} holds one hook function,
Dave Love <fx@gnu.org>
parents:
diff changeset
1242 @code{ediff-cleanup-mess}, which cleans after Ediff, as appropriate in
Dave Love <fx@gnu.org>
parents:
diff changeset
1243 most cases. You probably won't want to change it, but you might
Dave Love <fx@gnu.org>
parents:
diff changeset
1244 want to add other hook functions.
Dave Love <fx@gnu.org>
parents:
diff changeset
1245
Dave Love <fx@gnu.org>
parents:
diff changeset
1246 Keep in mind that hooks executing before @code{ediff-cleanup-mess} start
Dave Love <fx@gnu.org>
parents:
diff changeset
1247 in @code{ediff-control-buffer;} they should also leave
Dave Love <fx@gnu.org>
parents:
diff changeset
1248 @code{ediff-control-buffer} as the current buffer when they finish.
Dave Love <fx@gnu.org>
parents:
diff changeset
1249 Hooks that are executed after @code{ediff-cleanup-mess} should expect
Dave Love <fx@gnu.org>
parents:
diff changeset
1250 the current buffer be either buffer A or buffer B.
Dave Love <fx@gnu.org>
parents:
diff changeset
1251 @code{ediff-cleanup-mess} doesn't kill the buffers being compared or
Dave Love <fx@gnu.org>
parents:
diff changeset
1252 merged (see @code{ediff-cleanup-hook}, below).
Dave Love <fx@gnu.org>
parents:
diff changeset
1253
Dave Love <fx@gnu.org>
parents:
diff changeset
1254 @item ediff-cleanup-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1255 @vindex ediff-cleanup-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1256 This hook is run just before @code{ediff-quit-hook}. This is a good
Dave Love <fx@gnu.org>
parents:
diff changeset
1257 place to do various cleanups, such as deleting the variant buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
1258 Ediff provides a function, @code{ediff-janitor}, as one such possible
Dave Love <fx@gnu.org>
parents:
diff changeset
1259 hook, which you can add to @code{ediff-cleanup-hook} with
Dave Love <fx@gnu.org>
parents:
diff changeset
1260 @code{add-hooks}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1261
Dave Love <fx@gnu.org>
parents:
diff changeset
1262 @findex ediff-janitor
Dave Love <fx@gnu.org>
parents:
diff changeset
1263 This function kills buffers A, B, and, possibly, C, if these buffers aren't
Dave Love <fx@gnu.org>
parents:
diff changeset
1264 modified. In merge jobs, buffer C is never deleted. However, the side
Dave Love <fx@gnu.org>
parents:
diff changeset
1265 effect of using this function is that you may not be able to compare the
Dave Love <fx@gnu.org>
parents:
diff changeset
1266 same buffer in two separate Ediff sessions: quitting one of them will
Dave Love <fx@gnu.org>
parents:
diff changeset
1267 delete this buffer in another session as well.
Dave Love <fx@gnu.org>
parents:
diff changeset
1268
Dave Love <fx@gnu.org>
parents:
diff changeset
1269 @item ediff-quit-merge-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1270 @vindex ediff-quit-merge-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1271 @vindex ediff-autostore-merges
Dave Love <fx@gnu.org>
parents:
diff changeset
1272 @findex ediff-maybe-save-and-delete-merge
Dave Love <fx@gnu.org>
parents:
diff changeset
1273 This hook is called when Ediff quits a merge job. By default, the value is
Dave Love <fx@gnu.org>
parents:
diff changeset
1274 @code{ediff-maybe-save-and-delete-merge}, which is a function that attempts
Dave Love <fx@gnu.org>
parents:
diff changeset
1275 to save the merge buffer according to the value of
Dave Love <fx@gnu.org>
parents:
diff changeset
1276 @code{ediff-autostore-merges}, as described later.
Dave Love <fx@gnu.org>
parents:
diff changeset
1277
Dave Love <fx@gnu.org>
parents:
diff changeset
1278 @item ediff-before-setup-control-frame-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1279 @itemx ediff-after-setup-control-frame-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1280 @vindex ediff-before-setup-control-frame-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1281 @vindex ediff-after-setup-control-frame-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1282 These two hooks run before and after Ediff sets up the control frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
1283 They can be used to relocate Ediff control frame when Ediff runs in a
Dave Love <fx@gnu.org>
parents:
diff changeset
1284 multiframe mode (i.e., when the control buffer is in its own dedicated
Dave Love <fx@gnu.org>
parents:
diff changeset
1285 frame). Be aware that many variables that drive Ediff are local to
Dave Love <fx@gnu.org>
parents:
diff changeset
1286 Ediff Control Panel (@code{ediff-control-buffer}), which requires
Dave Love <fx@gnu.org>
parents:
diff changeset
1287 special care in writing these hooks. Take a look at
Dave Love <fx@gnu.org>
parents:
diff changeset
1288 @code{ediff-default-suspend-hook} and @code{ediff-default-quit-hook} to
Dave Love <fx@gnu.org>
parents:
diff changeset
1289 see what's involved.
Dave Love <fx@gnu.org>
parents:
diff changeset
1290
Dave Love <fx@gnu.org>
parents:
diff changeset
1291 @item ediff-startup-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1292 @vindex ediff-startup-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1293 This hook is run at the end of Ediff startup.
Dave Love <fx@gnu.org>
parents:
diff changeset
1294
Dave Love <fx@gnu.org>
parents:
diff changeset
1295 @item ediff-select-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1296 @vindex ediff-select-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1297 This hook is run after Ediff selects the next difference region.
Dave Love <fx@gnu.org>
parents:
diff changeset
1298
Dave Love <fx@gnu.org>
parents:
diff changeset
1299 @item ediff-unselect-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1300 @vindex ediff-unselect-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1301 This hook is run after Ediff unselects the current difference region.
Dave Love <fx@gnu.org>
parents:
diff changeset
1302
Dave Love <fx@gnu.org>
parents:
diff changeset
1303 @item ediff-prepare-buffer-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1304 @vindex ediff-prepare-buffer-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1305 This hook is run for each Ediff buffer (A, B, C) right after the buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1306 is arranged.
Dave Love <fx@gnu.org>
parents:
diff changeset
1307
Dave Love <fx@gnu.org>
parents:
diff changeset
1308 @item ediff-display-help-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1309 @vindex ediff-display-help-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1310 Ediff runs this hook each time after setting up the help message. It
Dave Love <fx@gnu.org>
parents:
diff changeset
1311 can be used to alter the help message for custom packages that run on
Dave Love <fx@gnu.org>
parents:
diff changeset
1312 top of Ediff.
Dave Love <fx@gnu.org>
parents:
diff changeset
1313
Dave Love <fx@gnu.org>
parents:
diff changeset
1314 @item ediff-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1315 @vindex ediff-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1316 This hook is run just after Ediff mode is set up in the control
Dave Love <fx@gnu.org>
parents:
diff changeset
1317 buffer. This is done before any Ediff window is created. You can use it to
Dave Love <fx@gnu.org>
parents:
diff changeset
1318 set local variables that alter the look of the display.
Dave Love <fx@gnu.org>
parents:
diff changeset
1319
Dave Love <fx@gnu.org>
parents:
diff changeset
1320 @item ediff-registry-setup-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1321 @vindex ediff-registry-setup-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1322 Hooks run after setting up the registry for all active Ediff session.
Dave Love <fx@gnu.org>
parents:
diff changeset
1323 @xref{Session Groups}, for details.
33019
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
1324 @item ediff-before-session-group-setup-hook
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
1325 @vindex ediff-before-session-group-setup-hook
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
1326 Hooks run before setting up a control panel for a group of related Ediff
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
1327 sessions. Can be used, for example, to save window configuration to restore
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
1328 later.
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
1329 @item ediff-after-session-group-setup-hook
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
1330 @vindex ediff-after-session-group-setup-hook
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1331 Hooks run after setting up a control panel for a group of related Ediff
Dave Love <fx@gnu.org>
parents:
diff changeset
1332 sessions. @xref{Session Groups}, for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
1333 @item ediff-quit-session-group-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1334 @vindex ediff-quit-session-group-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1335 Hooks run just before exiting a session group.
Dave Love <fx@gnu.org>
parents:
diff changeset
1336 @item ediff-meta-buffer-keymap-setup-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1337 @vindex ediff-meta-buffer-keymap-setup-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1338 @vindex ediff-meta-buffer-map
Dave Love <fx@gnu.org>
parents:
diff changeset
1339 Hooks run just after setting up the @code{ediff-meta-buffer-map} --- the
Dave Love <fx@gnu.org>
parents:
diff changeset
1340 map that controls key bindings in the meta buffer. Since
Dave Love <fx@gnu.org>
parents:
diff changeset
1341 @code{ediff-meta-buffer-map} is a local variable, you can set different
Dave Love <fx@gnu.org>
parents:
diff changeset
1342 bindings for different kinds of meta buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
1343 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1344
Dave Love <fx@gnu.org>
parents:
diff changeset
1345 @node Quick Help Customization, Window and Frame Configuration, Hooks, Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
1346 @section Quick Help Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
1347 @vindex ediff-use-long-help-message
Dave Love <fx@gnu.org>
parents:
diff changeset
1348 @vindex ediff-control-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1349 @vindex ediff-startup-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
1350 @vindex ediff-help-message
Dave Love <fx@gnu.org>
parents:
diff changeset
1351
Dave Love <fx@gnu.org>
parents:
diff changeset
1352 Ediff provides quick help using its control panel window. Since this window
Dave Love <fx@gnu.org>
parents:
diff changeset
1353 takes a fair share of the screen real estate, you can toggle it off by
Dave Love <fx@gnu.org>
parents:
diff changeset
1354 typing @kbd{?}. The control window will then shrink to just one line and a
Dave Love <fx@gnu.org>
parents:
diff changeset
1355 mode line, displaying a short help message.
Dave Love <fx@gnu.org>
parents:
diff changeset
1356
Dave Love <fx@gnu.org>
parents:
diff changeset
1357 The variable @code{ediff-use-long-help-message} tells Ediff whether
Dave Love <fx@gnu.org>
parents:
diff changeset
1358 you use the short message or the long one. By default, it
Dave Love <fx@gnu.org>
parents:
diff changeset
1359 is set to @code{nil}, meaning that the short message is used.
Dave Love <fx@gnu.org>
parents:
diff changeset
1360 Set this to @code{t}, if you want Ediff to use the long
Dave Love <fx@gnu.org>
parents:
diff changeset
1361 message by default. This property can always be changed interactively, by
Dave Love <fx@gnu.org>
parents:
diff changeset
1362 typing @kbd{?} into Ediff Control Buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1363
Dave Love <fx@gnu.org>
parents:
diff changeset
1364 If you want to change the appearance of the help message on a per-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1365 basis, you must use @code{ediff-startup-hook} to change the value of
Dave Love <fx@gnu.org>
parents:
diff changeset
1366 the variable @code{ediff-help-message}, which is local to
Dave Love <fx@gnu.org>
parents:
diff changeset
1367 @code{ediff-control-buffer}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1368
Dave Love <fx@gnu.org>
parents:
diff changeset
1369 @node Window and Frame Configuration, Selective Browsing, Quick Help Customization, Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
1370 @section Window and Frame Configuration
Dave Love <fx@gnu.org>
parents:
diff changeset
1371
Dave Love <fx@gnu.org>
parents:
diff changeset
1372 On a non-windowing display, Ediff sets things up in one frame, splitting
Dave Love <fx@gnu.org>
parents:
diff changeset
1373 it between a small control window and the windows for buffers A, B, and C.
Dave Love <fx@gnu.org>
parents:
diff changeset
1374 The split between these windows can be horizontal or
Dave Love <fx@gnu.org>
parents:
diff changeset
1375 vertical, which can be changed interactively by typing @kbd{|} while the
Dave Love <fx@gnu.org>
parents:
diff changeset
1376 cursor is in the control window.
Dave Love <fx@gnu.org>
parents:
diff changeset
1377
Dave Love <fx@gnu.org>
parents:
diff changeset
1378 On a window display, Ediff sets up a dedicated frame for Ediff Control
Dave Love <fx@gnu.org>
parents:
diff changeset
1379 Panel and then it chooses windows as follows: If one of the buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
1380 is invisible, it is displayed in the currently selected frame. If
Dave Love <fx@gnu.org>
parents:
diff changeset
1381 a buffer is visible, it is displayed in the frame where it is visible.
Dave Love <fx@gnu.org>
parents:
diff changeset
1382 If, according to the above criteria, the two buffers fall into the same
Dave Love <fx@gnu.org>
parents:
diff changeset
1383 frame, then so be it---the frame will be shared by the two. The same
Dave Love <fx@gnu.org>
parents:
diff changeset
1384 algorithm works when you type @kbd{C-l} (@code{ediff-recenter}), @kbd{p}
Dave Love <fx@gnu.org>
parents:
diff changeset
1385 (@code{ediff-previous-difference}), @kbd{n}
Dave Love <fx@gnu.org>
parents:
diff changeset
1386 (@code{ediff-next-difference}), etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
1387
Dave Love <fx@gnu.org>
parents:
diff changeset
1388 The above behavior also depends on whether the current frame is splittable,
Dave Love <fx@gnu.org>
parents:
diff changeset
1389 dedicated, etc. Unfortunately, the margin of this book is too narrow to
Dave Love <fx@gnu.org>
parents:
diff changeset
1390 present the details of this remarkable algorithm.
Dave Love <fx@gnu.org>
parents:
diff changeset
1391
Dave Love <fx@gnu.org>
parents:
diff changeset
1392 The upshot of all this is that you can compare buffers in one frame or
Dave Love <fx@gnu.org>
parents:
diff changeset
1393 in different frames. The former is done by default, while the latter can
Dave Love <fx@gnu.org>
parents:
diff changeset
1394 be achieved by arranging buffers A, B (and C, if applicable) to be seen in
Dave Love <fx@gnu.org>
parents:
diff changeset
1395 different frames. Ediff respects these arrangements, automatically
Dave Love <fx@gnu.org>
parents:
diff changeset
1396 adapting itself to the multi-frame mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
1397
Dave Love <fx@gnu.org>
parents:
diff changeset
1398 Ediff uses the following variables to set up its control panel
Dave Love <fx@gnu.org>
parents:
diff changeset
1399 (a.k.a.@: control buffer, a.k.a.@: quick help window):
Dave Love <fx@gnu.org>
parents:
diff changeset
1400
Dave Love <fx@gnu.org>
parents:
diff changeset
1401 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
1402 @item ediff-control-frame-parameters
Dave Love <fx@gnu.org>
parents:
diff changeset
1403 @vindex ediff-control-frame-parameters
Dave Love <fx@gnu.org>
parents:
diff changeset
1404 You can change or augment this variable including the font, color,
Dave Love <fx@gnu.org>
parents:
diff changeset
1405 etc. The X resource name of Ediff Control Panel frames is @samp{Ediff}. Under
Dave Love <fx@gnu.org>
parents:
diff changeset
1406 X-windows, you can use this name to set up preferences in your
Dave Love <fx@gnu.org>
parents:
diff changeset
1407 @file{~/.Xdefaults}, @file{~/.xrdb}, or whatever X resource file is in
Dave Love <fx@gnu.org>
parents:
diff changeset
1408 use. Usually this is preferable to changing
Dave Love <fx@gnu.org>
parents:
diff changeset
1409 @code{ediff-control-frame-parameters} directly. For instance, you can
Dave Love <fx@gnu.org>
parents:
diff changeset
1410 specify in @file{~/.Xdefaults} the color of the control frame
Dave Love <fx@gnu.org>
parents:
diff changeset
1411 using the resource @samp{Ediff*background}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1412
Dave Love <fx@gnu.org>
parents:
diff changeset
1413 In general, any X resource pertaining the control frame can be reached
Dave Love <fx@gnu.org>
parents:
diff changeset
1414 via the prefix @code{Ediff*}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1415
Dave Love <fx@gnu.org>
parents:
diff changeset
1416 @item ediff-control-frame-position-function
Dave Love <fx@gnu.org>
parents:
diff changeset
1417 @vindex ediff-control-frame-position-function
Dave Love <fx@gnu.org>
parents:
diff changeset
1418 The preferred way of specifying the position of the control frame is by
Dave Love <fx@gnu.org>
parents:
diff changeset
1419 setting the variable @code{ediff-control-frame-position-function} to an
Dave Love <fx@gnu.org>
parents:
diff changeset
1420 appropriate function.
Dave Love <fx@gnu.org>
parents:
diff changeset
1421 The default value of this variable is
Dave Love <fx@gnu.org>
parents:
diff changeset
1422 @code{ediff-make-frame-position}. This function places the control frame in
Dave Love <fx@gnu.org>
parents:
diff changeset
1423 the vicinity of the North-East corner of the frame displaying buffer A.
Dave Love <fx@gnu.org>
parents:
diff changeset
1424
Dave Love <fx@gnu.org>
parents:
diff changeset
1425 @findex ediff-make-frame-position
Dave Love <fx@gnu.org>
parents:
diff changeset
1426 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1427
Dave Love <fx@gnu.org>
parents:
diff changeset
1428 The following variables can be used to adjust the location produced by
Dave Love <fx@gnu.org>
parents:
diff changeset
1429 @code{ediff-make-frame-position} and for related customization.
Dave Love <fx@gnu.org>
parents:
diff changeset
1430
Dave Love <fx@gnu.org>
parents:
diff changeset
1431 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
1432 @item ediff-narrow-control-frame-leftward-shift
Dave Love <fx@gnu.org>
parents:
diff changeset
1433 @vindex ediff-narrow-control-frame-leftward-shift
Dave Love <fx@gnu.org>
parents:
diff changeset
1434 Specifies the number of characters for shifting
Dave Love <fx@gnu.org>
parents:
diff changeset
1435 the control frame from the rightmost edge of frame A when the control
Dave Love <fx@gnu.org>
parents:
diff changeset
1436 frame is displayed as a small window.
Dave Love <fx@gnu.org>
parents:
diff changeset
1437
Dave Love <fx@gnu.org>
parents:
diff changeset
1438 @item ediff-wide-control-frame-rightward-shift
Dave Love <fx@gnu.org>
parents:
diff changeset
1439 @vindex ediff-wide-control-frame-rightward-shift
Dave Love <fx@gnu.org>
parents:
diff changeset
1440 Specifies the rightward shift of the control frame
Dave Love <fx@gnu.org>
parents:
diff changeset
1441 from the left edge of frame A when the control frame shows the full
Dave Love <fx@gnu.org>
parents:
diff changeset
1442 menu of options.
Dave Love <fx@gnu.org>
parents:
diff changeset
1443
Dave Love <fx@gnu.org>
parents:
diff changeset
1444 @item ediff-control-frame-upward-shift
Dave Love <fx@gnu.org>
parents:
diff changeset
1445 @vindex ediff-control-frame-upward-shift
Dave Love <fx@gnu.org>
parents:
diff changeset
1446 Specifies the number of pixels for the upward shift
Dave Love <fx@gnu.org>
parents:
diff changeset
1447 of the control frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
1448
Dave Love <fx@gnu.org>
parents:
diff changeset
1449 @item ediff-prefer-iconified-control-frame
Dave Love <fx@gnu.org>
parents:
diff changeset
1450 @vindex ediff-prefer-iconified-control-frame
Dave Love <fx@gnu.org>
parents:
diff changeset
1451 If this variable is @code{t}, the control frame becomes iconified
Dave Love <fx@gnu.org>
parents:
diff changeset
1452 automatically when you toggle the quick help message off. This saves
Dave Love <fx@gnu.org>
parents:
diff changeset
1453 valuable real estate on the screen. Toggling help back will deiconify
Dave Love <fx@gnu.org>
parents:
diff changeset
1454 the control frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
1455
Dave Love <fx@gnu.org>
parents:
diff changeset
1456 To start Ediff with an iconified Control Panel, you should set this
Dave Love <fx@gnu.org>
parents:
diff changeset
1457 variable to @code{t} and @code{ediff-prefer-long-help-message} to
Dave Love <fx@gnu.org>
parents:
diff changeset
1458 @code{nil} (@pxref{Quick Help Customization}). This behavior is useful
71224
b7261e09f8e4 * cc-mode.texi (Getting Started, Indentation Commands, Config Basics)
Romain Francoise <romain@orebokech.com>
parents: 71118
diff changeset
1459 only if icons are allowed to accept keyboard input (which depends on the
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
1460 window manager and other factors).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1461 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1462
Dave Love <fx@gnu.org>
parents:
diff changeset
1463 @findex ediff-setup-windows
Dave Love <fx@gnu.org>
parents:
diff changeset
1464 To make more creative changes in the way Ediff sets up windows, you can
Dave Love <fx@gnu.org>
parents:
diff changeset
1465 rewrite the function @code{ediff-setup-windows}. However, we believe
Dave Love <fx@gnu.org>
parents:
diff changeset
1466 that detaching Ediff Control Panel from the rest and making it into a
Dave Love <fx@gnu.org>
parents:
diff changeset
1467 separate frame offers an important opportunity by allowing you to
Dave Love <fx@gnu.org>
parents:
diff changeset
1468 iconify that frame. The icon will usually accept all of the Ediff
Dave Love <fx@gnu.org>
parents:
diff changeset
1469 commands, but will free up valuable real estate on your screen (this may
Dave Love <fx@gnu.org>
parents:
diff changeset
1470 depend on your window manager, though).
Dave Love <fx@gnu.org>
parents:
diff changeset
1471
Dave Love <fx@gnu.org>
parents:
diff changeset
1472 The following variable controls how windows are set up:
Dave Love <fx@gnu.org>
parents:
diff changeset
1473
Dave Love <fx@gnu.org>
parents:
diff changeset
1474 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
1475 @item ediff-window-setup-function
Dave Love <fx@gnu.org>
parents:
diff changeset
1476 @vindex ediff-window-setup-function
Dave Love <fx@gnu.org>
parents:
diff changeset
1477 The multiframe setup is done by the
Dave Love <fx@gnu.org>
parents:
diff changeset
1478 @code{ediff-setup-windows-multiframe} function, which is the default on
Dave Love <fx@gnu.org>
parents:
diff changeset
1479 windowing displays. The plain setup, one where all windows are always
Dave Love <fx@gnu.org>
parents:
diff changeset
1480 in one frame, is done by @code{ediff-setup-windows-plain}, which is the
Dave Love <fx@gnu.org>
parents:
diff changeset
1481 default on a non-windowing display (or in an xterm window). In fact,
Dave Love <fx@gnu.org>
parents:
diff changeset
1482 under Emacs, you can switch freely between these two setups by executing
Dave Love <fx@gnu.org>
parents:
diff changeset
1483 the command @code{ediff-toggle-multiframe} using the Minibuffer of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1484 Menubar.
Dave Love <fx@gnu.org>
parents:
diff changeset
1485 @findex ediff-setup-windows-multiframe
Dave Love <fx@gnu.org>
parents:
diff changeset
1486 @findex ediff-setup-windows-plain
Dave Love <fx@gnu.org>
parents:
diff changeset
1487 @findex ediff-toggle-multiframe
Dave Love <fx@gnu.org>
parents:
diff changeset
1488
Dave Love <fx@gnu.org>
parents:
diff changeset
1489 If you don't like any of these setups, write your own function. See the
Dave Love <fx@gnu.org>
parents:
diff changeset
1490 documentation for @code{ediff-window-setup-function} for the basic
Dave Love <fx@gnu.org>
parents:
diff changeset
1491 guidelines. However, writing window setups is not easy, so you should
Dave Love <fx@gnu.org>
parents:
diff changeset
1492 first take a close look at @code{ediff-setup-windows-plain} and
Dave Love <fx@gnu.org>
parents:
diff changeset
1493 @code{ediff-setup-windows-multiframe}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1494 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1495
Dave Love <fx@gnu.org>
parents:
diff changeset
1496 You can run multiple Ediff sessions at once, by invoking Ediff several
Dave Love <fx@gnu.org>
parents:
diff changeset
1497 times without exiting previous Ediff sessions. Different sessions
Dave Love <fx@gnu.org>
parents:
diff changeset
1498 may even operate on the same pair of files.
Dave Love <fx@gnu.org>
parents:
diff changeset
1499
Dave Love <fx@gnu.org>
parents:
diff changeset
1500 Each session has its own Ediff Control Panel and all the regarding a
Dave Love <fx@gnu.org>
parents:
diff changeset
1501 particular session is local to the associated control panel buffer. You
Dave Love <fx@gnu.org>
parents:
diff changeset
1502 can switch between sessions by suspending one session and then switching
Dave Love <fx@gnu.org>
parents:
diff changeset
1503 to another control panel. (Different control panel buffers are
Dave Love <fx@gnu.org>
parents:
diff changeset
1504 distinguished by a numerical suffix, e.g., @samp{Ediff Control Panel<3>}.)
Dave Love <fx@gnu.org>
parents:
diff changeset
1505
Dave Love <fx@gnu.org>
parents:
diff changeset
1506 @node Selective Browsing, Highlighting Difference Regions, Window and Frame Configuration, Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
1507 @section Selective Browsing
Dave Love <fx@gnu.org>
parents:
diff changeset
1508
Dave Love <fx@gnu.org>
parents:
diff changeset
1509 Sometimes it is convenient to be able to step through only some difference
Dave Love <fx@gnu.org>
parents:
diff changeset
1510 regions, those that match certain regular expressions, and to ignore all
Dave Love <fx@gnu.org>
parents:
diff changeset
1511 others. On other occasions, you may want to ignore difference regions that
Dave Love <fx@gnu.org>
parents:
diff changeset
1512 match some regular expressions, and to look only at the rest.
Dave Love <fx@gnu.org>
parents:
diff changeset
1513
Dave Love <fx@gnu.org>
parents:
diff changeset
1514 The commands @kbd{#f} and @kbd{#h} let you do precisely this.
Dave Love <fx@gnu.org>
parents:
diff changeset
1515
Dave Love <fx@gnu.org>
parents:
diff changeset
1516 Typing @kbd{#f} lets you specify regular expressions that match difference
Dave Love <fx@gnu.org>
parents:
diff changeset
1517 regions you want to focus on.
Dave Love <fx@gnu.org>
parents:
diff changeset
1518 We shall call these regular expressions @var{regexp-A}, @var{regexp-B} and
Dave Love <fx@gnu.org>
parents:
diff changeset
1519 @var{regexp-C}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1520 Ediff will then start stepping through only those difference regions
Dave Love <fx@gnu.org>
parents:
diff changeset
1521 where the region in buffer A matches @var{regexp-A} and/or the region in
Dave Love <fx@gnu.org>
parents:
diff changeset
1522 buffer B matches @var{regexp-B}, etc. Whether `and' or `or' will be used
Dave Love <fx@gnu.org>
parents:
diff changeset
1523 depends on how you respond to a question.
Dave Love <fx@gnu.org>
parents:
diff changeset
1524
Dave Love <fx@gnu.org>
parents:
diff changeset
1525 When scanning difference regions for the aforesaid regular expressions,
Dave Love <fx@gnu.org>
parents:
diff changeset
1526 Ediff narrows the buffers to those regions. This means that you can use
Dave Love <fx@gnu.org>
parents:
diff changeset
1527 the expressions @kbd{\`} and @kbd{\'} to tie search to the beginning or end
Dave Love <fx@gnu.org>
parents:
diff changeset
1528 of the difference regions.
Dave Love <fx@gnu.org>
parents:
diff changeset
1529
Dave Love <fx@gnu.org>
parents:
diff changeset
1530 On the other hand, typing @kbd{#h} lets you specify (hide) uninteresting
Dave Love <fx@gnu.org>
parents:
diff changeset
1531 regions. That is, if a difference region in buffer A matches
Dave Love <fx@gnu.org>
parents:
diff changeset
1532 @var{regexp-A}, the corresponding region in buffer B matches @var{regexp-B}
Dave Love <fx@gnu.org>
parents:
diff changeset
1533 and (if applicable) buffer C's region matches @var{regexp-C}, then the
Dave Love <fx@gnu.org>
parents:
diff changeset
1534 region will be ignored by the commands @kbd{n}/@key{SPC}
Dave Love <fx@gnu.org>
parents:
diff changeset
1535 (@code{ediff-next-difference}) and @kbd{p}/@key{DEL}
Dave Love <fx@gnu.org>
parents:
diff changeset
1536 (@code{ediff-previous-difference}) commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
1537
Dave Love <fx@gnu.org>
parents:
diff changeset
1538 Typing @kbd{#f} and @kbd{#h} toggles selective browsing on and off.
Dave Love <fx@gnu.org>
parents:
diff changeset
1539
Dave Love <fx@gnu.org>
parents:
diff changeset
1540 Note that selective browsing affects only @code{ediff-next-difference}
Dave Love <fx@gnu.org>
parents:
diff changeset
1541 and @code{ediff-previous-difference}, i.e., the commands
Dave Love <fx@gnu.org>
parents:
diff changeset
1542 @kbd{n}/@key{SPC} and @kbd{p}/@key{DEL}. @kbd{#f} and @kbd{#h} do not
Dave Love <fx@gnu.org>
parents:
diff changeset
1543 change the position of the point in the buffers. And you can still jump
Dave Love <fx@gnu.org>
parents:
diff changeset
1544 directly (using @kbd{j}) to any numbered
Dave Love <fx@gnu.org>
parents:
diff changeset
1545 difference.
Dave Love <fx@gnu.org>
parents:
diff changeset
1546
Dave Love <fx@gnu.org>
parents:
diff changeset
1547 Users can supply their own functions to specify how Ediff should do
Dave Love <fx@gnu.org>
parents:
diff changeset
1548 selective browsing. To change the default Ediff function, add a function to
Dave Love <fx@gnu.org>
parents:
diff changeset
1549 @code{ediff-load-hook} which will do the following assignments:
Dave Love <fx@gnu.org>
parents:
diff changeset
1550
Dave Love <fx@gnu.org>
parents:
diff changeset
1551 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1552 (setq ediff-hide-regexp-matches-function 'your-hide-function)
Dave Love <fx@gnu.org>
parents:
diff changeset
1553 (setq ediff-focus-on-regexp-matches-function 'your-focus-function)
Dave Love <fx@gnu.org>
parents:
diff changeset
1554 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1555
Dave Love <fx@gnu.org>
parents:
diff changeset
1556 @strong{Useful hint}: To specify a regexp that matches everything, don't
Dave Love <fx@gnu.org>
parents:
diff changeset
1557 simply type @key{RET} in response to a prompt. Typing @key{RET} tells Ediff
Dave Love <fx@gnu.org>
parents:
diff changeset
1558 to accept the default value, which may not be what you want. Instead, you
Dave Love <fx@gnu.org>
parents:
diff changeset
1559 should enter something like @key{^} or @key{$}. These match every
Dave Love <fx@gnu.org>
parents:
diff changeset
1560 line.
Dave Love <fx@gnu.org>
parents:
diff changeset
1561
Dave Love <fx@gnu.org>
parents:
diff changeset
1562 You can use the status command, @kbd{i}, to find out whether
Dave Love <fx@gnu.org>
parents:
diff changeset
1563 selective browsing is currently in effect.
Dave Love <fx@gnu.org>
parents:
diff changeset
1564
Dave Love <fx@gnu.org>
parents:
diff changeset
1565 The regular expressions you specified are kept in the local variables
Dave Love <fx@gnu.org>
parents:
diff changeset
1566 @code{ediff-regexp-focus-A}, @code{ediff-regexp-focus-B},
Dave Love <fx@gnu.org>
parents:
diff changeset
1567 @code{ediff-regexp-focus-C}, @code{ediff-regexp-hide-A},
Dave Love <fx@gnu.org>
parents:
diff changeset
1568 @code{ediff-regexp-hide-B}, @code{ediff-regexp-hide-C}. Their default value
Dave Love <fx@gnu.org>
parents:
diff changeset
1569 is the empty string (i.e., nothing is hidden or focused on). To change the
Dave Love <fx@gnu.org>
parents:
diff changeset
1570 default, set these variables in @file{.emacs} using @code{setq-default}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1571
Dave Love <fx@gnu.org>
parents:
diff changeset
1572 In addition to the ability to ignore regions that match regular
Dave Love <fx@gnu.org>
parents:
diff changeset
1573 expressions, Ediff can be ordered to start skipping over certain
Dave Love <fx@gnu.org>
parents:
diff changeset
1574 ``uninteresting'' difference regions. This is controlled by the following
Dave Love <fx@gnu.org>
parents:
diff changeset
1575 variable:
Dave Love <fx@gnu.org>
parents:
diff changeset
1576
Dave Love <fx@gnu.org>
parents:
diff changeset
1577 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
1578 @item ediff-ignore-similar-regions
Dave Love <fx@gnu.org>
parents:
diff changeset
1579 @vindex ediff-ignore-similar-regions
Dave Love <fx@gnu.org>
parents:
diff changeset
1580 If @code{t}, causes Ediff to skip over "uninteresting" difference regions,
Dave Love <fx@gnu.org>
parents:
diff changeset
1581 which are the regions where the variants differ only in the amount of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1582 white space and newlines. This feature can be toggled on/off interactively,
Dave Love <fx@gnu.org>
parents:
diff changeset
1583 via the command @kbd{##}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1584 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1585
52704
980a04480377 Fix @strong{Note:}.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1586 @strong{Please note:} in order for this feature to work, auto-refining of
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1587 difference regions must be on, since otherwise Ediff won't know if there
Dave Love <fx@gnu.org>
parents:
diff changeset
1588 are fine differences between regions. On devices where Emacs can display
Dave Love <fx@gnu.org>
parents:
diff changeset
1589 faces, auto-refining is a default, but it is not turned on by default on
Dave Love <fx@gnu.org>
parents:
diff changeset
1590 text-only terminals. In that case, you must explicitly turn auto-refining
Dave Love <fx@gnu.org>
parents:
diff changeset
1591 on (such as, by typing @kbd{@@}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1592
Dave Love <fx@gnu.org>
parents:
diff changeset
1593 @strong{Reassurance:} If many such uninteresting regions appear in a row,
Dave Love <fx@gnu.org>
parents:
diff changeset
1594 Ediff may take a long time to skip over them because it has to compute fine
Dave Love <fx@gnu.org>
parents:
diff changeset
1595 differences of all intermediate regions. This delay does not indicate any
Dave Love <fx@gnu.org>
parents:
diff changeset
1596 problem.
Dave Love <fx@gnu.org>
parents:
diff changeset
1597
68997
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1598 @vindex ediff-ignore-case-option
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1599 @vindex ediff-ignore-case-option3
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1600 @vindex ediff-ignore-case
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1601 Finally, Ediff can be told to ignore the case of the letters. This behavior
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1602 can be toggled with @kbd{#c} and it is controlled with three variables:
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1603 @code{ediff-ignore-case-option}, @code{ediff-ignore-case-option3}, and
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1604 @code{ediff-ignore-case}.
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1605
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1606 The variable @code{ediff-ignore-case-option} specifies the option to pass
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1607 to the diff program for comparing two files or buffers. For GNU
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1608 @code{diff}, this option is @code{"-i"}. The variable
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1609 @code{ediff-ignore-case-option3} specifies the option to pass to the
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1610 @code{diff3} program in order to make it case-insensitive. GNU @code{diff3}
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1611 does not have such an option, so when merging or comparing three files with
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1612 this program, ignoring the letter case is not supported.
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1613
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1614 The variable @code{ediff-ignore-case} controls whether Ediff starts out by
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1615 ignoring letter case or not. It can be set in @file{.emacs} using
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1616 @code{setq-default}.
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
1617
71383
4a969fe4cb19 2006-06-18 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 71224
diff changeset
1618 When case sensitivity is toggled, all difference
4a969fe4cb19 2006-06-18 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 71224
diff changeset
1619 regions are recomputed.
4a969fe4cb19 2006-06-18 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 71224
diff changeset
1620
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1621 @node Highlighting Difference Regions, Narrowing, Selective Browsing, Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
1622 @section Highlighting Difference Regions
Dave Love <fx@gnu.org>
parents:
diff changeset
1623
Dave Love <fx@gnu.org>
parents:
diff changeset
1624 The following variables control the way Ediff highlights difference
Dave Love <fx@gnu.org>
parents:
diff changeset
1625 regions:
Dave Love <fx@gnu.org>
parents:
diff changeset
1626
Dave Love <fx@gnu.org>
parents:
diff changeset
1627 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
1628 @item ediff-before-flag-bol
Dave Love <fx@gnu.org>
parents:
diff changeset
1629 @itemx ediff-after-flag-eol
Dave Love <fx@gnu.org>
parents:
diff changeset
1630 @itemx ediff-before-flag-mol
Dave Love <fx@gnu.org>
parents:
diff changeset
1631 @itemx ediff-after-flag-mol
Dave Love <fx@gnu.org>
parents:
diff changeset
1632 @vindex ediff-before-flag-bol
Dave Love <fx@gnu.org>
parents:
diff changeset
1633 @vindex ediff-after-flag-eol
Dave Love <fx@gnu.org>
parents:
diff changeset
1634 @vindex ediff-before-flag-mol
Dave Love <fx@gnu.org>
parents:
diff changeset
1635 @vindex ediff-after-flag-mol
Dave Love <fx@gnu.org>
parents:
diff changeset
1636 These variables hold strings that Ediff uses to mark the beginning and the
Dave Love <fx@gnu.org>
parents:
diff changeset
1637 end of the differences found in files A, B, and C on devices where Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
1638 cannot display faces. Ediff uses different flags to highlight regions that
Dave Love <fx@gnu.org>
parents:
diff changeset
1639 begin/end at the beginning/end of a line or in a middle of a line.
Dave Love <fx@gnu.org>
parents:
diff changeset
1640
Dave Love <fx@gnu.org>
parents:
diff changeset
1641 @item ediff-current-diff-face-A
Dave Love <fx@gnu.org>
parents:
diff changeset
1642 @itemx ediff-current-diff-face-B
Dave Love <fx@gnu.org>
parents:
diff changeset
1643 @itemx ediff-current-diff-face-C
Dave Love <fx@gnu.org>
parents:
diff changeset
1644 @vindex ediff-current-diff-face-A
Dave Love <fx@gnu.org>
parents:
diff changeset
1645 @vindex ediff-current-diff-face-B
Dave Love <fx@gnu.org>
parents:
diff changeset
1646 @vindex ediff-current-diff-face-C
Dave Love <fx@gnu.org>
parents:
diff changeset
1647 Ediff uses these faces to highlight current differences on devices where
Dave Love <fx@gnu.org>
parents:
diff changeset
1648 Emacs can display faces. These and subsequently described faces can be set
Dave Love <fx@gnu.org>
parents:
diff changeset
1649 either in @file{.emacs} or in @file{.Xdefaults}. The X resource for Ediff
Dave Love <fx@gnu.org>
parents:
diff changeset
1650 is @samp{Ediff}, @emph{not} @samp{emacs}. Please refer to Emacs manual for
Dave Love <fx@gnu.org>
parents:
diff changeset
1651 the information on how to set X resources.
Dave Love <fx@gnu.org>
parents:
diff changeset
1652 @item ediff-fine-diff-face-A
Dave Love <fx@gnu.org>
parents:
diff changeset
1653 @itemx ediff-fine-diff-face-B
Dave Love <fx@gnu.org>
parents:
diff changeset
1654 @itemx ediff-fine-diff-face-C
Dave Love <fx@gnu.org>
parents:
diff changeset
1655 @vindex ediff-fine-diff-face-A
Dave Love <fx@gnu.org>
parents:
diff changeset
1656 @vindex ediff-fine-diff-face-B
Dave Love <fx@gnu.org>
parents:
diff changeset
1657 @vindex ediff-fine-diff-face-C
Dave Love <fx@gnu.org>
parents:
diff changeset
1658 Ediff uses these faces to show the fine differences between the current
Dave Love <fx@gnu.org>
parents:
diff changeset
1659 differences regions in buffers A, B, and C, respectively.
Dave Love <fx@gnu.org>
parents:
diff changeset
1660
Dave Love <fx@gnu.org>
parents:
diff changeset
1661 @item ediff-even-diff-face-A
Dave Love <fx@gnu.org>
parents:
diff changeset
1662 @itemx ediff-even-diff-face-B
Dave Love <fx@gnu.org>
parents:
diff changeset
1663 @itemx ediff-even-diff-face-C
Dave Love <fx@gnu.org>
parents:
diff changeset
1664 @itemx ediff-odd-diff-face-A
Dave Love <fx@gnu.org>
parents:
diff changeset
1665 @itemx ediff-odd-diff-face-B
Dave Love <fx@gnu.org>
parents:
diff changeset
1666 @itemx ediff-odd-diff-face-C
Dave Love <fx@gnu.org>
parents:
diff changeset
1667 @vindex ediff-even-diff-face-A
Dave Love <fx@gnu.org>
parents:
diff changeset
1668 @vindex ediff-even-diff-face-B
Dave Love <fx@gnu.org>
parents:
diff changeset
1669 @vindex ediff-even-diff-face-C
Dave Love <fx@gnu.org>
parents:
diff changeset
1670 @vindex ediff-odd-diff-face-A
Dave Love <fx@gnu.org>
parents:
diff changeset
1671 @vindex ediff-odd-diff-face-B
Dave Love <fx@gnu.org>
parents:
diff changeset
1672 @vindex ediff-odd-diff-face-C
Dave Love <fx@gnu.org>
parents:
diff changeset
1673 Non-current difference regions are displayed using these alternating
Dave Love <fx@gnu.org>
parents:
diff changeset
1674 faces. The odd and the even faces are actually identical on monochrome
Dave Love <fx@gnu.org>
parents:
diff changeset
1675 displays, because without colors options are limited.
Dave Love <fx@gnu.org>
parents:
diff changeset
1676 So, Ediff uses italics to highlight non-current differences.
Dave Love <fx@gnu.org>
parents:
diff changeset
1677
Dave Love <fx@gnu.org>
parents:
diff changeset
1678 @item ediff-force-faces
Dave Love <fx@gnu.org>
parents:
diff changeset
1679 @vindex ediff-force-faces
Dave Love <fx@gnu.org>
parents:
diff changeset
1680 Ediff generally can detect when Emacs is running on a device where it can
Dave Love <fx@gnu.org>
parents:
diff changeset
1681 use highlighting with faces. However, if it fails to determine that faces
Dave Love <fx@gnu.org>
parents:
diff changeset
1682 can be used, the user can set this variable to @code{t} to make sure that
Dave Love <fx@gnu.org>
parents:
diff changeset
1683 Ediff uses faces to highlight differences.
Dave Love <fx@gnu.org>
parents:
diff changeset
1684
Dave Love <fx@gnu.org>
parents:
diff changeset
1685 @item ediff-highlight-all-diffs
Dave Love <fx@gnu.org>
parents:
diff changeset
1686 @vindex ediff-highlight-all-diffs
71224
b7261e09f8e4 * cc-mode.texi (Getting Started, Indentation Commands, Config Basics)
Romain Francoise <romain@orebokech.com>
parents: 71118
diff changeset
1687 Indicates whether---on a windowing display---Ediff should highlight
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1688 differences using inserted strings (as on text-only terminals) or using
Dave Love <fx@gnu.org>
parents:
diff changeset
1689 colors and highlighting. Normally, Ediff highlights all differences, but
Dave Love <fx@gnu.org>
parents:
diff changeset
1690 the selected difference is highlighted more visibly. One can cycle through
Dave Love <fx@gnu.org>
parents:
diff changeset
1691 various modes of highlighting by typing @kbd{h}. By default, Ediff starts
Dave Love <fx@gnu.org>
parents:
diff changeset
1692 in the mode where all difference regions are highlighted. If you prefer to
Dave Love <fx@gnu.org>
parents:
diff changeset
1693 start in the mode where unselected differences are not highlighted, you
Dave Love <fx@gnu.org>
parents:
diff changeset
1694 should set @code{ediff-highlight-all-diffs} to @code{nil}. Type @kbd{h} to
Dave Love <fx@gnu.org>
parents:
diff changeset
1695 restore highlighting for all differences.
Dave Love <fx@gnu.org>
parents:
diff changeset
1696
Dave Love <fx@gnu.org>
parents:
diff changeset
1697 Ediff lets you switch between the two modes of highlighting. That is,
Dave Love <fx@gnu.org>
parents:
diff changeset
1698 you can switch interactively from highlighting using faces to
Dave Love <fx@gnu.org>
parents:
diff changeset
1699 highlighting using string flags, and back. Of course, switching has
Dave Love <fx@gnu.org>
parents:
diff changeset
1700 effect only under a windowing system. On a text-only terminal or in an
Dave Love <fx@gnu.org>
parents:
diff changeset
1701 xterm window, the only available option is highlighting with strings.
Dave Love <fx@gnu.org>
parents:
diff changeset
1702 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1703
Dave Love <fx@gnu.org>
parents:
diff changeset
1704 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1705 If you want to change the default settings for @code{ediff-force-faces} and
Dave Love <fx@gnu.org>
parents:
diff changeset
1706 @code{ediff-highlight-all-diffs}, you must do it @strong{before} Ediff is
Dave Love <fx@gnu.org>
parents:
diff changeset
1707 loaded.
Dave Love <fx@gnu.org>
parents:
diff changeset
1708
Dave Love <fx@gnu.org>
parents:
diff changeset
1709 You can also change the defaults for the faces used to highlight the
Dave Love <fx@gnu.org>
parents:
diff changeset
1710 difference regions. There are two ways to do this. The simplest and the
Dave Love <fx@gnu.org>
parents:
diff changeset
1711 preferred way is to use the customization widget accessible from the
Dave Love <fx@gnu.org>
parents:
diff changeset
1712 menubar. Ediff's customization group is located under "Tools", which in
Dave Love <fx@gnu.org>
parents:
diff changeset
1713 turn is under "Programming". The faces that are used to highlight
Dave Love <fx@gnu.org>
parents:
diff changeset
1714 difference regions are located in the "Highlighting" subgroup of the Ediff
Dave Love <fx@gnu.org>
parents:
diff changeset
1715 customization group.
Dave Love <fx@gnu.org>
parents:
diff changeset
1716
Dave Love <fx@gnu.org>
parents:
diff changeset
1717 The second, much more arcane, method to change default faces is to include
Dave Love <fx@gnu.org>
parents:
diff changeset
1718 some Lisp code in @file{~/.emacs}. For instance,
Dave Love <fx@gnu.org>
parents:
diff changeset
1719
Dave Love <fx@gnu.org>
parents:
diff changeset
1720 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1721 (setq ediff-current-diff-face-A
Dave Love <fx@gnu.org>
parents:
diff changeset
1722 (copy-face 'bold-italic 'ediff-current-diff-face-A))
Dave Love <fx@gnu.org>
parents:
diff changeset
1723 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1724
Dave Love <fx@gnu.org>
parents:
diff changeset
1725 @noindent
71224
b7261e09f8e4 * cc-mode.texi (Getting Started, Indentation Commands, Config Basics)
Romain Francoise <romain@orebokech.com>
parents: 71118
diff changeset
1726 would use the pre-defined face @code{bold-italic} to highlight the current
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1727 difference region in buffer A (this face is not a good choice, by the way).
Dave Love <fx@gnu.org>
parents:
diff changeset
1728
Dave Love <fx@gnu.org>
parents:
diff changeset
1729 If you are unhappy with just @emph{some} of the aspects of the default
Dave Love <fx@gnu.org>
parents:
diff changeset
1730 faces, you can modify them when Ediff is being loaded using
Dave Love <fx@gnu.org>
parents:
diff changeset
1731 @code{ediff-load-hook}. For instance:
Dave Love <fx@gnu.org>
parents:
diff changeset
1732
Dave Love <fx@gnu.org>
parents:
diff changeset
1733 @smallexample
Dave Love <fx@gnu.org>
parents:
diff changeset
1734 (add-hook 'ediff-load-hook
28344
54fda0e8528a Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 26639
diff changeset
1735 (lambda ()
54fda0e8528a Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 26639
diff changeset
1736 (set-face-foreground
54fda0e8528a Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 26639
diff changeset
1737 ediff-current-diff-face-B "blue")
54fda0e8528a Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 26639
diff changeset
1738 (set-face-background
54fda0e8528a Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 26639
diff changeset
1739 ediff-current-diff-face-B "red")
54fda0e8528a Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 26639
diff changeset
1740 (make-face-italic
54fda0e8528a Weed out redundant uses of `function'
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 26639
diff changeset
1741 ediff-current-diff-face-B)))
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1742 @end smallexample
Dave Love <fx@gnu.org>
parents:
diff changeset
1743
52704
980a04480377 Fix @strong{Note:}.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1744 @strong{Please note:} to set Ediff's faces, use only @code{copy-face}
980a04480377 Fix @strong{Note:}.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1745 or @code{set/make-face-@dots{}} as shown above. Emacs' low-level
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
1746 face-manipulation functions should be avoided.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1747
Dave Love <fx@gnu.org>
parents:
diff changeset
1748 @node Narrowing, Refinement of Difference Regions, Highlighting Difference Regions, Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
1749 @section Narrowing
Dave Love <fx@gnu.org>
parents:
diff changeset
1750
Dave Love <fx@gnu.org>
parents:
diff changeset
1751 If buffers being compared are narrowed at the time of invocation of
Dave Love <fx@gnu.org>
parents:
diff changeset
1752 Ediff, @code{ediff-buffers} will preserve the narrowing range. However,
Dave Love <fx@gnu.org>
parents:
diff changeset
1753 if @code{ediff-files} is invoked on the files visited by these buffers,
Dave Love <fx@gnu.org>
parents:
diff changeset
1754 that would widen the buffers, since this command is defined to compare the
Dave Love <fx@gnu.org>
parents:
diff changeset
1755 entire files.
Dave Love <fx@gnu.org>
parents:
diff changeset
1756
Dave Love <fx@gnu.org>
parents:
diff changeset
1757 Calling @code{ediff-regions-linewise} or @code{ediff-windows-linewise}, or
Dave Love <fx@gnu.org>
parents:
diff changeset
1758 the corresponding @samp{-wordwise} commands, narrows the variants to the
Dave Love <fx@gnu.org>
parents:
diff changeset
1759 particular regions being compared. The original accessible ranges are
Dave Love <fx@gnu.org>
parents:
diff changeset
1760 restored when you quit Ediff. During the command, you can toggle this
Dave Love <fx@gnu.org>
parents:
diff changeset
1761 narrowing on and off with the @kbd{%} command.
Dave Love <fx@gnu.org>
parents:
diff changeset
1762
Dave Love <fx@gnu.org>
parents:
diff changeset
1763 These two variables control this narrowing behavior:
Dave Love <fx@gnu.org>
parents:
diff changeset
1764
Dave Love <fx@gnu.org>
parents:
diff changeset
1765 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
1766 @item ediff-start-narrowed
Dave Love <fx@gnu.org>
parents:
diff changeset
1767 @vindex ediff-start-narrowed
Dave Love <fx@gnu.org>
parents:
diff changeset
1768 If @code{t}, Ediff narrows the display to the appropriate range when it
Dave Love <fx@gnu.org>
parents:
diff changeset
1769 is invoked with an @samp{ediff-regions@dots{}} or
Dave Love <fx@gnu.org>
parents:
diff changeset
1770 @samp{ediff-windows@dots{}} command. If @code{nil}, these commands do
Dave Love <fx@gnu.org>
parents:
diff changeset
1771 not automatically narrow, but you can still toggle narrowing on and off
Dave Love <fx@gnu.org>
parents:
diff changeset
1772 by typing @kbd{%}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1773
Dave Love <fx@gnu.org>
parents:
diff changeset
1774 @item ediff-quit-widened
Dave Love <fx@gnu.org>
parents:
diff changeset
1775 @vindex ediff-quit-widened
Dave Love <fx@gnu.org>
parents:
diff changeset
1776 Controls whether on quitting Ediff should restore the accessible range
Dave Love <fx@gnu.org>
parents:
diff changeset
1777 that existed before the current invocation.
Dave Love <fx@gnu.org>
parents:
diff changeset
1778 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1779
Dave Love <fx@gnu.org>
parents:
diff changeset
1780 @node Refinement of Difference Regions, Patch and Diff Programs, Narrowing, Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
1781 @section Refinement of Difference Regions
Dave Love <fx@gnu.org>
parents:
diff changeset
1782
Dave Love <fx@gnu.org>
parents:
diff changeset
1783 Ediff has variables to control the way fine differences are
Dave Love <fx@gnu.org>
parents:
diff changeset
1784 highlighted. This feature gives you control over the process of refinement.
Dave Love <fx@gnu.org>
parents:
diff changeset
1785 Note that refinement ignores spaces, tabs, and newlines.
Dave Love <fx@gnu.org>
parents:
diff changeset
1786
Dave Love <fx@gnu.org>
parents:
diff changeset
1787 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
1788 @item ediff-auto-refine
Dave Love <fx@gnu.org>
parents:
diff changeset
1789 @vindex ediff-auto-refine
Dave Love <fx@gnu.org>
parents:
diff changeset
1790 This variable controls whether fine differences within regions are
Dave Love <fx@gnu.org>
parents:
diff changeset
1791 highlighted automatically (``auto-refining''). The default is yes
Dave Love <fx@gnu.org>
parents:
diff changeset
1792 (@samp{on}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1793
Dave Love <fx@gnu.org>
parents:
diff changeset
1794 On a slow machine, automatic refinement may be painful. In that case,
Dave Love <fx@gnu.org>
parents:
diff changeset
1795 you can turn auto-refining on or off interactively by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
1796 @kbd{@@}. You can also turn off display of refining that has
Dave Love <fx@gnu.org>
parents:
diff changeset
1797 already been done.
Dave Love <fx@gnu.org>
parents:
diff changeset
1798
Dave Love <fx@gnu.org>
parents:
diff changeset
1799 When auto-refining is off, fine differences are shown only for regions
Dave Love <fx@gnu.org>
parents:
diff changeset
1800 for which these differences have been computed and saved before. If
Dave Love <fx@gnu.org>
parents:
diff changeset
1801 auto-refining and display of refining are both turned off, fine
Dave Love <fx@gnu.org>
parents:
diff changeset
1802 differences are not shown at all.
Dave Love <fx@gnu.org>
parents:
diff changeset
1803
Dave Love <fx@gnu.org>
parents:
diff changeset
1804 Typing @kbd{*} computes and displays fine differences for the current
Dave Love <fx@gnu.org>
parents:
diff changeset
1805 difference region, regardless of whether auto-refining is turned on.
Dave Love <fx@gnu.org>
parents:
diff changeset
1806
Dave Love <fx@gnu.org>
parents:
diff changeset
1807 @item ediff-auto-refine-limit
Dave Love <fx@gnu.org>
parents:
diff changeset
1808 @vindex ediff-auto-refine-limit
Dave Love <fx@gnu.org>
parents:
diff changeset
1809 If auto-refining is on, this variable limits the size of the regions to
Dave Love <fx@gnu.org>
parents:
diff changeset
1810 be auto-refined. This guards against the possible slowdown that may be
Dave Love <fx@gnu.org>
parents:
diff changeset
1811 caused by extraordinary large difference regions.
Dave Love <fx@gnu.org>
parents:
diff changeset
1812
Dave Love <fx@gnu.org>
parents:
diff changeset
1813 You can always refine the current region by typing @kbd{*}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1814
Dave Love <fx@gnu.org>
parents:
diff changeset
1815 @item ediff-forward-word-function
Dave Love <fx@gnu.org>
parents:
diff changeset
1816 @vindex ediff-forward-word-function
Dave Love <fx@gnu.org>
parents:
diff changeset
1817 This variable controls how fine differences are computed. The
Dave Love <fx@gnu.org>
parents:
diff changeset
1818 value must be a Lisp function that determines how the current difference
Dave Love <fx@gnu.org>
parents:
diff changeset
1819 region should be split into words.
Dave Love <fx@gnu.org>
parents:
diff changeset
1820
Dave Love <fx@gnu.org>
parents:
diff changeset
1821 @vindex ediff-diff-program
Dave Love <fx@gnu.org>
parents:
diff changeset
1822 @vindex ediff-forward-word-function
Dave Love <fx@gnu.org>
parents:
diff changeset
1823 @findex ediff-forward-word
Dave Love <fx@gnu.org>
parents:
diff changeset
1824 Fine differences are computed by first splitting the current difference
Dave Love <fx@gnu.org>
parents:
diff changeset
1825 region into words and then passing the result to
Dave Love <fx@gnu.org>
parents:
diff changeset
1826 @code{ediff-diff-program}. For the default forward word function (which is
Dave Love <fx@gnu.org>
parents:
diff changeset
1827 @code{ediff-forward-word}), a word is a string consisting of letters,
Dave Love <fx@gnu.org>
parents:
diff changeset
1828 @samp{-}, or @samp{_}; a string of punctuation symbols; a string of digits,
Dave Love <fx@gnu.org>
parents:
diff changeset
1829 or a string consisting of symbols that are neither space, nor a letter.
Dave Love <fx@gnu.org>
parents:
diff changeset
1830
Dave Love <fx@gnu.org>
parents:
diff changeset
1831 This default behavior is controlled by four variables: @code{ediff-word-1},
Dave Love <fx@gnu.org>
parents:
diff changeset
1832 ..., @code{ediff-word-4}. See the on-line documentation for these variables
Dave Love <fx@gnu.org>
parents:
diff changeset
1833 and for the function @code{ediff-forward-word} for an explanation of how to
Dave Love <fx@gnu.org>
parents:
diff changeset
1834 modify these variables.
Dave Love <fx@gnu.org>
parents:
diff changeset
1835 @vindex ediff-word-1
Dave Love <fx@gnu.org>
parents:
diff changeset
1836 @vindex ediff-word-2
Dave Love <fx@gnu.org>
parents:
diff changeset
1837 @vindex ediff-word-3
Dave Love <fx@gnu.org>
parents:
diff changeset
1838 @vindex ediff-word-4
Dave Love <fx@gnu.org>
parents:
diff changeset
1839 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1840
Dave Love <fx@gnu.org>
parents:
diff changeset
1841 Sometimes, when a region has too many differences between the variants,
Dave Love <fx@gnu.org>
parents:
diff changeset
1842 highlighting of fine differences is inconvenient, especially on
Dave Love <fx@gnu.org>
parents:
diff changeset
1843 color displays. If that is the case, type @kbd{*} with a negative
Dave Love <fx@gnu.org>
parents:
diff changeset
1844 prefix argument. This unhighlights fine differences for the current
Dave Love <fx@gnu.org>
parents:
diff changeset
1845 region.
Dave Love <fx@gnu.org>
parents:
diff changeset
1846
Dave Love <fx@gnu.org>
parents:
diff changeset
1847 To unhighlight fine differences in all difference regions, use the
Dave Love <fx@gnu.org>
parents:
diff changeset
1848 command @kbd{@@}. Repeated typing of this key cycles through three
Dave Love <fx@gnu.org>
parents:
diff changeset
1849 different states: auto-refining, no-auto-refining, and no-highlighting
Dave Love <fx@gnu.org>
parents:
diff changeset
1850 of fine differences.
Dave Love <fx@gnu.org>
parents:
diff changeset
1851
Dave Love <fx@gnu.org>
parents:
diff changeset
1852 @node Patch and Diff Programs, Merging and diff3, Refinement of Difference Regions, Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
1853 @section Patch and Diff Programs
Dave Love <fx@gnu.org>
parents:
diff changeset
1854
Dave Love <fx@gnu.org>
parents:
diff changeset
1855 This section describes variables that specify the programs to be used for
Dave Love <fx@gnu.org>
parents:
diff changeset
1856 applying patches and for computing the main difference regions (not the
Dave Love <fx@gnu.org>
parents:
diff changeset
1857 fine difference regions):
Dave Love <fx@gnu.org>
parents:
diff changeset
1858
Dave Love <fx@gnu.org>
parents:
diff changeset
1859 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
1860 @item ediff-diff-program
Dave Love <fx@gnu.org>
parents:
diff changeset
1861 @itemx ediff-diff3-program
Dave Love <fx@gnu.org>
parents:
diff changeset
1862 @vindex ediff-patch-program
Dave Love <fx@gnu.org>
parents:
diff changeset
1863 @vindex ediff-diff-program
Dave Love <fx@gnu.org>
parents:
diff changeset
1864 @vindex ediff-diff3-program
Dave Love <fx@gnu.org>
parents:
diff changeset
1865 These variables specify the programs to use to produce differences
Dave Love <fx@gnu.org>
parents:
diff changeset
1866 and do patching.
Dave Love <fx@gnu.org>
parents:
diff changeset
1867
Dave Love <fx@gnu.org>
parents:
diff changeset
1868 @item ediff-diff-options
Dave Love <fx@gnu.org>
parents:
diff changeset
1869 @itemx ediff-diff3-options
Dave Love <fx@gnu.org>
parents:
diff changeset
1870 @vindex ediff-patch-options
Dave Love <fx@gnu.org>
parents:
diff changeset
1871 @vindex ediff-diff-options
Dave Love <fx@gnu.org>
parents:
diff changeset
1872 @vindex ediff-diff3-options
Dave Love <fx@gnu.org>
parents:
diff changeset
1873 These variables specify the options to pass to the above utilities.
Dave Love <fx@gnu.org>
parents:
diff changeset
1874
Dave Love <fx@gnu.org>
parents:
diff changeset
1875 In @code{ediff-diff-options}, it may be useful to specify options
Dave Love <fx@gnu.org>
parents:
diff changeset
1876 such as @samp{-w} that ignore certain kinds of changes. However,
Dave Love <fx@gnu.org>
parents:
diff changeset
1877 Ediff does not let you use the option @samp{-c}, as it doesn't recognize this
Dave Love <fx@gnu.org>
parents:
diff changeset
1878 format yet.
Dave Love <fx@gnu.org>
parents:
diff changeset
1879
36043
5d6b76d28b83 2001-02-12 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 35411
diff changeset
1880 @item ediff-coding-system-for-read
5d6b76d28b83 2001-02-12 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 35411
diff changeset
1881 @vindex ediff-coding-system-for-read
5d6b76d28b83 2001-02-12 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 35411
diff changeset
1882 This variable specifies the coding system to use when reading the output
5d6b76d28b83 2001-02-12 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 35411
diff changeset
1883 that the programs @code{diff3} and @code{diff} send to Emacs. The default
42288
3ce98f3e0608 2001-12-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 38865
diff changeset
1884 is @code{raw-text}, and this should work fine in Unix and in most
3ce98f3e0608 2001-12-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 38865
diff changeset
1885 cases under Windows NT/95/98/2000. There are @code{diff} programs
36043
5d6b76d28b83 2001-02-12 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 35411
diff changeset
1886 for which the default option doesn't work under Windows. In such cases,
5d6b76d28b83 2001-02-12 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 35411
diff changeset
1887 @code{raw-text-dos} might work. If not, you will have to experiment with
5d6b76d28b83 2001-02-12 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 35411
diff changeset
1888 other coding systems or use GNU diff.
5d6b76d28b83 2001-02-12 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 35411
diff changeset
1889
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1890 @item ediff-patch-program
Dave Love <fx@gnu.org>
parents:
diff changeset
1891 The program to use to apply patches. Since there are certain
Dave Love <fx@gnu.org>
parents:
diff changeset
1892 incompatibilities between the different versions of the patch program, the
Dave Love <fx@gnu.org>
parents:
diff changeset
1893 best way to stay out of trouble is to use a GNU-compatible version.
Dave Love <fx@gnu.org>
parents:
diff changeset
1894 Otherwise, you may have to tune the values of the variables
Dave Love <fx@gnu.org>
parents:
diff changeset
1895 @code{ediff-patch-options}, @code{ediff-backup-specs}, and
Dave Love <fx@gnu.org>
parents:
diff changeset
1896 @code{ediff-backup-extension} as described below.
Dave Love <fx@gnu.org>
parents:
diff changeset
1897 @item ediff-patch-options
Dave Love <fx@gnu.org>
parents:
diff changeset
1898 Options to pass to @code{ediff-patch-program}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1899
Dave Love <fx@gnu.org>
parents:
diff changeset
1900 Note: the `-b' and `-z' options should be specified in
Dave Love <fx@gnu.org>
parents:
diff changeset
1901 `ediff-backup-specs', not in @code{ediff-patch-options}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1902
Dave Love <fx@gnu.org>
parents:
diff changeset
1903 It is recommended to pass the `-f' option to the patch program, so it won't
Dave Love <fx@gnu.org>
parents:
diff changeset
1904 ask questions. However, some implementations don't accept this option, in
Dave Love <fx@gnu.org>
parents:
diff changeset
1905 which case the default value of this variable should be changed.
Dave Love <fx@gnu.org>
parents:
diff changeset
1906
Dave Love <fx@gnu.org>
parents:
diff changeset
1907 @item ediff-backup-extension
Dave Love <fx@gnu.org>
parents:
diff changeset
1908 Backup extension used by the patch program. Must be specified, even if
Dave Love <fx@gnu.org>
parents:
diff changeset
1909 @code{ediff-backup-specs} is given.
Dave Love <fx@gnu.org>
parents:
diff changeset
1910 @item ediff-backup-specs
Dave Love <fx@gnu.org>
parents:
diff changeset
1911 Backup directives to pass to the patch program.
Dave Love <fx@gnu.org>
parents:
diff changeset
1912 Ediff requires that the old version of the file (before applying the patch)
Dave Love <fx@gnu.org>
parents:
diff changeset
1913 is saved in a file named @file{the-patch-file.extension}. Usually
Dave Love <fx@gnu.org>
parents:
diff changeset
1914 `extension' is `.orig', but this can be changed by the user, and may also be
Dave Love <fx@gnu.org>
parents:
diff changeset
1915 system-dependent. Therefore, Ediff needs to know the backup extension used
Dave Love <fx@gnu.org>
parents:
diff changeset
1916 by the patch program.
Dave Love <fx@gnu.org>
parents:
diff changeset
1917
Dave Love <fx@gnu.org>
parents:
diff changeset
1918 Some versions of the patch program let the user specify `-b backup-extension'.
Dave Love <fx@gnu.org>
parents:
diff changeset
1919 Other versions only permit `-b', which (usually) assumes the extension `.orig'.
Dave Love <fx@gnu.org>
parents:
diff changeset
1920 Yet others force you to use `-z<backup-extension>'.
Dave Love <fx@gnu.org>
parents:
diff changeset
1921
Dave Love <fx@gnu.org>
parents:
diff changeset
1922 Note that both `ediff-backup-extension' and `ediff-backup-specs' must be
Dave Love <fx@gnu.org>
parents:
diff changeset
1923 properly set. If your patch program takes the option `-b', but not
Dave Love <fx@gnu.org>
parents:
diff changeset
1924 `-b extension', the variable `ediff-backup-extension' must still
Dave Love <fx@gnu.org>
parents:
diff changeset
1925 be set so Ediff will know which extension to use.
Dave Love <fx@gnu.org>
parents:
diff changeset
1926
Dave Love <fx@gnu.org>
parents:
diff changeset
1927 @item ediff-custom-diff-program
Dave Love <fx@gnu.org>
parents:
diff changeset
1928 @itemx ediff-custom-diff-options
Dave Love <fx@gnu.org>
parents:
diff changeset
1929 @vindex ediff-custom-diff-program
Dave Love <fx@gnu.org>
parents:
diff changeset
1930 @vindex ediff-custom-diff-options
Dave Love <fx@gnu.org>
parents:
diff changeset
1931 @findex ediff-save-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1932 Because Ediff limits the options you may want to pass to the @code{diff}
Dave Love <fx@gnu.org>
parents:
diff changeset
1933 program, it partially makes up for this drawback by letting you save the
Dave Love <fx@gnu.org>
parents:
diff changeset
1934 output from @code{diff} in your preferred format, which is specified via
Dave Love <fx@gnu.org>
parents:
diff changeset
1935 the above two variables.
Dave Love <fx@gnu.org>
parents:
diff changeset
1936
Dave Love <fx@gnu.org>
parents:
diff changeset
1937 The output generated by @code{ediff-custom-diff-program} (which doesn't
33021
9fd41b036b84 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 33019
diff changeset
1938 even have to be a standard-style @code{diff}!)@: is not used by Ediff. It is
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1939 provided exclusively so that you can
Dave Love <fx@gnu.org>
parents:
diff changeset
1940 refer to
Dave Love <fx@gnu.org>
parents:
diff changeset
1941 it later, send it over email, etc. For instance, after reviewing the
Dave Love <fx@gnu.org>
parents:
diff changeset
1942 differences, you may want to send context differences to a colleague.
Dave Love <fx@gnu.org>
parents:
diff changeset
1943 Since Ediff ignores the @samp{-c} option in
Dave Love <fx@gnu.org>
parents:
diff changeset
1944 @code{ediff-diff-program}, you would have to run @code{diff -c} separately
Dave Love <fx@gnu.org>
parents:
diff changeset
1945 just to produce the list of differences. Fortunately,
Dave Love <fx@gnu.org>
parents:
diff changeset
1946 @code{ediff-custom-diff-program} and @code{ediff-custom-diff-options}
Dave Love <fx@gnu.org>
parents:
diff changeset
1947 eliminate this nuisance by keeping a copy of a difference list in the
Dave Love <fx@gnu.org>
parents:
diff changeset
1948 desired format in a buffer that can be displayed via the command @kbd{D}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1949
Dave Love <fx@gnu.org>
parents:
diff changeset
1950 @item ediff-patch-default-directory
Dave Love <fx@gnu.org>
parents:
diff changeset
1951 @vindex ediff-patch-default-directory
Dave Love <fx@gnu.org>
parents:
diff changeset
1952 Specifies the default directory to look for patches.
Dave Love <fx@gnu.org>
parents:
diff changeset
1953
Dave Love <fx@gnu.org>
parents:
diff changeset
1954 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1955
Dave Love <fx@gnu.org>
parents:
diff changeset
1956 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1957 @strong{Warning:} Ediff does not support the output format of VMS
Dave Love <fx@gnu.org>
parents:
diff changeset
1958 @code{diff}. Instead, make sure you are using some implementation of POSIX
Dave Love <fx@gnu.org>
parents:
diff changeset
1959 @code{diff}, such as @code{gnudiff}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1960
Dave Love <fx@gnu.org>
parents:
diff changeset
1961 @node Merging and diff3, Support for Version Control, Patch and Diff Programs, Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
1962 @section Merging and diff3
Dave Love <fx@gnu.org>
parents:
diff changeset
1963
Dave Love <fx@gnu.org>
parents:
diff changeset
1964 Ediff supports three-way comparison via the functions @code{ediff-files3} and
Dave Love <fx@gnu.org>
parents:
diff changeset
1965 @code{ediff-buffers3}. The interface is the same as for two-way comparison.
Dave Love <fx@gnu.org>
parents:
diff changeset
1966 In three-way comparison and merging, Ediff reports if any two difference
Dave Love <fx@gnu.org>
parents:
diff changeset
1967 regions are identical. For instance, if the current region in buffer A
Dave Love <fx@gnu.org>
parents:
diff changeset
1968 is the same as the region in buffer C, then the mode line of buffer A will
Dave Love <fx@gnu.org>
parents:
diff changeset
1969 display @samp{[=diff(C)]} and the mode line of buffer C will display
Dave Love <fx@gnu.org>
parents:
diff changeset
1970 @samp{[=diff(A)]}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1971
Dave Love <fx@gnu.org>
parents:
diff changeset
1972 Merging is done according to the following algorithm.
Dave Love <fx@gnu.org>
parents:
diff changeset
1973
Dave Love <fx@gnu.org>
parents:
diff changeset
1974 If a difference region in one of the buffers, say B, differs from the ancestor
Dave Love <fx@gnu.org>
parents:
diff changeset
1975 file while the region in the other buffer, A, doesn't, then the merge buffer,
Dave Love <fx@gnu.org>
parents:
diff changeset
1976 C, gets B's region. Similarly when buffer A's region differs from
Dave Love <fx@gnu.org>
parents:
diff changeset
1977 the ancestor and B's doesn't, A's region is used.
Dave Love <fx@gnu.org>
parents:
diff changeset
1978
Dave Love <fx@gnu.org>
parents:
diff changeset
1979 @vindex ediff-default-variant
Dave Love <fx@gnu.org>
parents:
diff changeset
1980 If both regions in buffers A and B differ from the ancestor file, Ediff
Dave Love <fx@gnu.org>
parents:
diff changeset
1981 chooses the region according to the value of the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1982 @code{ediff-default-variant}. If its value is @code{default-A} then A's
Dave Love <fx@gnu.org>
parents:
diff changeset
1983 region is chosen. If it is @code{default-B} then B's region is chosen.
Dave Love <fx@gnu.org>
parents:
diff changeset
1984 If it is @code{combined} then the region in buffer C will look like
Dave Love <fx@gnu.org>
parents:
diff changeset
1985 this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1986
26639
4aad3cb5a850 very minor fixes.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26589
diff changeset
1987 @comment Use @set to avoid triggering merge conflict detectors like CVS.
4aad3cb5a850 very minor fixes.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26589
diff changeset
1988 @set seven-left <<<<<<<
4aad3cb5a850 very minor fixes.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26589
diff changeset
1989 @set seven-right >>>>>>>
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1990 @example
26639
4aad3cb5a850 very minor fixes.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26589
diff changeset
1991 @value{seven-left} variant A
26589
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
1992 the difference region from buffer A
26639
4aad3cb5a850 very minor fixes.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26589
diff changeset
1993 @value{seven-right} variant B
26589
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
1994 the difference region from buffer B
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
1995 ####### Ancestor
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
1996 the difference region from the ancestor buffer, if available
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
1997 ======= end
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1998 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1999
26589
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
2000 The above is the default template for the combined region. The user can
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
2001 customize this template using the variable
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
2002 @code{ediff-combination-pattern}.
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
2003
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2004 @vindex ediff-combination-pattern
26589
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
2005 The variable @code{ediff-combination-pattern} specifies the template that
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
2006 determines how the combined merged region looks like. The template is
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
2007 represented as a list of the form @code{(STRING1 Symbol1 STRING2 Symbol2
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
2008 STRING3 Symbol3 STRING4)}. The symbols here must be atoms of the form
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
2009 @code{A}, @code{B}, or @code{Ancestor}. They determine the order in which
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
2010 the corresponding difference regions (from buffers A, B, and the ancestor
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
2011 buffer) are displayed in the merged region of buffer C. The strings in the
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
2012 template determine the text that separates the aforesaid regions. The
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
2013 default template is
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
2014
37797
d0c11ec0421d (Merging and diff3): Avoid Overfull hbox.
Eli Zaretskii <eliz@gnu.org>
parents: 37404
diff changeset
2015 @smallexample
d0c11ec0421d (Merging and diff3): Avoid Overfull hbox.
Eli Zaretskii <eliz@gnu.org>
parents: 37404
diff changeset
2016 ("@value{seven-left} variant A" A "@value{seven-right} variant B" B
d0c11ec0421d (Merging and diff3): Avoid Overfull hbox.
Eli Zaretskii <eliz@gnu.org>
parents: 37404
diff changeset
2017 "####### Ancestor" Ancestor "======= end")
d0c11ec0421d (Merging and diff3): Avoid Overfull hbox.
Eli Zaretskii <eliz@gnu.org>
parents: 37404
diff changeset
2018 @end smallexample
26589
929999669c16 * ediff.texi: Describe the new format for
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26263
diff changeset
2019
37797
d0c11ec0421d (Merging and diff3): Avoid Overfull hbox.
Eli Zaretskii <eliz@gnu.org>
parents: 37404
diff changeset
2020 @noindent
d0c11ec0421d (Merging and diff3): Avoid Overfull hbox.
Eli Zaretskii <eliz@gnu.org>
parents: 37404
diff changeset
2021 (this is one long line) and the corresponding combined region is shown
d0c11ec0421d (Merging and diff3): Avoid Overfull hbox.
Eli Zaretskii <eliz@gnu.org>
parents: 37404
diff changeset
2022 above. The order in which the regions are shown (and the separator
d0c11ec0421d (Merging and diff3): Avoid Overfull hbox.
Eli Zaretskii <eliz@gnu.org>
parents: 37404
diff changeset
2023 strings) can be changed by changing the above template. It is even
d0c11ec0421d (Merging and diff3): Avoid Overfull hbox.
Eli Zaretskii <eliz@gnu.org>
parents: 37404
diff changeset
2024 possible to add or delete region specifiers in this template (although
d0c11ec0421d (Merging and diff3): Avoid Overfull hbox.
Eli Zaretskii <eliz@gnu.org>
parents: 37404
diff changeset
2025 the only possibly useful such modification seems to be the deletion of
d0c11ec0421d (Merging and diff3): Avoid Overfull hbox.
Eli Zaretskii <eliz@gnu.org>
parents: 37404
diff changeset
2026 the ancestor).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2027
Dave Love <fx@gnu.org>
parents:
diff changeset
2028 In addition to the state of the difference, Ediff displays the state of the
Dave Love <fx@gnu.org>
parents:
diff changeset
2029 merge for each region. If a difference came from buffer A by default
Dave Love <fx@gnu.org>
parents:
diff changeset
2030 (because both regions A and B were different from the ancestor and
Dave Love <fx@gnu.org>
parents:
diff changeset
2031 @code{ediff-default-variant} was set to @code{default-A}) then
Dave Love <fx@gnu.org>
parents:
diff changeset
2032 @samp{[=diff(A) default-A]} is displayed in the mode line. If the
Dave Love <fx@gnu.org>
parents:
diff changeset
2033 difference in buffer C came, say, from buffer B because the difference
Dave Love <fx@gnu.org>
parents:
diff changeset
2034 region in that buffer differs from the ancestor, but the region in buffer A
Dave Love <fx@gnu.org>
parents:
diff changeset
2035 does not (if merging with an ancestor) then @samp{[=diff(B) prefer-B]} is
Dave Love <fx@gnu.org>
parents:
diff changeset
2036 displayed. The indicators default-A/B and prefer-A/B are inspired by
Dave Love <fx@gnu.org>
parents:
diff changeset
2037 Emerge and have the same meaning.
Dave Love <fx@gnu.org>
parents:
diff changeset
2038
Dave Love <fx@gnu.org>
parents:
diff changeset
2039 Another indicator of the state of merge is @samp{combined}. It appears
Dave Love <fx@gnu.org>
parents:
diff changeset
2040 with any difference region in buffer C that was obtained by combining
Dave Love <fx@gnu.org>
parents:
diff changeset
2041 the difference regions in buffers A and B as explained above.
Dave Love <fx@gnu.org>
parents:
diff changeset
2042
Dave Love <fx@gnu.org>
parents:
diff changeset
2043 In addition to the state of merge and state of difference indicators, while
Dave Love <fx@gnu.org>
parents:
diff changeset
2044 merging with an ancestor file or buffer, Ediff informs the user when the
Dave Love <fx@gnu.org>
parents:
diff changeset
2045 current difference region in the (normally invisible) ancestor buffer is
Dave Love <fx@gnu.org>
parents:
diff changeset
2046 empty via the @emph{AncestorEmpty} indicator. This helps determine if the
Dave Love <fx@gnu.org>
parents:
diff changeset
2047 changes made to the original in variants A and B represent pure insertion
Dave Love <fx@gnu.org>
parents:
diff changeset
2048 or deletion of text: if the mode line shows @emph{AncestorEmpty} and the
Dave Love <fx@gnu.org>
parents:
diff changeset
2049 corresponding region in buffers A or B is not empty, this means that new
Dave Love <fx@gnu.org>
parents:
diff changeset
2050 text was inserted. If this indicator is not present and the difference
Dave Love <fx@gnu.org>
parents:
diff changeset
2051 regions in buffers A or B are non-empty, this means that text was
Dave Love <fx@gnu.org>
parents:
diff changeset
2052 modified. Otherwise, the original text was deleted.
Dave Love <fx@gnu.org>
parents:
diff changeset
2053
Dave Love <fx@gnu.org>
parents:
diff changeset
2054 Although the ancestor buffer is normally invisible, Ediff maintains
Dave Love <fx@gnu.org>
parents:
diff changeset
2055 difference regions there and advances the current difference region
Dave Love <fx@gnu.org>
parents:
diff changeset
2056 accordingly. All highlighting of difference regions is provided in the
Dave Love <fx@gnu.org>
parents:
diff changeset
2057 ancestor buffer, except for the fine differences. Therefore, if desired, the
Dave Love <fx@gnu.org>
parents:
diff changeset
2058 user can put the ancestor buffer in a separate frame and watch it
Dave Love <fx@gnu.org>
parents:
diff changeset
2059 there. However, on a TTY, only one frame can be visible at any given time,
Dave Love <fx@gnu.org>
parents:
diff changeset
2060 and Ediff doesn't support any single-frame window configuration where all
Dave Love <fx@gnu.org>
parents:
diff changeset
2061 buffers, including the ancestor buffer, would be visible. However, the
Dave Love <fx@gnu.org>
parents:
diff changeset
2062 ancestor buffer can be displayed by typing @kbd{/} to the control
Dave Love <fx@gnu.org>
parents:
diff changeset
2063 window. (Type @kbd{C-l} to hide it again.)
Dave Love <fx@gnu.org>
parents:
diff changeset
2064
Dave Love <fx@gnu.org>
parents:
diff changeset
2065 Note that the state-of-difference indicators @samp{=diff(A)} and
Dave Love <fx@gnu.org>
parents:
diff changeset
2066 @samp{=diff(B)} above are not redundant, even in the presence of a
Dave Love <fx@gnu.org>
parents:
diff changeset
2067 state-of-merge indicator. In fact, the two serve different purposes.
Dave Love <fx@gnu.org>
parents:
diff changeset
2068
Dave Love <fx@gnu.org>
parents:
diff changeset
2069 For instance, if the mode line displays @samp{=diff(B) prefer(B)} and
Dave Love <fx@gnu.org>
parents:
diff changeset
2070 you copy a difference region from buffer A to buffer C then
Dave Love <fx@gnu.org>
parents:
diff changeset
2071 @samp{=diff(B)} will change to @samp{diff-A} and the mode line will
Dave Love <fx@gnu.org>
parents:
diff changeset
2072 display @samp{=diff(A) prefer-B}. This indicates that the difference
Dave Love <fx@gnu.org>
parents:
diff changeset
2073 region in buffer C is identical to that in buffer A, but originally
Dave Love <fx@gnu.org>
parents:
diff changeset
2074 buffer C's region came from buffer B. This is useful to know because
Dave Love <fx@gnu.org>
parents:
diff changeset
2075 you can recover the original difference region in buffer C by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
2076 @kbd{r}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2077
Dave Love <fx@gnu.org>
parents:
diff changeset
2078
Dave Love <fx@gnu.org>
parents:
diff changeset
2079 Ediff never changes the state-of-merge indicator, except in response to
Dave Love <fx@gnu.org>
parents:
diff changeset
2080 the @kbd{!} command (see below), in which case the indicator is lost.
Dave Love <fx@gnu.org>
parents:
diff changeset
2081 On the other hand, the state-of-difference indicator is changed
Dave Love <fx@gnu.org>
parents:
diff changeset
2082 automatically by the copying/recovery commands, @kbd{a}, @kbd{b}, @kbd{r},
Dave Love <fx@gnu.org>
parents:
diff changeset
2083 @kbd{+}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2084
Dave Love <fx@gnu.org>
parents:
diff changeset
2085 The @kbd{!} command loses the information about origins of the regions
Dave Love <fx@gnu.org>
parents:
diff changeset
2086 in the merge buffer (default-A, prefer-B, or combined). This is because
Dave Love <fx@gnu.org>
parents:
diff changeset
2087 recomputing differences in this case means running @code{diff3} on
Dave Love <fx@gnu.org>
parents:
diff changeset
2088 buffers A, B, and the merge buffer, not on the ancestor buffer. (It
Dave Love <fx@gnu.org>
parents:
diff changeset
2089 makes no sense to recompute differences using the ancestor file, since
Dave Love <fx@gnu.org>
parents:
diff changeset
2090 in the merging mode Ediff assumes that you have not edited buffers A and
Dave Love <fx@gnu.org>
parents:
diff changeset
2091 B, but that you may have edited buffer C, and these changes are to be
Dave Love <fx@gnu.org>
parents:
diff changeset
2092 preserved.) Since some difference regions may disappear as a result of
Dave Love <fx@gnu.org>
parents:
diff changeset
2093 editing buffer C and others may arise, there is generally no simple way
Dave Love <fx@gnu.org>
parents:
diff changeset
2094 to tell where the various regions in the merge buffer came from.
Dave Love <fx@gnu.org>
parents:
diff changeset
2095
Dave Love <fx@gnu.org>
parents:
diff changeset
2096 In three-way comparison, Ediff tries to disregard regions that consist
Dave Love <fx@gnu.org>
parents:
diff changeset
2097 entirely of white space. For instance, if, say, the current region in
Dave Love <fx@gnu.org>
parents:
diff changeset
2098 buffer A consists of the white space only (or if it is empty), Ediff will
Dave Love <fx@gnu.org>
parents:
diff changeset
2099 not take it into account for the purpose of computing fine differences. The
Dave Love <fx@gnu.org>
parents:
diff changeset
2100 result is that Ediff can provide a better visual information regarding the
Dave Love <fx@gnu.org>
parents:
diff changeset
2101 actual fine differences in the non-white regions in buffers B and
Dave Love <fx@gnu.org>
parents:
diff changeset
2102 C. Moreover, if the regions in buffers B and C differ in the white space
Dave Love <fx@gnu.org>
parents:
diff changeset
2103 only, then a message to this effect will be displayed.
Dave Love <fx@gnu.org>
parents:
diff changeset
2104
Dave Love <fx@gnu.org>
parents:
diff changeset
2105 @vindex ediff-merge-window-share
Dave Love <fx@gnu.org>
parents:
diff changeset
2106 In the merge mode, the share of the split between window C (the window
Dave Love <fx@gnu.org>
parents:
diff changeset
2107 displaying the merge-buffer) and the windows displaying buffers A and B
Dave Love <fx@gnu.org>
parents:
diff changeset
2108 is controlled by the variable @code{ediff-merge-window-share}. Its
Dave Love <fx@gnu.org>
parents:
diff changeset
2109 default value is 0.5. To make the merge-buffer window smaller, reduce
Dave Love <fx@gnu.org>
parents:
diff changeset
2110 this amount.
Dave Love <fx@gnu.org>
parents:
diff changeset
2111
Dave Love <fx@gnu.org>
parents:
diff changeset
2112 We don't recommend increasing the size of the merge-window to more than
Dave Love <fx@gnu.org>
parents:
diff changeset
2113 half the frame (i.e., to increase the value of
Dave Love <fx@gnu.org>
parents:
diff changeset
2114 @code{ediff-merge-window-share}) to more than 0.5, since it would be
Dave Love <fx@gnu.org>
parents:
diff changeset
2115 hard to see the contents of buffers A and B.
Dave Love <fx@gnu.org>
parents:
diff changeset
2116
Dave Love <fx@gnu.org>
parents:
diff changeset
2117 You can temporarily shrink the merge window to just one line by
Dave Love <fx@gnu.org>
parents:
diff changeset
2118 typing @kbd{s}. This change is temporary, until Ediff finds a reason to
Dave Love <fx@gnu.org>
parents:
diff changeset
2119 redraw the screen. Typing @kbd{s} again restores the original window size.
Dave Love <fx@gnu.org>
parents:
diff changeset
2120
Dave Love <fx@gnu.org>
parents:
diff changeset
2121 With a positive prefix argument, the @kbd{s} command will make the merge
Dave Love <fx@gnu.org>
parents:
diff changeset
2122 window slightly taller. This change is persistent. With `@kbd{-}' or
Dave Love <fx@gnu.org>
parents:
diff changeset
2123 with a negative prefix argument, the command @kbd{s} makes the merge
Dave Love <fx@gnu.org>
parents:
diff changeset
2124 window slightly shorter. This change also persistent.
Dave Love <fx@gnu.org>
parents:
diff changeset
2125
Dave Love <fx@gnu.org>
parents:
diff changeset
2126 @vindex ediff-show-clashes-only
Dave Love <fx@gnu.org>
parents:
diff changeset
2127 Ediff lets you automatically ignore the regions where only one of the
Dave Love <fx@gnu.org>
parents:
diff changeset
2128 buffers A and B disagrees with the ancestor. To do this, set the
Dave Love <fx@gnu.org>
parents:
diff changeset
2129 variable @code{ediff-show-clashes-only} to non-@code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2130
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
2131 You can toggle this feature interactively by typing @kbd{$$}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2132
Dave Love <fx@gnu.org>
parents:
diff changeset
2133 Note that this variable affects only the show next/previous difference
Dave Love <fx@gnu.org>
parents:
diff changeset
2134 commands. You can still jump directly to any difference region directly
Dave Love <fx@gnu.org>
parents:
diff changeset
2135 using the command @kbd{j} (with a prefix argument specifying the difference
Dave Love <fx@gnu.org>
parents:
diff changeset
2136 number).
Dave Love <fx@gnu.org>
parents:
diff changeset
2137
Dave Love <fx@gnu.org>
parents:
diff changeset
2138 @vindex ediff-autostore-merges
Dave Love <fx@gnu.org>
parents:
diff changeset
2139 @vindex ediff-quit-merge-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
2140 @findex ediff-maybe-save-and-delete-merge
Dave Love <fx@gnu.org>
parents:
diff changeset
2141 The variable @code{ediff-autostore-merges} controls what happens to the
Dave Love <fx@gnu.org>
parents:
diff changeset
2142 merge buffer when Ediff quits. If the value is @code{nil}, nothing is done
Dave Love <fx@gnu.org>
parents:
diff changeset
2143 to the merge buffer---it will be the user's responsibility to save it.
Dave Love <fx@gnu.org>
parents:
diff changeset
2144 If the value is @code{t}, the user will be asked where to save the buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
2145 and whether to delete it afterwards. It the value is neither @code{nil} nor
Dave Love <fx@gnu.org>
parents:
diff changeset
2146 @code{t}, the merge buffer is saved @emph{only} if this merge session was
Dave Love <fx@gnu.org>
parents:
diff changeset
2147 invoked from a group of related Ediff session, such as those that result
Dave Love <fx@gnu.org>
parents:
diff changeset
2148 from @code{ediff-merge-directories},
Dave Love <fx@gnu.org>
parents:
diff changeset
2149 @code{ediff-merge-directory-revisions}, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
2150 @xref{Session Groups}. This behavior is implemented in the function
Dave Love <fx@gnu.org>
parents:
diff changeset
2151 @code{ediff-maybe-save-and-delete-merge}, which is a hook in
Dave Love <fx@gnu.org>
parents:
diff changeset
2152 @code{ediff-quit-merge-hook}. The user can supply a different hook, if
Dave Love <fx@gnu.org>
parents:
diff changeset
2153 necessary.
Dave Love <fx@gnu.org>
parents:
diff changeset
2154
Dave Love <fx@gnu.org>
parents:
diff changeset
2155 The variable @code{ediff-autostore-merges} is buffer-local, so it can be
Dave Love <fx@gnu.org>
parents:
diff changeset
2156 set in a per-buffer manner. Therefore, use @code{setq-default} to globally
Dave Love <fx@gnu.org>
parents:
diff changeset
2157 change this variable.
Dave Love <fx@gnu.org>
parents:
diff changeset
2158
29165
641e43bad886 2000-05-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 29107
diff changeset
2159 @vindex ediff-merge-filename-prefix
641e43bad886 2000-05-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 29107
diff changeset
2160 When merge buffers are saved automatically as directed by
641e43bad886 2000-05-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 29107
diff changeset
2161 @code{ediff-autostore-merges}, Ediff attaches a prefix to each file, as
641e43bad886 2000-05-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 29107
diff changeset
2162 specified by the variable @code{ediff-merge-filename-prefix}. The default
641e43bad886 2000-05-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 29107
diff changeset
2163 is @code{merge_}, but this can be changed by the user.
641e43bad886 2000-05-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 29107
diff changeset
2164
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2165 @node Support for Version Control, Customizing the Mode Line, Merging and diff3, Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
2166 @section Support for Version Control
Dave Love <fx@gnu.org>
parents:
diff changeset
2167
Dave Love <fx@gnu.org>
parents:
diff changeset
2168
Dave Love <fx@gnu.org>
parents:
diff changeset
2169 Ediff supports version control and lets you compare versions of files
Dave Love <fx@gnu.org>
parents:
diff changeset
2170 visited by Emacs buffers via the function @code{ediff-revision}. This
Dave Love <fx@gnu.org>
parents:
diff changeset
2171 feature is controlled by the following variables:
Dave Love <fx@gnu.org>
parents:
diff changeset
2172
Dave Love <fx@gnu.org>
parents:
diff changeset
2173 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
2174 @item ediff-version-control-package
Dave Love <fx@gnu.org>
parents:
diff changeset
2175 @vindex ediff-version-control-package
Dave Love <fx@gnu.org>
parents:
diff changeset
2176 A symbol. The default is @samp{vc}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2177
Dave Love <fx@gnu.org>
parents:
diff changeset
2178 If you are like most Emacs users, Ediff will use VC as the version control
Dave Love <fx@gnu.org>
parents:
diff changeset
2179 package. This is the standard Emacs interface to RCS, CVS, and SCCS.
Dave Love <fx@gnu.org>
parents:
diff changeset
2180
Dave Love <fx@gnu.org>
parents:
diff changeset
2181 However, if your needs are better served by other interfaces, you will
Dave Love <fx@gnu.org>
parents:
diff changeset
2182 have to tell Ediff which version control package you are using, e.g.,
Dave Love <fx@gnu.org>
parents:
diff changeset
2183 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2184 (setq ediff-version-control-package 'rcs)
Dave Love <fx@gnu.org>
parents:
diff changeset
2185 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2186
Dave Love <fx@gnu.org>
parents:
diff changeset
2187 Apart from the standard @file{vc.el}, Ediff supports three other interfaces
33019
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
2188 to version control: @file{rcs.el}, @file{pcl-cvs.el} (recently renamed
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
2189 pcvs.el), and @file{generic-sc.el}. The package @file{rcs.el} is written
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
2190 by Sebastian Kremer <sk@@thp.Uni-Koeln.DE> and is available as
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2191 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2192 @file{ftp.cs.buffalo.edu:pub/Emacs/rcs.tar.Z}
Dave Love <fx@gnu.org>
parents:
diff changeset
2193 @file{ftp.uni-koeln.de:/pub/gnu/emacs/rcs.tar.Z}
Dave Love <fx@gnu.org>
parents:
diff changeset
2194 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2195 @pindex @file{vc.el}
Dave Love <fx@gnu.org>
parents:
diff changeset
2196 @pindex @file{rcs.el}
Dave Love <fx@gnu.org>
parents:
diff changeset
2197 @pindex @file{pcl-cvs.el}
Dave Love <fx@gnu.org>
parents:
diff changeset
2198 @pindex @file{generic-sc.el}
Dave Love <fx@gnu.org>
parents:
diff changeset
2199 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
2200
Dave Love <fx@gnu.org>
parents:
diff changeset
2201 Ediff's interface to the above packages allows the user to compare the
Dave Love <fx@gnu.org>
parents:
diff changeset
2202 versions of the current buffer or to merge them (with or without an
Dave Love <fx@gnu.org>
parents:
diff changeset
2203 ancestor-version). These operations can also be performed on directories
Dave Love <fx@gnu.org>
parents:
diff changeset
2204 containing files under version control.
Dave Love <fx@gnu.org>
parents:
diff changeset
2205
Dave Love <fx@gnu.org>
parents:
diff changeset
2206 In case of @file{pcl-cvs.el}, Ediff can also be invoked via the function
Dave Love <fx@gnu.org>
parents:
diff changeset
2207 @code{run-ediff-from-cvs-buffer}---see the documentation string for this
Dave Love <fx@gnu.org>
parents:
diff changeset
2208 function.
Dave Love <fx@gnu.org>
parents:
diff changeset
2209
Dave Love <fx@gnu.org>
parents:
diff changeset
2210 @node Customizing the Mode Line, Miscellaneous, Support for Version Control, Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
2211 @section Customizing the Mode Line
Dave Love <fx@gnu.org>
parents:
diff changeset
2212
Dave Love <fx@gnu.org>
parents:
diff changeset
2213 When Ediff is running, the mode line of @samp{Ediff Control Panel}
Dave Love <fx@gnu.org>
parents:
diff changeset
2214 buffer shows the current difference number and the total number of
Dave Love <fx@gnu.org>
parents:
diff changeset
2215 difference regions in the two files.
Dave Love <fx@gnu.org>
parents:
diff changeset
2216
Dave Love <fx@gnu.org>
parents:
diff changeset
2217 The mode line of the buffers being compared displays the type of the
Dave Love <fx@gnu.org>
parents:
diff changeset
2218 buffer (@samp{A:}, @samp{B:}, or @samp{C:}) and (usually) the file name.
Dave Love <fx@gnu.org>
parents:
diff changeset
2219 Ediff tries to be intelligent in choosing the mode line buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
2220 identification. In particular, it works well with the
Dave Love <fx@gnu.org>
parents:
diff changeset
2221 @file{uniquify.el} and @file{mode-line.el} packages (which improve on
Dave Love <fx@gnu.org>
parents:
diff changeset
2222 the default way in which Emacs displays buffer identification). If you
Dave Love <fx@gnu.org>
parents:
diff changeset
2223 don't like the way Ediff changes the mode line, you can use
Dave Love <fx@gnu.org>
parents:
diff changeset
2224 @code{ediff-prepare-buffer-hook} to modify the mode line.
Dave Love <fx@gnu.org>
parents:
diff changeset
2225 @vindex ediff-prepare-buffer-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
2226 @pindex @file{uniquify.el}
Dave Love <fx@gnu.org>
parents:
diff changeset
2227 @pindex @file{mode-line.el}
Dave Love <fx@gnu.org>
parents:
diff changeset
2228
Dave Love <fx@gnu.org>
parents:
diff changeset
2229 @node Miscellaneous, Notes on Heavy-duty Customization, Customizing the Mode Line, Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
2230 @section Miscellaneous
Dave Love <fx@gnu.org>
parents:
diff changeset
2231
Dave Love <fx@gnu.org>
parents:
diff changeset
2232 Here are a few other variables for customizing Ediff:
Dave Love <fx@gnu.org>
parents:
diff changeset
2233
Dave Love <fx@gnu.org>
parents:
diff changeset
2234 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
2235 @item ediff-split-window-function
Dave Love <fx@gnu.org>
parents:
diff changeset
2236 @vindex ediff-split-window-function
Dave Love <fx@gnu.org>
parents:
diff changeset
2237 Controls the way you want the window be split between file-A and file-B
Dave Love <fx@gnu.org>
parents:
diff changeset
2238 (and file-C, if applicable). It defaults to the vertical split
Dave Love <fx@gnu.org>
parents:
diff changeset
2239 (@code{split-window-vertically}, but you can set it to
Dave Love <fx@gnu.org>
parents:
diff changeset
2240 @code{split-window-horizontally}, if you so wish.
Dave Love <fx@gnu.org>
parents:
diff changeset
2241 Ediff also lets you switch from vertical to horizontal split and back
Dave Love <fx@gnu.org>
parents:
diff changeset
2242 interactively.
Dave Love <fx@gnu.org>
parents:
diff changeset
2243
Dave Love <fx@gnu.org>
parents:
diff changeset
2244 Note that if Ediff detects that all the buffers it compares are displayed in
Dave Love <fx@gnu.org>
parents:
diff changeset
2245 separate frames, it assumes that the user wants them to be so displayed
Dave Love <fx@gnu.org>
parents:
diff changeset
2246 and stops splitting windows. Instead, it arranges for each buffer to
Dave Love <fx@gnu.org>
parents:
diff changeset
2247 be displayed in a separate frame. You can switch to the one-frame mode
Dave Love <fx@gnu.org>
parents:
diff changeset
2248 by hiding one of the buffers A/B/C.
Dave Love <fx@gnu.org>
parents:
diff changeset
2249
Dave Love <fx@gnu.org>
parents:
diff changeset
2250 You can also swap the windows where buffers are displayed by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
2251 @kbd{~}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2252
Dave Love <fx@gnu.org>
parents:
diff changeset
2253 @item ediff-merge-split-window-function
Dave Love <fx@gnu.org>
parents:
diff changeset
2254 @vindex ediff-merge-split-window-function
Dave Love <fx@gnu.org>
parents:
diff changeset
2255 Controls how windows are
Dave Love <fx@gnu.org>
parents:
diff changeset
2256 split between buffers A and B in the merge mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
2257 This variable is like @code{ediff-split-window-function}, but it defaults
Dave Love <fx@gnu.org>
parents:
diff changeset
2258 to @code{split-window-horizontally} instead of
Dave Love <fx@gnu.org>
parents:
diff changeset
2259 @code{split-window-vertically}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2260
Dave Love <fx@gnu.org>
parents:
diff changeset
2261 @item ediff-make-wide-display-function
Dave Love <fx@gnu.org>
parents:
diff changeset
2262 @vindex ediff-make-wide-display-function
Dave Love <fx@gnu.org>
parents:
diff changeset
2263 The value is a function to be called to widen the frame for displaying
Dave Love <fx@gnu.org>
parents:
diff changeset
2264 the Ediff buffers. See the on-line documentation for
Dave Love <fx@gnu.org>
parents:
diff changeset
2265 @code{ediff-make-wide-display-function} for details. It is also
Dave Love <fx@gnu.org>
parents:
diff changeset
2266 recommended to look into the source of the default function
Dave Love <fx@gnu.org>
parents:
diff changeset
2267 @code{ediff-make-wide-display}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2268
Dave Love <fx@gnu.org>
parents:
diff changeset
2269 You can toggle wide/regular display by typing @kbd{m}. In the wide
Dave Love <fx@gnu.org>
parents:
diff changeset
2270 display mode, buffers A, B (and C, when applicable) are displayed in a
Dave Love <fx@gnu.org>
parents:
diff changeset
2271 single frame that is as wide as the entire workstation screen. This is
Dave Love <fx@gnu.org>
parents:
diff changeset
2272 useful when files are compared side-by-side. By default, the display is
Dave Love <fx@gnu.org>
parents:
diff changeset
2273 widened without changing its height.
Dave Love <fx@gnu.org>
parents:
diff changeset
2274
Dave Love <fx@gnu.org>
parents:
diff changeset
2275 @item ediff-use-last-dir
Dave Love <fx@gnu.org>
parents:
diff changeset
2276 @vindex ediff-use-last-dir
Dave Love <fx@gnu.org>
parents:
diff changeset
2277 Controls the way Ediff presents the
Dave Love <fx@gnu.org>
parents:
diff changeset
2278 default directory when it prompts the user for files to compare. If
Dave Love <fx@gnu.org>
parents:
diff changeset
2279 @code{nil},
Dave Love <fx@gnu.org>
parents:
diff changeset
2280 Ediff uses the default directory of the current buffer when it
Dave Love <fx@gnu.org>
parents:
diff changeset
2281 prompts the user for file names. Otherwise, it will use the
Dave Love <fx@gnu.org>
parents:
diff changeset
2282 directories it had previously used for files A, B, or C, respectively.
Dave Love <fx@gnu.org>
parents:
diff changeset
2283
Dave Love <fx@gnu.org>
parents:
diff changeset
2284 @item ediff-no-emacs-help-in-control-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
2285 @vindex ediff-no-emacs-help-in-control-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
2286 If @code{t}, makes @kbd{C-h}
Dave Love <fx@gnu.org>
parents:
diff changeset
2287 behave like the @key{DEL} key, i.e., it will move you back to the previous
Dave Love <fx@gnu.org>
parents:
diff changeset
2288 difference rather than invoking help. This is useful when, in an xterm
Dave Love <fx@gnu.org>
parents:
diff changeset
2289 window or a text-only terminal, the Backspace key is bound to @kbd{C-h} and is
Dave Love <fx@gnu.org>
parents:
diff changeset
2290 positioned more conveniently than the @key{DEL} key.
Dave Love <fx@gnu.org>
parents:
diff changeset
2291
Dave Love <fx@gnu.org>
parents:
diff changeset
2292 @item ediff-toggle-read-only-function
Dave Love <fx@gnu.org>
parents:
diff changeset
2293 @vindex ediff-toggle-read-only-function
Dave Love <fx@gnu.org>
parents:
diff changeset
2294 This variable's value is a function that Ediff uses to toggle
Dave Love <fx@gnu.org>
parents:
diff changeset
2295 the read-only property in its buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
2296
Dave Love <fx@gnu.org>
parents:
diff changeset
2297 The default function that Ediff uses simply toggles the read-only property,
Dave Love <fx@gnu.org>
parents:
diff changeset
2298 unless the file is under version control. For a checked-in file under
Dave Love <fx@gnu.org>
parents:
diff changeset
2299 version control, Ediff first tries to check the file out.
Dave Love <fx@gnu.org>
parents:
diff changeset
2300
Dave Love <fx@gnu.org>
parents:
diff changeset
2301 @item ediff-make-buffers-readonly-at-startup nil
Dave Love <fx@gnu.org>
parents:
diff changeset
2302 @vindex ediff-make-buffers-readonly-at-startup
63676
5a0f08de3a11 (Miscellaneous): Texinfo usage fix.
Juanma Barranquero <lekktu@gmail.com>
parents: 62356
diff changeset
2303 If @code{t}, all variant buffers are made read-only at Ediff startup.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2304
Dave Love <fx@gnu.org>
parents:
diff changeset
2305 @item ediff-keep-variants
Dave Love <fx@gnu.org>
parents:
diff changeset
2306 @vindex @code{ediff-keep-variants}
Dave Love <fx@gnu.org>
parents:
diff changeset
2307 The default is @code{t}, meaning that the buffers being compared or merged will
Dave Love <fx@gnu.org>
parents:
diff changeset
2308 be preserved when Ediff quits. Setting this to @code{nil} causes Ediff to
Dave Love <fx@gnu.org>
parents:
diff changeset
2309 offer the user a chance to delete these buffers (if they are not modified).
Dave Love <fx@gnu.org>
parents:
diff changeset
2310 Supplying a prefix argument to the quit command (@code{q}) temporarily
Dave Love <fx@gnu.org>
parents:
diff changeset
2311 reverses the meaning of this variable. This is convenient when the user
Dave Love <fx@gnu.org>
parents:
diff changeset
2312 prefers one of the behaviors most of the time, but occasionally needs the
Dave Love <fx@gnu.org>
parents:
diff changeset
2313 other behavior.
Dave Love <fx@gnu.org>
parents:
diff changeset
2314
Dave Love <fx@gnu.org>
parents:
diff changeset
2315 However, Ediff temporarily resets this variable to @code{t} if it is
Dave Love <fx@gnu.org>
parents:
diff changeset
2316 invoked via one of the "buffer" jobs, such as @code{ediff-buffers}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2317 This is because it is all too easy to loose day's work otherwise.
Dave Love <fx@gnu.org>
parents:
diff changeset
2318 Besides, in a "buffer" job, the variant buffers have already been loaded
Dave Love <fx@gnu.org>
parents:
diff changeset
2319 prior to starting Ediff, so Ediff just preserves status quo here.
Dave Love <fx@gnu.org>
parents:
diff changeset
2320
Dave Love <fx@gnu.org>
parents:
diff changeset
2321 Using @code{ediff-cleanup-hook}, one can make Ediff delete the variants
Dave Love <fx@gnu.org>
parents:
diff changeset
2322 unconditionally (e.g., by making @code{ediff-janitor} into one of these hooks).
71383
4a969fe4cb19 2006-06-18 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 71224
diff changeset
2323
4a969fe4cb19 2006-06-18 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 71224
diff changeset
2324 @item ediff-keep-tmp-versions
4a969fe4cb19 2006-06-18 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 71224
diff changeset
2325 @vindex @code{ediff-keep-tmp-versions}
4a969fe4cb19 2006-06-18 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 71224
diff changeset
2326 Default is @code{nil}. If @code{t}, the versions of the files being
4a969fe4cb19 2006-06-18 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 71224
diff changeset
2327 compared or merged using operations such as @code{ediff-revision} or
4a969fe4cb19 2006-06-18 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 71224
diff changeset
2328 @code{ediff-merge-revisions} are not deleted on exit. The normal action is
4a969fe4cb19 2006-06-18 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 71224
diff changeset
2329 to clean up and delete these version files.
4a969fe4cb19 2006-06-18 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 71224
diff changeset
2330
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2331 @item ediff-grab-mouse
Dave Love <fx@gnu.org>
parents:
diff changeset
2332 @vindex @code{ediff-grab-mouse}
Dave Love <fx@gnu.org>
parents:
diff changeset
2333 Default is @code{t}. Normally, Ediff grabs mouse and puts it in its
Dave Love <fx@gnu.org>
parents:
diff changeset
2334 control frame. This is useful since the user can be sure that when he
Dave Love <fx@gnu.org>
parents:
diff changeset
2335 needs to type an Ediff command the focus will be in an appropriate Ediff's
Dave Love <fx@gnu.org>
parents:
diff changeset
2336 frame. However, some users prefer to move the mouse by themselves. The
Dave Love <fx@gnu.org>
parents:
diff changeset
2337 above variable, if set to @code{maybe}, will prevent Ediff from grabbing
Dave Love <fx@gnu.org>
parents:
diff changeset
2338 the mouse in many situations, usually after commands that may take more
Dave Love <fx@gnu.org>
parents:
diff changeset
2339 time than usual. In other situation, Ediff will continue grabbing the mouse
Dave Love <fx@gnu.org>
parents:
diff changeset
2340 and putting it where it believes is appropriate. If the value is
Dave Love <fx@gnu.org>
parents:
diff changeset
2341 @code{nil}, then mouse is entirely user's responsibility.
Dave Love <fx@gnu.org>
parents:
diff changeset
2342 Try different settings and see which one is for you.
Dave Love <fx@gnu.org>
parents:
diff changeset
2343 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
2344
Dave Love <fx@gnu.org>
parents:
diff changeset
2345
Dave Love <fx@gnu.org>
parents:
diff changeset
2346 @node Notes on Heavy-duty Customization, , Miscellaneous, Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
2347 @section Notes on Heavy-duty Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
2348
Dave Love <fx@gnu.org>
parents:
diff changeset
2349 Some users need to customize Ediff in rather sophisticated ways, which
Dave Love <fx@gnu.org>
parents:
diff changeset
2350 requires different defaults for different kinds of files (e.g., SGML,
Dave Love <fx@gnu.org>
parents:
diff changeset
2351 etc.). Ediff supports this kind of customization in several ways. First,
Dave Love <fx@gnu.org>
parents:
diff changeset
2352 most customization variables are buffer-local. Those that aren't are
Dave Love <fx@gnu.org>
parents:
diff changeset
2353 usually accessible from within Ediff Control Panel, so one can make them
Dave Love <fx@gnu.org>
parents:
diff changeset
2354 local to the panel by calling make-local-variable from within
Dave Love <fx@gnu.org>
parents:
diff changeset
2355 @code{ediff-startup-hook}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2356
Dave Love <fx@gnu.org>
parents:
diff changeset
2357 Second, the function @code{ediff-setup} accepts an optional sixth
Dave Love <fx@gnu.org>
parents:
diff changeset
2358 argument which has the form @code{((@var{var-name-1} .@: @var{val-1})
Dave Love <fx@gnu.org>
parents:
diff changeset
2359 (@var{var-name-2} .@: @var{val-2}) @dots{})}. The function
Dave Love <fx@gnu.org>
parents:
diff changeset
2360 @code{ediff-setup} sets the variables in the list to the respective
Dave Love <fx@gnu.org>
parents:
diff changeset
2361 values, locally in the Ediff control buffer. This is an easy way to
Dave Love <fx@gnu.org>
parents:
diff changeset
2362 throw in custom variables (which usually should be buffer-local) that
Dave Love <fx@gnu.org>
parents:
diff changeset
2363 can then be tested in various hooks.
Dave Love <fx@gnu.org>
parents:
diff changeset
2364
Dave Love <fx@gnu.org>
parents:
diff changeset
2365 Make sure the variable @code{ediff-job-name} and @code{ediff-word-mode} are set
Dave Love <fx@gnu.org>
parents:
diff changeset
2366 properly in this case, as some things in Ediff depend on this.
Dave Love <fx@gnu.org>
parents:
diff changeset
2367
Dave Love <fx@gnu.org>
parents:
diff changeset
2368 Finally, if you want custom-tailored help messages, you can set the
Dave Love <fx@gnu.org>
parents:
diff changeset
2369 variables @code{ediff-brief-help-message-function} and
Dave Love <fx@gnu.org>
parents:
diff changeset
2370 @code{ediff-long-help-message-function}
Dave Love <fx@gnu.org>
parents:
diff changeset
2371 to functions that return help strings.
Dave Love <fx@gnu.org>
parents:
diff changeset
2372 @vindex ediff-startup-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
2373 @findex ediff-setup
Dave Love <fx@gnu.org>
parents:
diff changeset
2374 @vindex ediff-job-name
Dave Love <fx@gnu.org>
parents:
diff changeset
2375 @vindex ediff-word-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
2376 @vindex ediff-brief-help-message-function
Dave Love <fx@gnu.org>
parents:
diff changeset
2377 @vindex ediff-long-help-message-function
Dave Love <fx@gnu.org>
parents:
diff changeset
2378
Dave Love <fx@gnu.org>
parents:
diff changeset
2379 When customizing Ediff, some other variables are useful, although they are
Dave Love <fx@gnu.org>
parents:
diff changeset
2380 not user-definable. They are local to the Ediff control buffer, so this
Dave Love <fx@gnu.org>
parents:
diff changeset
2381 buffer must be current when you access these variables. The control buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
2382 is accessible via the variable @code{ediff-control-buffer}, which is also
Dave Love <fx@gnu.org>
parents:
diff changeset
2383 local to that buffer. It is usually used for checking if the current buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
2384 is also the control buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
2385
Dave Love <fx@gnu.org>
parents:
diff changeset
2386 Other variables of interest are:
Dave Love <fx@gnu.org>
parents:
diff changeset
2387 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
2388 @item ediff-buffer-A
Dave Love <fx@gnu.org>
parents:
diff changeset
2389 The first of the data buffers being compared.
Dave Love <fx@gnu.org>
parents:
diff changeset
2390
Dave Love <fx@gnu.org>
parents:
diff changeset
2391 @item ediff-buffer-B
Dave Love <fx@gnu.org>
parents:
diff changeset
2392 The second of the data buffers being compared.
Dave Love <fx@gnu.org>
parents:
diff changeset
2393
Dave Love <fx@gnu.org>
parents:
diff changeset
2394 @item ediff-buffer-C
Dave Love <fx@gnu.org>
parents:
diff changeset
2395 In three-way comparisons, this is the third buffer being compared.
Dave Love <fx@gnu.org>
parents:
diff changeset
2396 In merging, this is the merge buffer.
56279
b1ae5333057a * ses.texi, viper.texi, search.texi, flymake.texi, faq.texi:
Jesper Harder <harder@ifa.au.dk>
parents: 52979
diff changeset
2397 In two-way comparison, this variable is @code{nil}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2398
Dave Love <fx@gnu.org>
parents:
diff changeset
2399 @item ediff-window-A
Dave Love <fx@gnu.org>
parents:
diff changeset
2400 The window displaying buffer A. If buffer A is not visible, this variable
56279
b1ae5333057a * ses.texi, viper.texi, search.texi, flymake.texi, faq.texi:
Jesper Harder <harder@ifa.au.dk>
parents: 52979
diff changeset
2401 is @code{nil} or it may be a dead window.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2402
Dave Love <fx@gnu.org>
parents:
diff changeset
2403 @item ediff-window-B
Dave Love <fx@gnu.org>
parents:
diff changeset
2404 The window displaying buffer B.
Dave Love <fx@gnu.org>
parents:
diff changeset
2405
Dave Love <fx@gnu.org>
parents:
diff changeset
2406 @item ediff-window-C
Dave Love <fx@gnu.org>
parents:
diff changeset
2407 The window displaying buffer C, if any.
Dave Love <fx@gnu.org>
parents:
diff changeset
2408
Dave Love <fx@gnu.org>
parents:
diff changeset
2409 @item ediff-control-frame
56279
b1ae5333057a * ses.texi, viper.texi, search.texi, flymake.texi, faq.texi:
Jesper Harder <harder@ifa.au.dk>
parents: 52979
diff changeset
2410 A dedicated frame displaying the control buffer, if it exists. It is
b1ae5333057a * ses.texi, viper.texi, search.texi, flymake.texi, faq.texi:
Jesper Harder <harder@ifa.au.dk>
parents: 52979
diff changeset
2411 non-@code{nil} only if Ediff uses the multiframe display, i.e., when
b1ae5333057a * ses.texi, viper.texi, search.texi, flymake.texi, faq.texi:
Jesper Harder <harder@ifa.au.dk>
parents: 52979
diff changeset
2412 the control buffer is in its own frame.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2413 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
2414
77235
88224dc74061 Include GFDL.
Chong Yidong <cyd@stupidchicken.com>
parents: 75348
diff changeset
2415 @node Credits, GNU Free Documentation License, Customization, Top
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2416 @chapter Credits
Dave Love <fx@gnu.org>
parents:
diff changeset
2417
42602
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
2418 Ediff was written by Michael Kifer <kifer@@cs.stonybrook.edu>. It was inspired
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2419 by emerge.el written by Dale R.@: Worley <drw@@math.mit.edu>. An idea due to
Dave Love <fx@gnu.org>
parents:
diff changeset
2420 Boris Goldowsky <boris@@cs.rochester.edu> made it possible to highlight
Dave Love <fx@gnu.org>
parents:
diff changeset
2421 fine differences in Ediff buffers. Alastair Burt <burt@@dfki.uni-kl.de>
Dave Love <fx@gnu.org>
parents:
diff changeset
2422 ported Ediff to XEmacs, Eric Freudenthal <freudent@@jan.ultra.nyu.edu>
Dave Love <fx@gnu.org>
parents:
diff changeset
2423 made it work with VC, Marc Paquette <marcpa@@cam.org> wrote the
26639
4aad3cb5a850 very minor fixes.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26589
diff changeset
2424 toolbar support package for Ediff, and Hrvoje Niksic <hniksic@@xemacs.org>
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2425 adapted it to the Emacs customization package.
Dave Love <fx@gnu.org>
parents:
diff changeset
2426
44615
a1448e19a9f8 * viper-ex.el: Patch by Samuel Padgett. Copyright papers received.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 44029
diff changeset
2427 Many people provided help with bug reports, feature suggestions, and advice.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2428 Without them, Ediff would not be nearly as useful as it is today.
44615
a1448e19a9f8 * viper-ex.el: Patch by Samuel Padgett. Copyright papers received.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 44029
diff changeset
2429 Here is a hopefully full list of contributors:
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2430
Dave Love <fx@gnu.org>
parents:
diff changeset
2431 @example
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
2432 Adrian Aichner (aichner@@ecf.teradyne.com),
68997
6169b51037af 2006-02-19 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 68639
diff changeset
2433 Drew Adams (drew.adams@@oracle.com),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2434 Steve Baur (steve@@xemacs.org),
Dave Love <fx@gnu.org>
parents:
diff changeset
2435 Neal Becker (neal@@ctd.comsat.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2436 E.@: Jay Berkenbilt (ejb@@ql.org),
Dave Love <fx@gnu.org>
parents:
diff changeset
2437 Alastair Burt (burt@@dfki.uni-kl.de),
Dave Love <fx@gnu.org>
parents:
diff changeset
2438 Paul Bibilo (peb@@delcam.co.uk),
Dave Love <fx@gnu.org>
parents:
diff changeset
2439 Kevin Broadey (KevinB@@bartley.demon.co.uk),
Dave Love <fx@gnu.org>
parents:
diff changeset
2440 Harald Boegeholz (hwb@@machnix.mathematik.uni-stuttgart.de),
Dave Love <fx@gnu.org>
parents:
diff changeset
2441 Bradley A.@: Bosch (brad@@lachman.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2442 Michael D.@: Carney (carney@@ltx-tr.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2443 Jin S.@: Choi (jin@@atype.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2444 Scott Cummings (cummings@@adc.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2445 Albert Dvornik (bert@@mit.edu),
Dave Love <fx@gnu.org>
parents:
diff changeset
2446 Eric Eide (eeide@@asylum.cs.utah.edu),
Dave Love <fx@gnu.org>
parents:
diff changeset
2447 Paul Eggert (eggert@@twinsun.com),
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
2448 Urban Engberg (ue@@cci.dk),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2449 Kevin Esler (esler@@ch.hp.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2450 Robert Estes (estes@@ece.ucdavis.edu),
Dave Love <fx@gnu.org>
parents:
diff changeset
2451 Jay Finger (jayf@@microsoft.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2452 Xavier Fornari (xavier@@europe.cma.fr),
Dave Love <fx@gnu.org>
parents:
diff changeset
2453 Eric Freudenthal (freudent@@jan.ultra.nyu.edu),
Dave Love <fx@gnu.org>
parents:
diff changeset
2454 Job Ganzevoort (Job.Ganzevoort@@cwi.nl),
60151
905bf9de87af * ediff.el (ediff-set-diff-overlays-in-one-buffer,
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 56279
diff changeset
2455 Felix Heinrich Gatzemeier (felix.g@@tzemeier.info),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2456 Boris Goldowsky (boris@@cs.rochester.edu),
Dave Love <fx@gnu.org>
parents:
diff changeset
2457 Allan Gottlieb (gottlieb@@allan.ultra.nyu.edu),
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
2458 Aaron Gross (aaron@@bfr.co.il),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2459 Thorbjoern Hansen (thorbjoern.hansen@@mchp.siemens.de),
51073
c088bf2c1f13 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 49428
diff changeset
2460 Marcus Harnisch (marcus_harnisch@@mint-tech.com),
60151
905bf9de87af * ediff.el (ediff-set-diff-overlays-in-one-buffer,
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 56279
diff changeset
2461 Steven E. Harris (seh@@panix.com),
65857
528399f4c636 added acknowledgement
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 65555
diff changeset
2462 Aaron S. Hawley (Aaron.Hawley@@uvm.edu),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2463 Xiaoli Huang (hxl@@epic.com),
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
2464 Andreas Jaeger (aj@@suse.de),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2465 Lars Magne Ingebrigtsen (larsi@@ifi.uio.no),
Dave Love <fx@gnu.org>
parents:
diff changeset
2466 Larry Gouge (larry@@itginc.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2467 Karl Heuer (kwzh@@gnu.org),
Dave Love <fx@gnu.org>
parents:
diff changeset
2468 (irvine@@lks.csi.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2469 (jaffe@@chipmunk.cita.utoronto.ca),
Dave Love <fx@gnu.org>
parents:
diff changeset
2470 David Karr (dkarr@@nmo.gtegsc.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2471 Norbert Kiesel (norbert@@i3.informatik.rwth-aachen.de),
71383
4a969fe4cb19 2006-06-18 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 71224
diff changeset
2472 Steffen Kilb (skilb@@gmx.net),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2473 Leigh L Klotz (klotz@@adoc.xerox.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2474 Fritz Knabe (Fritz.Knabe@@ecrc.de),
Dave Love <fx@gnu.org>
parents:
diff changeset
2475 Heinz Knutzen (hk@@informatik.uni-kiel.d400.de),
Dave Love <fx@gnu.org>
parents:
diff changeset
2476 Andrew Koenig (ark@@research.att.com),
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
2477 Hannu Koivisto (azure@@iki.fi),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2478 Ken Laprade (laprade@@dw3f.ess.harris.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2479 Will C Lauer (wcl@@cadre.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2480 Richard Levitte (levitte@@e.kth.se),
Dave Love <fx@gnu.org>
parents:
diff changeset
2481 Mike Long (mike.long@@analog.com),
42602
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
2482 Dave Love (d.love@@dl.ac.uk),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2483 Martin Maechler (maechler@@stat.math.ethz.ch),
Dave Love <fx@gnu.org>
parents:
diff changeset
2484 Simon Marshall (simon@@gnu.org),
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37797
diff changeset
2485 Paul C. Meuse (pmeuse@@delcomsys.com),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2486 Richard Mlynarik (mly@@adoc.xerox.com),
33019
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
2487 Stefan Monnier (monnier@@cs.yale.edu),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2488 Chris Murphy (murphycm@@sun.aston.ac.uk),
Dave Love <fx@gnu.org>
parents:
diff changeset
2489 Erik Naggum (erik@@naggum.no),
Dave Love <fx@gnu.org>
parents:
diff changeset
2490 Eyvind Ness (Eyvind.Ness@@hrp.no),
Dave Love <fx@gnu.org>
parents:
diff changeset
2491 Ray Nickson (nickson@@cs.uq.oz.au),
60151
905bf9de87af * ediff.el (ediff-set-diff-overlays-in-one-buffer,
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 56279
diff changeset
2492 Dan Nicolaescu (dann@@ics.uci.edu),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2493 David Petchey (petchey_david@@jpmorgan.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2494 Benjamin Pierce (benjamin.pierce@@cl.cam.ac.uk),
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
2495 Francois Pinard (pinard@@iro.umontreal.ca),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2496 Tibor Polgar (tlp00@@spg.amdahl.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2497 David Prince (dave0d@@fegs.co.uk),
Dave Love <fx@gnu.org>
parents:
diff changeset
2498 Paul Raines (raines@@slac.stanford.edu),
43715
b389f29a8b00 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 43220
diff changeset
2499 Stefan Reicher (xsteve@@riic.at),
49428
0f80cb4f9d29 2003-01-25 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 47737
diff changeset
2500 Charles Rich (rich@@merl.com),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2501 Bill Richter (richter@@math.nwu.edu),
Dave Love <fx@gnu.org>
parents:
diff changeset
2502 C.S.@: Roberson (roberson@@aur.alcatel.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2503 Kevin Rodgers (kevin.rodgers@@ihs.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2504 Sandy Rutherford (sandy@@ibm550.sissa.it),
Dave Love <fx@gnu.org>
parents:
diff changeset
2505 Heribert Schuetz (schuetz@@ecrc.de),
Dave Love <fx@gnu.org>
parents:
diff changeset
2506 Andy Scott (ascott@@pcocd2.intel.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2507 Axel Seibert (axel@@tumbolia.ppp.informatik.uni-muenchen.de),
35411
be20c22dc16d 2001-01-19 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 34144
diff changeset
2508 Vin Shelton (acs@@xemacs.org),
be20c22dc16d 2001-01-19 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 34144
diff changeset
2509 Scott O. Sherman (Scott.Sherman@@mci.com),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2510 Richard Stallman (rms@@gnu.org),
Dave Love <fx@gnu.org>
parents:
diff changeset
2511 Richard Stanton (stanton@@haas.berkeley.edu),
42602
633233bf2bbf 2002-01-07 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42288
diff changeset
2512 Sam Steingold (sds@@goems.com),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2513 Ake Stenhoff (etxaksf@@aom.ericsson.se),
Dave Love <fx@gnu.org>
parents:
diff changeset
2514 Stig (stig@@hackvan.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2515 Peter Stout (Peter_Stout@@cs.cmu.edu),
Dave Love <fx@gnu.org>
parents:
diff changeset
2516 Chuck Thompson (cthomp@@cs.uiuc.edu),
Dave Love <fx@gnu.org>
parents:
diff changeset
2517 Ray Tomlinson (tomlinso@@bbn.com),
Dave Love <fx@gnu.org>
parents:
diff changeset
2518 Raymond Toy (toy@@rtp.ericsson.se),
43220
69c91aaa067a 2002-02-10 Michael Kifer <kifer@cs.stonybrook.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 42602
diff changeset
2519 Stephen J. Turnbull (stephen@@xemacs.org),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2520 Jan Vroonhof (vroonhof@@math.ethz.ch),
35411
be20c22dc16d 2001-01-19 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 34144
diff changeset
2521 Colin Walters (walters@@cis.ohio-state.edu),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2522 Philippe Waroquiers (philippe.waroquiers@@eurocontrol.be),
Dave Love <fx@gnu.org>
parents:
diff changeset
2523 Klaus Weber (gizmo@@zork.north.de),
26639
4aad3cb5a850 very minor fixes.
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 26589
diff changeset
2524 Ben Wing (ben@@xemacs.org),
33019
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
2525 Tom Wurgler (twurgler@@goodyear.com),
35411
be20c22dc16d 2001-01-19 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 34144
diff changeset
2526 Steve Youngs (youngs@@xemacs.org),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2527 Ilya Zakharevich (ilya@@math.ohio-state.edu),
Dave Love <fx@gnu.org>
parents:
diff changeset
2528 Eli Zaretskii (eliz@@is.elta.co.il)
Dave Love <fx@gnu.org>
parents:
diff changeset
2529 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2530
77235
88224dc74061 Include GFDL.
Chong Yidong <cyd@stupidchicken.com>
parents: 75348
diff changeset
2531 @node GNU Free Documentation License, Index, Credits, Top
88224dc74061 Include GFDL.
Chong Yidong <cyd@stupidchicken.com>
parents: 75348
diff changeset
2532 @appendix GNU Free Documentation License
88224dc74061 Include GFDL.
Chong Yidong <cyd@stupidchicken.com>
parents: 75348
diff changeset
2533 @include doclicense.texi
88224dc74061 Include GFDL.
Chong Yidong <cyd@stupidchicken.com>
parents: 75348
diff changeset
2534
88224dc74061 Include GFDL.
Chong Yidong <cyd@stupidchicken.com>
parents: 75348
diff changeset
2535
88224dc74061 Include GFDL.
Chong Yidong <cyd@stupidchicken.com>
parents: 75348
diff changeset
2536 @node Index, , GNU Free Documentation License, Top
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2537 @unnumbered Index
Dave Love <fx@gnu.org>
parents:
diff changeset
2538 @printindex cp
Dave Love <fx@gnu.org>
parents:
diff changeset
2539
29713
983e65f12610 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29165
diff changeset
2540 @setchapternewpage odd
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2541 @contents
Dave Love <fx@gnu.org>
parents:
diff changeset
2542 @bye
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51073
diff changeset
2543
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51073
diff changeset
2544 @ignore
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51073
diff changeset
2545 arch-tag: 165ecb88-d03c-44b1-a921-b93f50b05b46
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51073
diff changeset
2546 @end ignore