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