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