Mercurial > emacs
annotate man/files.texi @ 36882:595b423a9b3f
(mode-line-mode-menu): `glasses-mode' might be unbound.
(completion-ignored-extensions): Remove duplicate ".class".
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Mon, 19 Mar 2001 22:22:21 +0000 |
parents | c4072454eee4 |
children | 41f1140b1f53 |
rev | line source |
---|---|
25829 | 1 @c This is part of the Emacs manual. |
28123
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2 @c Copyright (C) 1985,86,87,93,94,95,97,99, 2000 Free Software Foundation, Inc. |
25829 | 3 @c See file emacs.texi for copying conditions. |
4 @node Files, Buffers, Fixit, Top | |
5 @chapter File Handling | |
6 @cindex files | |
7 | |
8 The operating system stores data permanently in named @dfn{files}. So | |
9 most of the text you edit with Emacs comes from a file and is ultimately | |
10 stored in a file. | |
11 | |
12 To edit a file, you must tell Emacs to read the file and prepare a | |
13 buffer containing a copy of the file's text. This is called | |
14 @dfn{visiting} the file. Editing commands apply directly to text in the | |
15 buffer; that is, to the copy inside Emacs. Your changes appear in the | |
16 file itself only when you @dfn{save} the buffer back into the file. | |
17 | |
18 In addition to visiting and saving files, Emacs can delete, copy, | |
19 rename, and append to files, keep multiple versions of them, and operate | |
20 on file directories. | |
21 | |
22 @menu | |
23 * File Names:: How to type and edit file-name arguments. | |
24 * Visiting:: Visiting a file prepares Emacs to edit the file. | |
25 * Saving:: Saving makes your changes permanent. | |
26 * Reverting:: Reverting cancels all the changes not saved. | |
27 * Auto Save:: Auto Save periodically protects against loss of data. | |
28 * File Aliases:: Handling multiple names for one file. | |
29 * Version Control:: Version control systems (RCS, CVS and SCCS). | |
30 * Directories:: Creating, deleting, and listing file directories. | |
31 * Comparing Files:: Finding where two files differ. | |
32 * Misc File Ops:: Other things you can do on files. | |
33 * Compressed Files:: Accessing compressed files. | |
28123
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
34 * File Archives:: Operating on tar, zip, jar etc. archive files. |
25829 | 35 * Remote Files:: Accessing files on other sites. |
36 * Quoted File Names:: Quoting special characters in file names. | |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
37 * File Name Cache:: Completion against a list of files you often use. |
28526
297e03ccd7e6
(Backup): backup-enable-predicate.
Dave Love <fx@gnu.org>
parents:
28327
diff
changeset
|
38 * File Conveniences:: Convenience Features for Finding Files. |
25829 | 39 @end menu |
40 | |
41 @node File Names | |
42 @section File Names | |
43 @cindex file names | |
44 | |
45 Most Emacs commands that operate on a file require you to specify the | |
46 file name. (Saving and reverting are exceptions; the buffer knows which | |
47 file name to use for them.) You enter the file name using the | |
48 minibuffer (@pxref{Minibuffer}). @dfn{Completion} is available, to make | |
49 it easier to specify long file names. @xref{Completion}. | |
50 | |
51 For most operations, there is a @dfn{default file name} which is used | |
52 if you type just @key{RET} to enter an empty argument. Normally the | |
53 default file name is the name of the file visited in the current buffer; | |
54 this makes it easy to operate on that file with any of the Emacs file | |
55 commands. | |
56 | |
57 @vindex default-directory | |
58 Each buffer has a default directory, normally the same as the | |
59 directory of the file visited in that buffer. When you enter a file | |
60 name without a directory, the default directory is used. If you specify | |
61 a directory in a relative fashion, with a name that does not start with | |
62 a slash, it is interpreted with respect to the default directory. The | |
63 default directory is kept in the variable @code{default-directory}, | |
64 which has a separate value in every buffer. | |
65 | |
66 For example, if the default file name is @file{/u/rms/gnu/gnu.tasks} then | |
67 the default directory is @file{/u/rms/gnu/}. If you type just @samp{foo}, | |
68 which does not specify a directory, it is short for @file{/u/rms/gnu/foo}. | |
69 @samp{../.login} would stand for @file{/u/rms/.login}. @samp{new/foo} | |
70 would stand for the file name @file{/u/rms/gnu/new/foo}. | |
71 | |
72 @findex cd | |
73 @findex pwd | |
74 The command @kbd{M-x pwd} prints the current buffer's default | |
75 directory, and the command @kbd{M-x cd} sets it (to a value read using | |
76 the minibuffer). A buffer's default directory changes only when the | |
77 @code{cd} command is used. A file-visiting buffer's default directory | |
78 is initialized to the directory of the file that is visited there. If | |
79 you create a buffer with @kbd{C-x b}, its default directory is copied | |
80 from that of the buffer that was current at the time. | |
81 | |
82 @vindex insert-default-directory | |
83 The default directory actually appears in the minibuffer when the | |
84 minibuffer becomes active to read a file name. This serves two | |
85 purposes: it @emph{shows} you what the default is, so that you can type | |
86 a relative file name and know with certainty what it will mean, and it | |
87 allows you to @emph{edit} the default to specify a different directory. | |
88 This insertion of the default directory is inhibited if the variable | |
89 @code{insert-default-directory} is set to @code{nil}. | |
90 | |
91 Note that it is legitimate to type an absolute file name after you | |
92 enter the minibuffer, ignoring the presence of the default directory | |
93 name as part of the text. The final minibuffer contents may look | |
94 invalid, but that is not so. For example, if the minibuffer starts out | |
95 with @samp{/usr/tmp/} and you add @samp{/x1/rms/foo}, you get | |
96 @samp{/usr/tmp//x1/rms/foo}; but Emacs ignores everything through the | |
97 first slash in the double slash; the result is @samp{/x1/rms/foo}. | |
98 @xref{Minibuffer File}. | |
99 | |
36324
63c47fc9df21
(File Names): Add documentation of the tilde expansion in file names.
Eli Zaretskii <eliz@gnu.org>
parents:
36323
diff
changeset
|
100 @cindex environment variables in file names |
63c47fc9df21
(File Names): Add documentation of the tilde expansion in file names.
Eli Zaretskii <eliz@gnu.org>
parents:
36323
diff
changeset
|
101 @cindex expansion of environment variables |
25829 | 102 @samp{$} in a file name is used to substitute environment variables. |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
103 For example, if you have used the shell command @command{export |
29107 | 104 FOO=rms/hacks} to set up an environment variable named @env{FOO}, then |
25829 | 105 you can use @file{/u/$FOO/test.c} or @file{/u/$@{FOO@}/test.c} as an |
106 abbreviation for @file{/u/rms/hacks/test.c}. The environment variable | |
107 name consists of all the alphanumeric characters after the @samp{$}; | |
108 alternatively, it may be enclosed in braces after the @samp{$}. Note | |
109 that shell commands to set environment variables affect Emacs only if | |
110 done before Emacs is started. | |
111 | |
36324
63c47fc9df21
(File Names): Add documentation of the tilde expansion in file names.
Eli Zaretskii <eliz@gnu.org>
parents:
36323
diff
changeset
|
112 @cindex home directory shorthand |
63c47fc9df21
(File Names): Add documentation of the tilde expansion in file names.
Eli Zaretskii <eliz@gnu.org>
parents:
36323
diff
changeset
|
113 You can use the @file{~/} in a file name to mean your home directory, |
63c47fc9df21
(File Names): Add documentation of the tilde expansion in file names.
Eli Zaretskii <eliz@gnu.org>
parents:
36323
diff
changeset
|
114 or @file{~@var{user-id}/} to mean the home directory of a user whose |
36325
cf1b9eaadeaf
(File Names): Add a note about ~/ peculiarities on DOS/Windows.
Eli Zaretskii <eliz@gnu.org>
parents:
36324
diff
changeset
|
115 login name is @code{user-id}. (On DOS and Windows systems, where a user |
cf1b9eaadeaf
(File Names): Add a note about ~/ peculiarities on DOS/Windows.
Eli Zaretskii <eliz@gnu.org>
parents:
36324
diff
changeset
|
116 doesn't have a home directory, Emacs substitutes @file{~/} with the |
cf1b9eaadeaf
(File Names): Add a note about ~/ peculiarities on DOS/Windows.
Eli Zaretskii <eliz@gnu.org>
parents:
36324
diff
changeset
|
117 value of the environment variable @code{HOME}; see @ref{General |
cf1b9eaadeaf
(File Names): Add a note about ~/ peculiarities on DOS/Windows.
Eli Zaretskii <eliz@gnu.org>
parents:
36324
diff
changeset
|
118 Variables}.) |
36324
63c47fc9df21
(File Names): Add documentation of the tilde expansion in file names.
Eli Zaretskii <eliz@gnu.org>
parents:
36323
diff
changeset
|
119 |
25829 | 120 To access a file with @samp{$} in its name, type @samp{$$}. This pair |
121 is converted to a single @samp{$} at the same time as variable | |
122 substitution is performed for single @samp{$}. Alternatively, quote the | |
36324
63c47fc9df21
(File Names): Add documentation of the tilde expansion in file names.
Eli Zaretskii <eliz@gnu.org>
parents:
36323
diff
changeset
|
123 whole file name with @samp{/:} (@pxref{Quoted File Names}). File names |
63c47fc9df21
(File Names): Add documentation of the tilde expansion in file names.
Eli Zaretskii <eliz@gnu.org>
parents:
36323
diff
changeset
|
124 which begin with a literal @samp{~} should also be quoted with @samp{/:}. |
25829 | 125 |
126 @findex substitute-in-file-name | |
127 The Lisp function that performs the substitution is called | |
128 @code{substitute-in-file-name}. The substitution is performed only on | |
129 file names read as such using the minibuffer. | |
130 | |
131 You can include non-ASCII characters in file names if you set the | |
132 variable @code{file-name-coding-system} to a non-@code{nil} value. | |
133 @xref{Specify Coding}. | |
134 | |
135 @node Visiting | |
136 @section Visiting Files | |
137 @cindex visiting files | |
138 | |
139 @c WideCommands | |
140 @table @kbd | |
141 @item C-x C-f | |
142 Visit a file (@code{find-file}). | |
143 @item C-x C-r | |
144 Visit a file for viewing, without allowing changes to it | |
145 (@code{find-file-read-only}). | |
146 @item C-x C-v | |
147 Visit a different file instead of the one visited last | |
148 (@code{find-alternate-file}). | |
149 @item C-x 4 f | |
150 Visit a file, in another window (@code{find-file-other-window}). Don't | |
151 alter what is displayed in the selected window. | |
152 @item C-x 5 f | |
153 Visit a file, in a new frame (@code{find-file-other-frame}). Don't | |
154 alter what is displayed in the selected frame. | |
155 @item M-x find-file-literally | |
156 Visit a file with no conversion of the contents. | |
157 @end table | |
158 | |
159 @cindex files, visiting and saving | |
160 @cindex saving files | |
161 @dfn{Visiting} a file means copying its contents into an Emacs buffer | |
162 so you can edit them. Emacs makes a new buffer for each file that you | |
163 visit. We say that this buffer is visiting the file that it was created | |
164 to hold. Emacs constructs the buffer name from the file name by | |
165 throwing away the directory, keeping just the name proper. For example, | |
166 a file named @file{/usr/rms/emacs.tex} would get a buffer named | |
167 @samp{emacs.tex}. If there is already a buffer with that name, a unique | |
168 name is constructed by appending @samp{<2>}, @samp{<3>}, or so on, using | |
169 the lowest number that makes a name that is not already in use. | |
170 | |
171 Each window's mode line shows the name of the buffer that is being displayed | |
172 in that window, so you can always tell what buffer you are editing. | |
173 | |
174 The changes you make with editing commands are made in the Emacs | |
175 buffer. They do not take effect in the file that you visited, or any | |
176 place permanent, until you @dfn{save} the buffer. Saving the buffer | |
177 means that Emacs writes the current contents of the buffer into its | |
178 visited file. @xref{Saving}. | |
179 | |
180 @cindex modified (buffer) | |
181 If a buffer contains changes that have not been saved, we say the | |
182 buffer is @dfn{modified}. This is important because it implies that | |
183 some changes will be lost if the buffer is not saved. The mode line | |
184 displays two stars near the left margin to indicate that the buffer is | |
185 modified. | |
186 | |
187 @kindex C-x C-f | |
188 @findex find-file | |
189 To visit a file, use the command @kbd{C-x C-f} (@code{find-file}). Follow | |
190 the command with the name of the file you wish to visit, terminated by a | |
191 @key{RET}. | |
192 | |
193 The file name is read using the minibuffer (@pxref{Minibuffer}), with | |
194 defaulting and completion in the standard manner (@pxref{File Names}). | |
195 While in the minibuffer, you can abort @kbd{C-x C-f} by typing @kbd{C-g}. | |
196 | |
35647
d1a5bb6d3811
(Visiting): Document the file selection dialog popped by C-x C-f.
Eli Zaretskii <eliz@gnu.org>
parents:
35620
diff
changeset
|
197 @cindex file selection dialog |
d1a5bb6d3811
(Visiting): Document the file selection dialog popped by C-x C-f.
Eli Zaretskii <eliz@gnu.org>
parents:
35620
diff
changeset
|
198 When Emacs is built with a suitable GUI toolkit, it pops up the |
d1a5bb6d3811
(Visiting): Document the file selection dialog popped by C-x C-f.
Eli Zaretskii <eliz@gnu.org>
parents:
35620
diff
changeset
|
199 standard File Selection dialog of that toolkit instead of prompting for |
d1a5bb6d3811
(Visiting): Document the file selection dialog popped by C-x C-f.
Eli Zaretskii <eliz@gnu.org>
parents:
35620
diff
changeset
|
200 the file name in the minibuffer. On Unix and GNU/Linux platforms, Emacs |
d1a5bb6d3811
(Visiting): Document the file selection dialog popped by C-x C-f.
Eli Zaretskii <eliz@gnu.org>
parents:
35620
diff
changeset
|
201 does that when built with LessTif and Motif toolkits; on MS-Windows, the |
d1a5bb6d3811
(Visiting): Document the file selection dialog popped by C-x C-f.
Eli Zaretskii <eliz@gnu.org>
parents:
35620
diff
changeset
|
202 GUI version does that by default. |
d1a5bb6d3811
(Visiting): Document the file selection dialog popped by C-x C-f.
Eli Zaretskii <eliz@gnu.org>
parents:
35620
diff
changeset
|
203 |
25829 | 204 Your confirmation that @kbd{C-x C-f} has completed successfully is the |
205 appearance of new text on the screen and a new buffer name in the mode | |
206 line. If the specified file does not exist and could not be created, or | |
207 cannot be read, then you get an error, with an error message displayed | |
208 in the echo area. | |
209 | |
210 If you visit a file that is already in Emacs, @kbd{C-x C-f} does not make | |
211 another copy. It selects the existing buffer containing that file. | |
212 However, before doing so, it checks that the file itself has not changed | |
213 since you visited or saved it last. If the file has changed, a warning | |
214 message is printed. @xref{Interlocking,,Simultaneous Editing}. | |
215 | |
216 @cindex creating files | |
217 What if you want to create a new file? Just visit it. Emacs prints | |
218 @samp{(New File)} in the echo area, but in other respects behaves as if | |
219 you had visited an existing empty file. If you make any changes and | |
220 save them, the file is created. | |
221 | |
222 Emacs recognizes from the contents of a file which convention it uses | |
223 to separate lines---newline (used on GNU/Linux and on Unix), | |
224 carriage-return linefeed (used on Microsoft systems), or just | |
225 carriage-return (used on the Macintosh)---and automatically converts the | |
226 contents to the normal Emacs convention, which is that the newline | |
227 character separates lines. This is a part of the general feature of | |
228 coding system conversion (@pxref{Coding Systems}), and makes it possible | |
229 to edit files imported from various different operating systems with | |
230 equal convenience. If you change the text and save the file, Emacs | |
231 performs the inverse conversion, changing newlines back into | |
232 carriage-return linefeed or just carriage-return if appropriate. | |
233 | |
234 @vindex find-file-run-dired | |
235 If the file you specify is actually a directory, @kbd{C-x C-f} invokes | |
236 Dired, the Emacs directory browser, so that you can ``edit'' the contents | |
237 of the directory (@pxref{Dired}). Dired is a convenient way to delete, | |
238 look at, or operate on the files in the directory. However, if the | |
239 variable @code{find-file-run-dired} is @code{nil}, then it is an error | |
240 to try to visit a directory. | |
241 | |
36326
70c08680c0bf
(Visiting): Add a note about visiting file archives.
Eli Zaretskii <eliz@gnu.org>
parents:
36325
diff
changeset
|
242 Files which are actually collections of other files, or @dfn{file |
70c08680c0bf
(Visiting): Add a note about visiting file archives.
Eli Zaretskii <eliz@gnu.org>
parents:
36325
diff
changeset
|
243 archives}, are visited in special modes which invoke a Dired-like |
70c08680c0bf
(Visiting): Add a note about visiting file archives.
Eli Zaretskii <eliz@gnu.org>
parents:
36325
diff
changeset
|
244 environment to allow operations on archive members. @xref{File |
70c08680c0bf
(Visiting): Add a note about visiting file archives.
Eli Zaretskii <eliz@gnu.org>
parents:
36325
diff
changeset
|
245 Archives}, for more about these features. |
70c08680c0bf
(Visiting): Add a note about visiting file archives.
Eli Zaretskii <eliz@gnu.org>
parents:
36325
diff
changeset
|
246 |
28327
f7b17a6af3db
(Visiting): List wildcard chars. Mention find-file-wildcards.
Dave Love <fx@gnu.org>
parents:
28123
diff
changeset
|
247 @cindex wildcard characters in file names |
f7b17a6af3db
(Visiting): List wildcard chars. Mention find-file-wildcards.
Dave Love <fx@gnu.org>
parents:
28123
diff
changeset
|
248 @vindex find-file-wildcards |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
249 If the file name you specify contains shell-style wildcard |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
250 characters, Emacs visits all the files that match it. Wildcards |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
251 comprise @samp{?}, @samp{*} and @samp{[@dots{}]} sequences. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
252 @xref{Quoted File Names}, for how to visit a file whose name actually |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
253 contains wildcard characters. You can disable the wildcard feature by |
28327
f7b17a6af3db
(Visiting): List wildcard chars. Mention find-file-wildcards.
Dave Love <fx@gnu.org>
parents:
28123
diff
changeset
|
254 customizing @code{find-file-wildcards}. |
25829 | 255 |
256 If you visit a file that the operating system won't let you modify, | |
257 Emacs makes the buffer read-only, so that you won't go ahead and make | |
258 changes that you'll have trouble saving afterward. You can make the | |
259 buffer writable with @kbd{C-x C-q} (@code{vc-toggle-read-only}). | |
260 @xref{Misc Buffer}. | |
261 | |
262 @kindex C-x C-r | |
263 @findex find-file-read-only | |
264 Occasionally you might want to visit a file as read-only in order to | |
265 protect yourself from entering changes accidentally; do so by visiting | |
266 the file with the command @kbd{C-x C-r} (@code{find-file-read-only}). | |
267 | |
268 @kindex C-x C-v | |
269 @findex find-alternate-file | |
270 If you visit a nonexistent file unintentionally (because you typed the | |
271 wrong file name), use the @kbd{C-x C-v} command | |
272 (@code{find-alternate-file}) to visit the file you really wanted. | |
273 @kbd{C-x C-v} is similar to @kbd{C-x C-f}, but it kills the current | |
274 buffer (after first offering to save it if it is modified). When it | |
275 reads the file name to visit, it inserts the entire default file name in | |
276 the buffer, with point just after the directory part; this is convenient | |
277 if you made a slight error in typing the name. | |
278 | |
279 If you find a file which exists but cannot be read, @kbd{C-x C-f} | |
280 signals an error. | |
281 | |
282 @kindex C-x 4 f | |
283 @findex find-file-other-window | |
284 @kbd{C-x 4 f} (@code{find-file-other-window}) is like @kbd{C-x C-f} | |
285 except that the buffer containing the specified file is selected in another | |
286 window. The window that was selected before @kbd{C-x 4 f} continues to | |
287 show the same buffer it was already showing. If this command is used when | |
288 only one window is being displayed, that window is split in two, with one | |
289 window showing the same buffer as before, and the other one showing the | |
290 newly requested file. @xref{Windows}. | |
291 | |
292 @kindex C-x 5 f | |
293 @findex find-file-other-frame | |
294 @kbd{C-x 5 f} (@code{find-file-other-frame}) is similar, but opens a | |
295 new frame, or makes visible any existing frame showing the file you | |
296 seek. This feature is available only when you are using a window | |
297 system. @xref{Frames}. | |
298 | |
299 @findex find-file-literally | |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
300 If you wish to edit a file as a sequence of ASCII characters with no special |
25829 | 301 encoding or conversion, use the @kbd{M-x find-file-literally} command. |
302 It visits a file, like @kbd{C-x C-f}, but does not do format conversion | |
303 (@pxref{Formatted Text}), character code conversion (@pxref{Coding | |
33559 | 304 Systems}), or automatic uncompression (@pxref{Compressed Files}), and |
305 does not add a final newline because of @code{require-final-newline}. | |
25829 | 306 If you already have visited the same file in the usual (non-literal) |
307 manner, this command asks you whether to visit it literally instead. | |
308 | |
309 @vindex find-file-hooks | |
310 @vindex find-file-not-found-hooks | |
311 Two special hook variables allow extensions to modify the operation of | |
312 visiting files. Visiting a file that does not exist runs the functions | |
313 in the list @code{find-file-not-found-hooks}; this variable holds a list | |
314 of functions, and the functions are called one by one (with no | |
315 arguments) until one of them returns non-@code{nil}. This is not a | |
316 normal hook, and the name ends in @samp{-hooks} rather than @samp{-hook} | |
317 to indicate that fact. | |
318 | |
319 Any visiting of a file, whether extant or not, expects | |
320 @code{find-file-hooks} to contain a list of functions, and calls them | |
321 all, one by one, with no arguments. This variable is really a normal | |
322 hook, but it has an abnormal name for historical compatibility. In the | |
323 case of a nonexistent file, the @code{find-file-not-found-hooks} are run | |
324 first. @xref{Hooks}. | |
325 | |
326 There are several ways to specify automatically the major mode for | |
327 editing the file (@pxref{Choosing Modes}), and to specify local | |
328 variables defined for that file (@pxref{File Variables}). | |
329 | |
330 @node Saving | |
331 @section Saving Files | |
332 | |
333 @dfn{Saving} a buffer in Emacs means writing its contents back into the file | |
334 that was visited in the buffer. | |
335 | |
336 @table @kbd | |
337 @item C-x C-s | |
338 Save the current buffer in its visited file (@code{save-buffer}). | |
339 @item C-x s | |
340 Save any or all buffers in their visited files (@code{save-some-buffers}). | |
341 @item M-~ | |
342 Forget that the current buffer has been changed (@code{not-modified}). | |
29556 | 343 With prefix argument (@kbd{C-u}), mark the current buffer as changed. |
25829 | 344 @item C-x C-w |
345 Save the current buffer in a specified file (@code{write-file}). | |
346 @item M-x set-visited-file-name | |
36316
d79558eaaecb
(Saveing): Fix "file the name". From Nelson H. F. Beebe
Eli Zaretskii <eliz@gnu.org>
parents:
36274
diff
changeset
|
347 Change the file name under which the current buffer will be saved. |
25829 | 348 @end table |
349 | |
350 @kindex C-x C-s | |
351 @findex save-buffer | |
352 When you wish to save the file and make your changes permanent, type | |
353 @kbd{C-x C-s} (@code{save-buffer}). After saving is finished, @kbd{C-x C-s} | |
354 displays a message like this: | |
355 | |
356 @example | |
357 Wrote /u/rms/gnu/gnu.tasks | |
358 @end example | |
359 | |
360 @noindent | |
361 If the selected buffer is not modified (no changes have been made in it | |
362 since the buffer was created or last saved), saving is not really done, | |
363 because it would have no effect. Instead, @kbd{C-x C-s} displays a message | |
364 like this in the echo area: | |
365 | |
366 @example | |
367 (No changes need to be saved) | |
368 @end example | |
369 | |
370 @kindex C-x s | |
371 @findex save-some-buffers | |
372 The command @kbd{C-x s} (@code{save-some-buffers}) offers to save any | |
373 or all modified buffers. It asks you what to do with each buffer. The | |
374 possible responses are analogous to those of @code{query-replace}: | |
375 | |
376 @table @kbd | |
377 @item y | |
378 Save this buffer and ask about the rest of the buffers. | |
379 @item n | |
380 Don't save this buffer, but ask about the rest of the buffers. | |
381 @item ! | |
382 Save this buffer and all the rest with no more questions. | |
383 @c following generates acceptable underfull hbox | |
384 @item @key{RET} | |
385 Terminate @code{save-some-buffers} without any more saving. | |
386 @item . | |
387 Save this buffer, then exit @code{save-some-buffers} without even asking | |
388 about other buffers. | |
389 @item C-r | |
390 View the buffer that you are currently being asked about. When you exit | |
391 View mode, you get back to @code{save-some-buffers}, which asks the | |
392 question again. | |
393 @item C-h | |
394 Display a help message about these options. | |
395 @end table | |
396 | |
397 @kbd{C-x C-c}, the key sequence to exit Emacs, invokes | |
398 @code{save-some-buffers} and therefore asks the same questions. | |
399 | |
400 @kindex M-~ | |
401 @findex not-modified | |
402 If you have changed a buffer but you do not want to save the changes, | |
403 you should take some action to prevent it. Otherwise, each time you use | |
404 @kbd{C-x s} or @kbd{C-x C-c}, you are liable to save this buffer by | |
405 mistake. One thing you can do is type @kbd{M-~} (@code{not-modified}), | |
406 which clears out the indication that the buffer is modified. If you do | |
407 this, none of the save commands will believe that the buffer needs to be | |
408 saved. (@samp{~} is often used as a mathematical symbol for `not'; thus | |
409 @kbd{M-~} is `not', metafied.) You could also use | |
410 @code{set-visited-file-name} (see below) to mark the buffer as visiting | |
411 a different file name, one which is not in use for anything important. | |
412 Alternatively, you can cancel all the changes made since the file was | |
413 visited or saved, by reading the text from the file again. This is | |
414 called @dfn{reverting}. @xref{Reverting}. You could also undo all the | |
415 changes by repeating the undo command @kbd{C-x u} until you have undone | |
416 all the changes; but reverting is easier. | |
417 | |
418 @findex set-visited-file-name | |
419 @kbd{M-x set-visited-file-name} alters the name of the file that the | |
420 current buffer is visiting. It reads the new file name using the | |
421 minibuffer. Then it specifies the visited file name and changes the | |
422 buffer name correspondingly (as long as the new name is not in use). | |
423 @code{set-visited-file-name} does not save the buffer in the newly | |
424 visited file; it just alters the records inside Emacs in case you do | |
425 save later. It also marks the buffer as ``modified'' so that @kbd{C-x | |
426 C-s} in that buffer @emph{will} save. | |
427 | |
428 @kindex C-x C-w | |
429 @findex write-file | |
430 If you wish to mark the buffer as visiting a different file and save it | |
431 right away, use @kbd{C-x C-w} (@code{write-file}). It is precisely | |
432 equivalent to @code{set-visited-file-name} followed by @kbd{C-x C-s}. | |
433 @kbd{C-x C-s} used on a buffer that is not visiting a file has the | |
434 same effect as @kbd{C-x C-w}; that is, it reads a file name, marks the | |
435 buffer as visiting that file, and saves it there. The default file name in | |
436 a buffer that is not visiting a file is made by combining the buffer name | |
437 with the buffer's default directory. | |
438 | |
439 If the new file name implies a major mode, then @kbd{C-x C-w} switches | |
440 to that major mode, in most cases. The command | |
441 @code{set-visited-file-name} also does this. @xref{Choosing Modes}. | |
442 | |
443 If Emacs is about to save a file and sees that the date of the latest | |
444 version on disk does not match what Emacs last read or wrote, Emacs | |
445 notifies you of this fact, because it probably indicates a problem caused | |
446 by simultaneous editing and requires your immediate attention. | |
447 @xref{Interlocking,, Simultaneous Editing}. | |
448 | |
449 @vindex require-final-newline | |
36319
77c56d3f0b8f
(Saving): Update the documentation of require-final-newline.
Eli Zaretskii <eliz@gnu.org>
parents:
36316
diff
changeset
|
450 If the value of the variable @code{require-final-newline} is @code{t}, |
77c56d3f0b8f
(Saving): Update the documentation of require-final-newline.
Eli Zaretskii <eliz@gnu.org>
parents:
36316
diff
changeset
|
451 Emacs silently puts a newline at the end of any file that doesn't |
77c56d3f0b8f
(Saving): Update the documentation of require-final-newline.
Eli Zaretskii <eliz@gnu.org>
parents:
36316
diff
changeset
|
452 already end in one, every time a file is saved or written. If the value |
77c56d3f0b8f
(Saving): Update the documentation of require-final-newline.
Eli Zaretskii <eliz@gnu.org>
parents:
36316
diff
changeset
|
453 is @code{nil}, Emacs leaves the end of the file unchanged; if it's |
77c56d3f0b8f
(Saving): Update the documentation of require-final-newline.
Eli Zaretskii <eliz@gnu.org>
parents:
36316
diff
changeset
|
454 neither @code{nil} nor @code{t}, Emacs asks you whether to add a |
77c56d3f0b8f
(Saving): Update the documentation of require-final-newline.
Eli Zaretskii <eliz@gnu.org>
parents:
36316
diff
changeset
|
455 newline. The default is @code{nil}. |
25829 | 456 |
457 @menu | |
458 * Backup:: How Emacs saves the old version of your file. | |
459 * Interlocking:: How Emacs protects against simultaneous editing | |
460 of one file by two users. | |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
461 * Shadowing: File Shadowing. |
36185 | 462 Copying files to "shadows" automatically. |
35524 | 463 * Time Stamps:: Emacs can update time stamps on saved files. |
25829 | 464 @end menu |
465 | |
466 @node Backup | |
467 @subsection Backup Files | |
468 @cindex backup file | |
469 @vindex make-backup-files | |
470 @vindex vc-make-backup-files | |
471 | |
472 On most operating systems, rewriting a file automatically destroys all | |
473 record of what the file used to contain. Thus, saving a file from Emacs | |
474 throws away the old contents of the file---or it would, except that | |
475 Emacs carefully copies the old contents to another file, called the | |
476 @dfn{backup} file, before actually saving. | |
477 | |
478 For most files, the variable @code{make-backup-files} determines | |
479 whether to make backup files. On most operating systems, its default | |
480 value is @code{t}, so that Emacs does write backup files. | |
481 | |
482 For files managed by a version control system (@pxref{Version | |
483 Control}), the variable @code{vc-make-backup-files} determines whether | |
484 to make backup files. By default, it is @code{nil}, since backup files | |
485 are redundant when you store all the previous versions in a version | |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
486 control system. @xref{General VC Options}. |
25829 | 487 |
28526
297e03ccd7e6
(Backup): backup-enable-predicate.
Dave Love <fx@gnu.org>
parents:
28327
diff
changeset
|
488 @vindex backup-enable-predicate |
297e03ccd7e6
(Backup): backup-enable-predicate.
Dave Love <fx@gnu.org>
parents:
28327
diff
changeset
|
489 @vindex temporary-file-directory |
297e03ccd7e6
(Backup): backup-enable-predicate.
Dave Love <fx@gnu.org>
parents:
28327
diff
changeset
|
490 @vindex small-temporary-file-directory |
25829 | 491 The default value of the @code{backup-enable-predicate} variable |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
492 prevents backup files being written for files in the directories used |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
493 for temporary files, specified by @code{temporary-file-directory} or |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
494 @code{small-temporary-file-directory}. |
25829 | 495 |
496 At your option, Emacs can keep either a single backup file or a series of | |
497 numbered backup files for each file that you edit. | |
498 | |
499 Emacs makes a backup for a file only the first time the file is saved | |
500 from one buffer. No matter how many times you save a file, its backup file | |
501 continues to contain the contents from before the file was visited. | |
502 Normally this means that the backup file contains the contents from before | |
503 the current editing session; however, if you kill the buffer and then visit | |
504 the file again, a new backup file will be made by the next save. | |
505 | |
506 You can also explicitly request making another backup file from a | |
507 buffer even though it has already been saved at least once. If you save | |
508 the buffer with @kbd{C-u C-x C-s}, the version thus saved will be made | |
509 into a backup file if you save the buffer again. @kbd{C-u C-u C-x C-s} | |
510 saves the buffer, but first makes the previous file contents into a new | |
511 backup file. @kbd{C-u C-u C-u C-x C-s} does both things: it makes a | |
512 backup from the previous contents, and arranges to make another from the | |
513 newly saved contents, if you save again. | |
514 | |
515 @menu | |
516 * Names: Backup Names. How backup files are named; | |
517 choosing single or numbered backup files. | |
518 * Deletion: Backup Deletion. Emacs deletes excess numbered backups. | |
519 * Copying: Backup Copying. Backups can be made by copying or renaming. | |
520 @end menu | |
521 | |
522 @node Backup Names | |
523 @subsubsection Single or Numbered Backups | |
524 | |
525 If you choose to have a single backup file (this is the default), | |
28526
297e03ccd7e6
(Backup): backup-enable-predicate.
Dave Love <fx@gnu.org>
parents:
28327
diff
changeset
|
526 the backup file's name is normally constructed by appending @samp{~} to the |
25829 | 527 file name being edited; thus, the backup file for @file{eval.c} would |
528 be @file{eval.c~}. | |
529 | |
28526
297e03ccd7e6
(Backup): backup-enable-predicate.
Dave Love <fx@gnu.org>
parents:
28327
diff
changeset
|
530 @vindex make-backup-file-name-function |
297e03ccd7e6
(Backup): backup-enable-predicate.
Dave Love <fx@gnu.org>
parents:
28327
diff
changeset
|
531 @vindex backup-directory-alist |
297e03ccd7e6
(Backup): backup-enable-predicate.
Dave Love <fx@gnu.org>
parents:
28327
diff
changeset
|
532 You can change this behaviour by defining the variable |
297e03ccd7e6
(Backup): backup-enable-predicate.
Dave Love <fx@gnu.org>
parents:
28327
diff
changeset
|
533 @code{make-backup-file-name-function} to a suitable function. |
297e03ccd7e6
(Backup): backup-enable-predicate.
Dave Love <fx@gnu.org>
parents:
28327
diff
changeset
|
534 Alternatively you can customize the variable |
36874 | 535 @code{backup-directory-alist} to specify that files matching certain |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
536 patterns should be backed up in specific directories. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
537 |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
538 A typical use is to add an element @code{("." . @var{dir})} to make |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
539 all backups in the directory with absolute name @var{dir}; Emacs |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
540 modifies the backup file names to avoid clashes between files with the |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
541 same names originating in different directories. Alternatively, |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
542 adding, say, @code{("." ".~")} would make backups in the invisible |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
543 subdirectory @file{.~} of the original file's directory. Emacs |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
544 creates the directory, if necessary, to make the backup. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
545 |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
546 If access control stops Emacs from writing backup files under the usual |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
547 names, it writes the backup file as @file{%backup%~} in your home |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
548 directory. Only one such file can exist, so only the most recently |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
549 made such backup is available. |
28526
297e03ccd7e6
(Backup): backup-enable-predicate.
Dave Love <fx@gnu.org>
parents:
28327
diff
changeset
|
550 |
25829 | 551 If you choose to have a series of numbered backup files, backup file |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
552 names contain @samp{.~}, the number, and another @samp{~} after the |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
553 original file name. Thus, the backup files of @file{eval.c} would be |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
554 called @file{eval.c.~1~}, @file{eval.c.~2~}, and so on, all the way |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
555 through names like @file{eval.c.~259~} and beyond. The variable |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
556 @code{backup-directory-alist} applies to numbered backups just as |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
557 usual. |
25829 | 558 |
559 @vindex version-control | |
560 The choice of single backup or numbered backups is controlled by the | |
561 variable @code{version-control}. Its possible values are | |
562 | |
563 @table @code | |
564 @item t | |
565 Make numbered backups. | |
566 @item nil | |
567 Make numbered backups for files that have numbered backups already. | |
568 Otherwise, make single backups. | |
569 @item never | |
36322
b95226aa58b9
(Backup names): Fix "Do not in any case". From Nelson H. F. Beebe
Eli Zaretskii <eliz@gnu.org>
parents:
36319
diff
changeset
|
570 Never make numbered backups; always make single backups. |
25829 | 571 @end table |
572 | |
573 @noindent | |
574 You can set @code{version-control} locally in an individual buffer to | |
575 control the making of backups for that buffer's file. For example, | |
576 Rmail mode locally sets @code{version-control} to @code{never} to make sure | |
577 that there is only one backup for an Rmail file. @xref{Locals}. | |
578 | |
29107 | 579 @cindex @env{VERSION_CONTROL} environment variable |
580 If you set the environment variable @env{VERSION_CONTROL}, to tell | |
25829 | 581 various GNU utilities what to do with backup files, Emacs also obeys the |
582 environment variable by setting the Lisp variable @code{version-control} | |
583 accordingly at startup. If the environment variable's value is @samp{t} | |
584 or @samp{numbered}, then @code{version-control} becomes @code{t}; if the | |
585 value is @samp{nil} or @samp{existing}, then @code{version-control} | |
586 becomes @code{nil}; if it is @samp{never} or @samp{simple}, then | |
587 @code{version-control} becomes @code{never}. | |
588 | |
589 @node Backup Deletion | |
590 @subsubsection Automatic Deletion of Backups | |
591 | |
592 To prevent unlimited consumption of disk space, Emacs can delete numbered | |
593 backup versions automatically. Generally Emacs keeps the first few backups | |
594 and the latest few backups, deleting any in between. This happens every | |
595 time a new backup is made. | |
596 | |
597 @vindex kept-old-versions | |
598 @vindex kept-new-versions | |
599 The two variables @code{kept-old-versions} and | |
600 @code{kept-new-versions} control this deletion. Their values are, | |
601 respectively the number of oldest (lowest-numbered) backups to keep and | |
602 the number of newest (highest-numbered) ones to keep, each time a new | |
603 backup is made. Recall that these values are used just after a new | |
604 backup version is made; that newly made backup is included in the count | |
605 in @code{kept-new-versions}. By default, both variables are 2. | |
606 | |
607 @vindex delete-old-versions | |
608 If @code{delete-old-versions} is non-@code{nil}, the excess | |
609 middle versions are deleted without a murmur. If it is @code{nil}, the | |
610 default, then you are asked whether the excess middle versions should | |
611 really be deleted. | |
612 | |
613 Dired's @kbd{.} (Period) command can also be used to delete old versions. | |
614 @xref{Dired Deletion}. | |
615 | |
616 @node Backup Copying | |
617 @subsubsection Copying vs.@: Renaming | |
618 | |
619 Backup files can be made by copying the old file or by renaming it. This | |
620 makes a difference when the old file has multiple names. If the old file | |
621 is renamed into the backup file, then the alternate names become names for | |
622 the backup file. If the old file is copied instead, then the alternate | |
623 names remain names for the file that you are editing, and the contents | |
624 accessed by those names will be the new contents. | |
625 | |
626 The method of making a backup file may also affect the file's owner | |
627 and group. If copying is used, these do not change. If renaming is used, | |
628 you become the file's owner, and the file's group becomes the default | |
629 (different operating systems have different defaults for the group). | |
630 | |
631 Having the owner change is usually a good idea, because then the owner | |
632 always shows who last edited the file. Also, the owners of the backups | |
633 show who produced those versions. Occasionally there is a file whose | |
634 owner should not change; it is a good idea for such files to contain | |
635 local variable lists to set @code{backup-by-copying-when-mismatch} | |
636 locally (@pxref{File Variables}). | |
637 | |
638 @vindex backup-by-copying | |
639 @vindex backup-by-copying-when-linked | |
640 @vindex backup-by-copying-when-mismatch | |
31043
31a21ae1de1f
Document backup-by-copying-when-privileged-mismatch.
Eli Zaretskii <eliz@gnu.org>
parents:
29683
diff
changeset
|
641 @vindex backup-by-copying-when-privileged-mismatch |
31a21ae1de1f
Document backup-by-copying-when-privileged-mismatch.
Eli Zaretskii <eliz@gnu.org>
parents:
29683
diff
changeset
|
642 @cindex file ownership, and backup |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
643 @cindex backup, and user-id |
31043
31a21ae1de1f
Document backup-by-copying-when-privileged-mismatch.
Eli Zaretskii <eliz@gnu.org>
parents:
29683
diff
changeset
|
644 The choice of renaming or copying is controlled by four variables. |
25829 | 645 Renaming is the default choice. If the variable |
646 @code{backup-by-copying} is non-@code{nil}, copying is used. Otherwise, | |
647 if the variable @code{backup-by-copying-when-linked} is non-@code{nil}, | |
648 then copying is used for files that have multiple names, but renaming | |
649 may still be used when the file being edited has only one name. If the | |
650 variable @code{backup-by-copying-when-mismatch} is non-@code{nil}, then | |
651 copying is used if renaming would cause the file's owner or group to | |
652 change. @code{backup-by-copying-when-mismatch} is @code{t} by default | |
31043
31a21ae1de1f
Document backup-by-copying-when-privileged-mismatch.
Eli Zaretskii <eliz@gnu.org>
parents:
29683
diff
changeset
|
653 if you start Emacs as the superuser. The fourth variable, |
31a21ae1de1f
Document backup-by-copying-when-privileged-mismatch.
Eli Zaretskii <eliz@gnu.org>
parents:
29683
diff
changeset
|
654 @code{backup-by-copying-when-privileged-mismatch}, gives the highest |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
655 numeric user-id for which @code{backup-by-copying-when-mismatch} will be |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
656 forced on. This is useful when low-numbered user-id are assigned to |
31043
31a21ae1de1f
Document backup-by-copying-when-privileged-mismatch.
Eli Zaretskii <eliz@gnu.org>
parents:
29683
diff
changeset
|
657 special system users, such as @code{root}, @code{bin}, @code{daemon}, |
31a21ae1de1f
Document backup-by-copying-when-privileged-mismatch.
Eli Zaretskii <eliz@gnu.org>
parents:
29683
diff
changeset
|
658 etc., which must maintain ownership of files. |
25829 | 659 |
660 When a file is managed with a version control system (@pxref{Version | |
661 Control}), Emacs does not normally make backups in the usual way for | |
662 that file. But check-in and check-out are similar in some ways to | |
663 making backups. One unfortunate similarity is that these operations | |
664 typically break hard links, disconnecting the file name you visited from | |
665 any alternate names for the same file. This has nothing to do with | |
666 Emacs---the version control system does it. | |
667 | |
668 @node Interlocking | |
669 @subsection Protection against Simultaneous Editing | |
670 | |
671 @cindex file dates | |
672 @cindex simultaneous editing | |
673 Simultaneous editing occurs when two users visit the same file, both | |
674 make changes, and then both save them. If nobody were informed that | |
675 this was happening, whichever user saved first would later find that his | |
676 changes were lost. | |
677 | |
678 On some systems, Emacs notices immediately when the second user starts | |
679 to change the file, and issues an immediate warning. On all systems, | |
680 Emacs checks when you save the file, and warns if you are about to | |
681 overwrite another user's changes. You can prevent loss of the other | |
682 user's work by taking the proper corrective action instead of saving the | |
683 file. | |
684 | |
685 @findex ask-user-about-lock | |
686 @cindex locking files | |
687 When you make the first modification in an Emacs buffer that is | |
688 visiting a file, Emacs records that the file is @dfn{locked} by you. | |
689 (It does this by creating a symbolic link in the same directory with a | |
690 different name.) Emacs removes the lock when you save the changes. The | |
691 idea is that the file is locked whenever an Emacs buffer visiting it has | |
692 unsaved changes. | |
693 | |
694 @cindex collision | |
695 If you begin to modify the buffer while the visited file is locked by | |
696 someone else, this constitutes a @dfn{collision}. When Emacs detects a | |
697 collision, it asks you what to do, by calling the Lisp function | |
698 @code{ask-user-about-lock}. You can redefine this function for the sake | |
699 of customization. The standard definition of this function asks you a | |
700 question and accepts three possible answers: | |
701 | |
702 @table @kbd | |
703 @item s | |
704 Steal the lock. Whoever was already changing the file loses the lock, | |
705 and you gain the lock. | |
706 @item p | |
707 Proceed. Go ahead and edit the file despite its being locked by someone else. | |
708 @item q | |
709 Quit. This causes an error (@code{file-locked}) and the modification you | |
710 were trying to make in the buffer does not actually take place. | |
711 @end table | |
712 | |
713 Note that locking works on the basis of a file name; if a file has | |
714 multiple names, Emacs does not realize that the two names are the same file | |
715 and cannot prevent two users from editing it simultaneously under different | |
716 names. However, basing locking on names means that Emacs can interlock the | |
717 editing of new files that will not really exist until they are saved. | |
718 | |
719 Some systems are not configured to allow Emacs to make locks, and | |
720 there are cases where lock files cannot be written. In these cases, | |
721 Emacs cannot detect trouble in advance, but it still can detect the | |
722 collision when you try to save a file and overwrite someone else's | |
723 changes. | |
724 | |
725 If Emacs or the operating system crashes, this may leave behind lock | |
36327
f32c31c60f60
(Interlocking): Fix wording of "So you may".
Eli Zaretskii <eliz@gnu.org>
parents:
36326
diff
changeset
|
726 files which are stale, so you may occasionally get warnings about |
25829 | 727 spurious collisions. When you determine that the collision is spurious, |
728 just use @kbd{p} to tell Emacs to go ahead anyway. | |
729 | |
730 Every time Emacs saves a buffer, it first checks the last-modification | |
731 date of the existing file on disk to verify that it has not changed since the | |
732 file was last visited or saved. If the date does not match, it implies | |
733 that changes were made in the file in some other way, and these changes are | |
734 about to be lost if Emacs actually does save. To prevent this, Emacs | |
735 prints a warning message and asks for confirmation before saving. | |
736 Occasionally you will know why the file was changed and know that it does | |
737 not matter; then you can answer @kbd{yes} and proceed. Otherwise, you should | |
738 cancel the save with @kbd{C-g} and investigate the situation. | |
739 | |
740 The first thing you should do when notified that simultaneous editing | |
741 has already taken place is to list the directory with @kbd{C-u C-x C-d} | |
742 (@pxref{Directories}). This shows the file's current author. You | |
743 should attempt to contact him to warn him not to continue editing. | |
744 Often the next step is to save the contents of your Emacs buffer under a | |
745 different name, and use @code{diff} to compare the two files.@refill | |
746 | |
31076 | 747 @node File Shadowing |
748 @subsection Shadowing Files | |
749 @cindex shadow files | |
750 @cindex file shadows | |
751 | |
752 @table @kbd | |
753 @item M-x shadow-initialize | |
754 Set up file shadowing. | |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
755 @item M-x shadow-define-literal-group |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
756 Declare a single file to be shared between sites. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
757 @item M-x shadow-define-regexp-group |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
758 Make all files that match each of a group of files be shared between hosts. |
31076 | 759 @item M-x shadow-define-cluster @key{RET} @var{name} @key{RET} |
760 Define a shadow file cluster @var{name}. | |
761 @item M-x shadow-copy-files | |
762 Copy all pending shadow files. | |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
763 @item M-x shadow-cancel |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
764 Cancel the instruction to shadow some files. |
31076 | 765 @end table |
766 | |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
767 You can arrange to keep identical @dfn{shadow} copies of certain files |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
768 in more than one place---possibly on different machines. To do this, |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
769 first you must set up a @dfn{shadow file group}, which is a set of |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
770 identically-named files shared between a list of sites. The file |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
771 group is permanent and applies to further Emacs sessions as well as |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
772 the current one. Once the group is set up, every time you exit Emacs, |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
773 it will copy the file you edited to the other files in its group. You |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
774 can also do the copying without exiting Emacs, by typing @kbd{M-x |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
775 shadow-copy-files}. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
776 |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
777 To set up a file group, use @kbd{M-x shadow-define-literal-group} or |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
778 @kbd{M-x shadow-define-regexp-group}. See their documentation strings |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
779 for further information. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
780 |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
781 Before copying a file to its shadows, Emacs asks for confirmation. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
782 You can answer ``no'' to bypass copying of this file, this time. If |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
783 you want to cancel the shadowing permanently for a certain file, use |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
784 @kbd{M-x shadow-cancel} to eliminate or change the shadow file group. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
785 |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
786 A @dfn{shadow cluster} is a group of hosts that share directories, so |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
787 that copying to or from one of them is sufficient to update the file |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
788 on all of them. Each shadow cluster has a name, and specifies the |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
789 network address of a primary host (the one we copy files to), and a |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
790 regular expression that matches the hostnames of all the other hosts |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
791 in the cluster. You can define a shadow cluster with @kbd{M-x |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
792 shadow-define-cluster}. |
31076 | 793 |
35524 | 794 @node Time Stamps |
795 @subsection Updating Time Stamps Automatically | |
796 @findex time-stamp | |
797 @cindex time stamps | |
798 @cindex modification dates | |
35620 | 799 @cindex locale, date format |
35524 | 800 |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
801 You can arrange put a time stamp in a file, so that it will be updated |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
802 automatically each time you edit and save the file. The time stamp |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
803 has to be in the first eight lines of the file, and you should |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
804 insert it like this: |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
805 |
35524 | 806 @example |
807 Time-stamp: <> | |
808 @end example | |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
809 |
35524 | 810 @noindent |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
811 or like this: |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
812 |
35524 | 813 @example |
814 Time-stamp: "" | |
815 @end example | |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
816 |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
817 Then add the hook function @code{time-stamp} to the hook |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
818 @code{write-file-hooks}; that hook function will automatically update |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
819 the time stamp, inserting the current date and time when you save the |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
820 file. You can also use the command @kbd{M-x time-stamp} to update the |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
821 time stamp manually. For other customizations, see the Custom group |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
822 @code{time-stamp}. Note that non-numeric fields in the time stamp are |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
823 formatted according to your locale setting (@pxref{Environment}). |
35524 | 824 |
25829 | 825 @node Reverting |
826 @section Reverting a Buffer | |
827 @findex revert-buffer | |
828 @cindex drastic changes | |
36547
4dff107cf2a1
(Reverting): Add an index entry "reread a file".
Eli Zaretskii <eliz@gnu.org>
parents:
36402
diff
changeset
|
829 @cindex reread a file |
25829 | 830 |
831 If you have made extensive changes to a file and then change your mind | |
832 about them, you can get rid of them by reading in the previous version | |
833 of the file. To do this, use @kbd{M-x revert-buffer}, which operates on | |
834 the current buffer. Since reverting a buffer unintentionally could lose | |
835 a lot of work, you must confirm this command with @kbd{yes}. | |
836 | |
837 @code{revert-buffer} keeps point at the same distance (measured in | |
838 characters) from the beginning of the file. If the file was edited only | |
839 slightly, you will be at approximately the same piece of text after | |
840 reverting as before. If you have made drastic changes, the same value of | |
841 point in the old file may address a totally different piece of text. | |
842 | |
843 Reverting marks the buffer as ``not modified'' until another change is | |
844 made. | |
845 | |
846 Some kinds of buffers whose contents reflect data bases other than files, | |
847 such as Dired buffers, can also be reverted. For them, reverting means | |
848 recalculating their contents from the appropriate data base. Buffers | |
849 created explicitly with @kbd{C-x b} cannot be reverted; @code{revert-buffer} | |
850 reports an error when asked to do so. | |
851 | |
852 @vindex revert-without-query | |
853 When you edit a file that changes automatically and frequently---for | |
854 example, a log of output from a process that continues to run---it may be | |
855 useful for Emacs to revert the file without querying you, whenever you | |
856 visit the file again with @kbd{C-x C-f}. | |
857 | |
858 To request this behavior, set the variable @code{revert-without-query} | |
859 to a list of regular expressions. When a file name matches one of these | |
860 regular expressions, @code{find-file} and @code{revert-buffer} will | |
861 revert it automatically if it has changed---provided the buffer itself | |
862 is not modified. (If you have edited the text, it would be wrong to | |
863 discard your changes.) | |
864 | |
36874 | 865 @cindex Global Auto-Revert mode |
866 @cindex mode, Global Auto-Revert | |
867 @cindex Auto-Revert mode | |
868 @cindex mode, Auto-Revert | |
869 @findex global-auto-revert-mode | |
870 @findex auto-revert-mode | |
871 @vindex auto-revert-interval | |
872 You may find it useful to have Emacs revert files automatically when | |
873 they change. Two minor modes are available to do this. In Global | |
874 Auto-Revert mode, Emacs periodically checks all file buffers and | |
875 reverts any when the corresponding file has changed. The local | |
876 variant, Auto-Revert mode, applies only to buffers in which it was | |
877 activated. Checking the files is done at intervals determined by the | |
878 variable @code{auto-revert-interval}. | |
879 | |
25829 | 880 @node Auto Save |
881 @section Auto-Saving: Protection Against Disasters | |
882 @cindex Auto Save mode | |
883 @cindex mode, Auto Save | |
884 @cindex crashes | |
885 | |
886 Emacs saves all the visited files from time to time (based on counting | |
887 your keystrokes) without being asked. This is called @dfn{auto-saving}. | |
888 It prevents you from losing more than a limited amount of work if the | |
889 system crashes. | |
890 | |
891 When Emacs determines that it is time for auto-saving, each buffer is | |
892 considered, and is auto-saved if auto-saving is turned on for it and it | |
893 has been changed since the last time it was auto-saved. The message | |
894 @samp{Auto-saving...} is displayed in the echo area during auto-saving, | |
895 if any files are actually auto-saved. Errors occurring during | |
896 auto-saving are caught so that they do not interfere with the execution | |
897 of commands you have been typing. | |
898 | |
899 @menu | |
900 * Files: Auto Save Files. The file where auto-saved changes are | |
901 actually made until you save the file. | |
902 * Control: Auto Save Control. Controlling when and how often to auto-save. | |
903 * Recover:: Recovering text from auto-save files. | |
904 @end menu | |
905 | |
906 @node Auto Save Files | |
907 @subsection Auto-Save Files | |
908 | |
909 Auto-saving does not normally save in the files that you visited, because | |
910 it can be very undesirable to save a program that is in an inconsistent | |
911 state when you have made half of a planned change. Instead, auto-saving | |
912 is done in a different file called the @dfn{auto-save file}, and the | |
913 visited file is changed only when you request saving explicitly (such as | |
914 with @kbd{C-x C-s}). | |
915 | |
916 Normally, the auto-save file name is made by appending @samp{#} to the | |
917 front and rear of the visited file name. Thus, a buffer visiting file | |
918 @file{foo.c} is auto-saved in a file @file{#foo.c#}. Most buffers that | |
919 are not visiting files are auto-saved only if you request it explicitly; | |
920 when they are auto-saved, the auto-save file name is made by appending | |
921 @samp{#%} to the front and @samp{#} to the rear of buffer name. For | |
922 example, the @samp{*mail*} buffer in which you compose messages to be | |
923 sent is auto-saved in a file named @file{#%*mail*#}. Auto-save file | |
924 names are made this way unless you reprogram parts of Emacs to do | |
925 something different (the functions @code{make-auto-save-file-name} and | |
926 @code{auto-save-file-name-p}). The file name to be used for auto-saving | |
927 in a buffer is calculated when auto-saving is turned on in that buffer. | |
928 | |
929 When you delete a substantial part of the text in a large buffer, auto | |
930 save turns off temporarily in that buffer. This is because if you | |
931 deleted the text unintentionally, you might find the auto-save file more | |
932 useful if it contains the deleted text. To reenable auto-saving after | |
933 this happens, save the buffer with @kbd{C-x C-s}, or use @kbd{C-u 1 M-x | |
934 auto-save}. | |
935 | |
936 @vindex auto-save-visited-file-name | |
937 If you want auto-saving to be done in the visited file, set the variable | |
938 @code{auto-save-visited-file-name} to be non-@code{nil}. In this mode, | |
939 there is really no difference between auto-saving and explicit saving. | |
940 | |
941 @vindex delete-auto-save-files | |
942 A buffer's auto-save file is deleted when you save the buffer in its | |
943 visited file. To inhibit this, set the variable @code{delete-auto-save-files} | |
944 to @code{nil}. Changing the visited file name with @kbd{C-x C-w} or | |
945 @code{set-visited-file-name} renames any auto-save file to go with | |
946 the new visited name. | |
947 | |
948 @node Auto Save Control | |
949 @subsection Controlling Auto-Saving | |
950 | |
951 @vindex auto-save-default | |
952 @findex auto-save-mode | |
953 Each time you visit a file, auto-saving is turned on for that file's | |
954 buffer if the variable @code{auto-save-default} is non-@code{nil} (but not | |
955 in batch mode; @pxref{Entering Emacs}). The default for this variable is | |
956 @code{t}, so auto-saving is the usual practice for file-visiting buffers. | |
957 Auto-saving can be turned on or off for any existing buffer with the | |
958 command @kbd{M-x auto-save-mode}. Like other minor mode commands, @kbd{M-x | |
959 auto-save-mode} turns auto-saving on with a positive argument, off with a | |
960 zero or negative argument; with no argument, it toggles. | |
961 | |
962 @vindex auto-save-interval | |
963 Emacs does auto-saving periodically based on counting how many characters | |
964 you have typed since the last time auto-saving was done. The variable | |
965 @code{auto-save-interval} specifies how many characters there are between | |
966 auto-saves. By default, it is 300. | |
967 | |
968 @vindex auto-save-timeout | |
969 Auto-saving also takes place when you stop typing for a while. The | |
970 variable @code{auto-save-timeout} says how many seconds Emacs should | |
971 wait before it does an auto save (and perhaps also a garbage | |
972 collection). (The actual time period is longer if the current buffer is | |
973 long; this is a heuristic which aims to keep out of your way when you | |
974 are editing long buffers, in which auto-save takes an appreciable amount | |
975 of time.) Auto-saving during idle periods accomplishes two things: | |
976 first, it makes sure all your work is saved if you go away from the | |
977 terminal for a while; second, it may avoid some auto-saving while you | |
978 are actually typing. | |
979 | |
980 Emacs also does auto-saving whenever it gets a fatal error. This | |
981 includes killing the Emacs job with a shell command such as @samp{kill | |
982 %emacs}, or disconnecting a phone line or network connection. | |
983 | |
984 @findex do-auto-save | |
985 You can request an auto-save explicitly with the command @kbd{M-x | |
986 do-auto-save}. | |
987 | |
988 @node Recover | |
989 @subsection Recovering Data from Auto-Saves | |
990 | |
991 @findex recover-file | |
992 You can use the contents of an auto-save file to recover from a loss | |
993 of data with the command @kbd{M-x recover-file @key{RET} @var{file} | |
994 @key{RET}}. This visits @var{file} and then (after your confirmation) | |
995 restores the contents from its auto-save file @file{#@var{file}#}. | |
996 You can then save with @kbd{C-x C-s} to put the recovered text into | |
997 @var{file} itself. For example, to recover file @file{foo.c} from its | |
998 auto-save file @file{#foo.c#}, do:@refill | |
999 | |
1000 @example | |
1001 M-x recover-file @key{RET} foo.c @key{RET} | |
1002 yes @key{RET} | |
1003 C-x C-s | |
1004 @end example | |
1005 | |
1006 Before asking for confirmation, @kbd{M-x recover-file} displays a | |
1007 directory listing describing the specified file and the auto-save file, | |
1008 so you can compare their sizes and dates. If the auto-save file | |
1009 is older, @kbd{M-x recover-file} does not offer to read it. | |
1010 | |
1011 @findex recover-session | |
1012 If Emacs or the computer crashes, you can recover all the files you | |
1013 were editing from their auto save files with the command @kbd{M-x | |
1014 recover-session}. This first shows you a list of recorded interrupted | |
1015 sessions. Move point to the one you choose, and type @kbd{C-c C-c}. | |
1016 | |
1017 Then @code{recover-session} asks about each of the files that were | |
1018 being edited during that session, asking whether to recover that file. | |
1019 If you answer @kbd{y}, it calls @code{recover-file}, which works in its | |
1020 normal fashion. It shows the dates of the original file and its | |
1021 auto-save file, and asks once again whether to recover that file. | |
1022 | |
1023 When @code{recover-session} is done, the files you've chosen to | |
1024 recover are present in Emacs buffers. You should then save them. Only | |
1025 this---saving them---updates the files themselves. | |
1026 | |
1027 @vindex auto-save-list-file-prefix | |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1028 Emacs records interrupted sessions for later recovery in files named |
31076 | 1029 @file{~/.emacs.d/auto-save-list/.saves-@var{pid}-@var{hostname}}. The |
35337 | 1030 @samp{~/.emacs.d/auto-save-list/.saves-} portion of these names comes |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1031 from the value of @code{auto-save-list-file-prefix}. You can record |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1032 sessions in a different place by customizing that variable. If you |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1033 set @code{auto-save-list-file-prefix} to @code{nil} in your |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1034 @file{.emacs} file, sessions are not recorded for recovery. |
25829 | 1035 |
1036 @node File Aliases | |
1037 @section File Name Aliases | |
1038 | |
1039 Symbolic links and hard links both make it possible for several file | |
1040 names to refer to the same file. Hard links are alternate names that | |
1041 refer directly to the file; all the names are equally valid, and no one | |
1042 of them is preferred. By contrast, a symbolic link is a kind of defined | |
1043 alias: when @file{foo} is a symbolic link to @file{bar}, you can use | |
1044 either name to refer to the file, but @file{bar} is the real name, while | |
1045 @file{foo} is just an alias. More complex cases occur when symbolic | |
1046 links point to directories. | |
1047 | |
1048 If you visit two names for the same file, normally Emacs makes | |
1049 two different buffers, but it warns you about the situation. | |
1050 | |
33278
7b666d4d4007
(File Aliases): Change description of find-file-existing-other-name
Gerd Moellmann <gerd@gnu.org>
parents:
32221
diff
changeset
|
1051 @vindex find-file-existing-other-name |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1052 Normally, if you visit a file which Emacs is already visiting under |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1053 a different name, Emacs displays a message in the echo area and uses |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1054 the existing buffer visiting that file. This can happen on systems |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1055 that support symbolic links, or if you use a long file name on a |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1056 system that truncates long file names. You can disable this feature |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1057 by setting the variable @code{find-file-existing-other-name} to |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1058 @code{nil}. Then if you visit the same file under two different names, |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1059 you get a separate buffer for each file name. |
25829 | 1060 |
1061 @vindex find-file-visit-truename | |
1062 @cindex truenames of files | |
1063 @cindex file truenames | |
1064 If the variable @code{find-file-visit-truename} is non-@code{nil}, | |
1065 then the file name recorded for a buffer is the file's @dfn{truename} | |
1066 (made by replacing all symbolic links with their target names), rather | |
1067 than the name you specify. Setting @code{find-file-visit-truename} also | |
1068 implies the effect of @code{find-file-existing-other-name}. | |
1069 | |
1070 @node Version Control | |
1071 @section Version Control | |
1072 @cindex version control | |
1073 | |
1074 @dfn{Version control systems} are packages that can record multiple | |
1075 versions of a source file, usually storing the unchanged parts of the | |
1076 file just once. Version control systems also record history information | |
1077 such as the creation time of each version, who created it, and a | |
1078 description of what was changed in that version. | |
1079 | |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1080 The Emacs version control interface is called VC. Its commands work |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1081 with three version control systems---RCS, CVS, and SCCS. The GNU |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1082 project recommends RCS and CVS, which are free software and available |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1083 from the Free Software Foundation. We also have free software to |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1084 replace SCCS, known as CSSC; if you are using SCCS and don't want to |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1085 make the incompatible change to RCS or CVS, you can switch to CSSC. |
25829 | 1086 |
1087 @menu | |
1088 * Introduction to VC:: How version control works in general. | |
1089 * VC Mode Line:: How the mode line shows version control status. | |
1090 * Basic VC Editing:: How to edit a file under version control. | |
1091 * Old Versions:: Examining and comparing old versions. | |
1092 * Secondary VC Commands:: The commands used a little less frequently. | |
1093 * Branches:: Multiple lines of development. | |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1094 * Remote Repositories:: Efficient access to remote CVS servers. |
25829 | 1095 * Snapshots:: Sets of file versions treated as a unit. |
1096 * Miscellaneous VC:: Various other commands and features of VC. | |
1097 * Customizing VC:: Variables that change VC's behavior. | |
1098 @end menu | |
1099 | |
1100 @node Introduction to VC | |
1101 @subsection Introduction to Version Control | |
1102 | |
1103 VC allows you to use a version control system from within Emacs, | |
1104 integrating the version control operations smoothly with editing. VC | |
1105 provides a uniform interface to version control, so that regardless of | |
1106 which version control system is in use, you can use it the same way. | |
1107 | |
1108 This section provides a general overview of version control, and | |
1109 describes the version control systems that VC supports. You can skip | |
1110 this section if you are already familiar with the version control system | |
1111 you want to use. | |
1112 | |
1113 @menu | |
1114 * Version Systems:: Supported version control back-end systems. | |
1115 * VC Concepts:: Words and concepts related to version control. | |
1116 @end menu | |
1117 | |
1118 @node Version Systems | |
1119 @subsubsection Supported Version Control Systems | |
1120 | |
1121 @cindex RCS | |
1122 @cindex back end (version control) | |
1123 VC currently works with three different version control systems or | |
1124 ``back ends'': RCS, CVS, and SCCS. | |
1125 | |
1126 RCS is a free version control system that is available from the Free | |
1127 Software Foundation. It is perhaps the most mature of the supported | |
1128 back ends, and the VC commands are conceptually closest to RCS. Almost | |
1129 everything you can do with RCS can be done through VC. | |
1130 | |
1131 @cindex CVS | |
1132 CVS is built on top of RCS, and extends the features of RCS, allowing | |
1133 for more sophisticated release management, and concurrent multi-user | |
1134 development. VC supports basic editing operations under CVS, but for | |
1135 some less common tasks you still need to call CVS from the command line. | |
1136 Note also that before using CVS you must set up a repository, which is a | |
1137 subject too complex to treat here. | |
1138 | |
1139 @cindex SCCS | |
1140 SCCS is a proprietary but widely used version control system. In | |
1141 terms of capabilities, it is the weakest of the three that VC | |
1142 supports. VC compensates for certain features missing in SCCS | |
1143 (snapshots, for example) by implementing them itself, but some other VC | |
1144 features, such as multiple branches, are not available with SCCS. You | |
1145 should use SCCS only if for some reason you cannot use RCS. | |
1146 | |
1147 @node VC Concepts | |
1148 @subsubsection Concepts of Version Control | |
1149 | |
1150 @cindex master file | |
1151 @cindex registered file | |
1152 When a file is under version control, we also say that it is | |
1153 @dfn{registered} in the version control system. Each registered file | |
1154 has a corresponding @dfn{master file} which represents the file's | |
1155 present state plus its change history---enough to reconstruct the | |
1156 current version or any earlier version. Usually the master file also | |
1157 records a @dfn{log entry} for each version, describing in words what was | |
1158 changed in that version. | |
1159 | |
1160 @cindex work file | |
1161 @cindex checking out files | |
1162 The file that is maintained under version control is sometimes called | |
1163 the @dfn{work file} corresponding to its master file. You edit the work | |
1164 file and make changes in it, as you would with an ordinary file. (With | |
1165 SCCS and RCS, you must @dfn{lock} the file before you start to edit it.) | |
1166 After you are done with a set of changes, you @dfn{check the file in}, | |
1167 which records the changes in the master file, along with a log entry for | |
1168 them. | |
1169 | |
1170 With CVS, there are usually multiple work files corresponding to a | |
1171 single master file---often each user has his own copy. It is also | |
1172 possible to use RCS in this way, but this is not the usual way to use | |
1173 RCS. | |
1174 | |
1175 @cindex locking and version control | |
1176 A version control system typically has some mechanism to coordinate | |
1177 between users who want to change the same file. One method is | |
1178 @dfn{locking} (analogous to the locking that Emacs uses to detect | |
1179 simultaneous editing of a file, but distinct from it). The other method | |
1180 is to merge your changes with other people's changes when you check them | |
1181 in. | |
1182 | |
1183 With version control locking, work files are normally read-only so | |
1184 that you cannot change them. You ask the version control system to make | |
1185 a work file writable for you by locking it; only one user can do | |
1186 this at any given time. When you check in your changes, that unlocks | |
1187 the file, making the work file read-only again. This allows other users | |
1188 to lock the file to make further changes. SCCS always uses locking, and | |
1189 RCS normally does. | |
1190 | |
1191 The other alternative for RCS is to let each user modify the work file | |
1192 at any time. In this mode, locking is not required, but it is | |
1193 permitted; check-in is still the way to record a new version. | |
1194 | |
1195 CVS normally allows each user to modify his own copy of the work file | |
1196 at any time, but requires merging with changes from other users at | |
1197 check-in time. However, CVS can also be set up to require locking. | |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1198 (@pxref{CVS Options}). |
25829 | 1199 |
1200 @node VC Mode Line | |
1201 @subsection Version Control and the Mode Line | |
1202 | |
1203 When you visit a file that is under version control, Emacs indicates | |
1204 this on the mode line. For example, @samp{RCS-1.3} says that RCS is | |
1205 used for that file, and the current version is 1.3. | |
1206 | |
1207 The character between the back-end name and the version number | |
1208 indicates the version control status of the file. @samp{-} means that | |
1209 the work file is not locked (if locking is in use), or not modified (if | |
1210 locking is not in use). @samp{:} indicates that the file is locked, or | |
1211 that it is modified. If the file is locked by some other user (for | |
1212 instance, @samp{jim}), that is displayed as @samp{RCS:jim:1.3}. | |
1213 | |
1214 @node Basic VC Editing | |
1215 @subsection Basic Editing under Version Control | |
1216 | |
1217 The principal VC command is an all-purpose command that performs | |
1218 either locking or check-in, depending on the situation. | |
1219 | |
1220 @table @kbd | |
1221 @item C-x C-q | |
1222 @itemx C-x v v | |
1223 Perform the next logical version control operation on this file. | |
1224 @end table | |
1225 | |
1226 @findex vc-next-action | |
1227 @findex vc-toggle-read-only | |
1228 @kindex C-x v v | |
1229 @kindex C-x C-q @r{(Version Control)} | |
1230 Strictly speaking, the command for this job is @code{vc-next-action}, | |
1231 bound to @kbd{C-x v v}. However, the normal meaning of @kbd{C-x C-q} is | |
1232 to make a read-only buffer writable, or vice versa; we have extended it | |
1233 to do the same job properly for files managed by version control, by | |
1234 performing the appropriate version control operations. When you type | |
1235 @kbd{C-x C-q} on a registered file, it acts like @kbd{C-x v v}. | |
1236 | |
1237 The precise action of this command depends on the state of the file, | |
1238 and whether the version control system uses locking or not. SCCS and | |
1239 RCS normally use locking; CVS normally does not use locking. | |
1240 | |
1241 @menu | |
1242 * VC with Locking:: RCS in its default mode, SCCS, and optionally CVS. | |
1243 * Without Locking:: Without locking: default mode for CVS. | |
36402
e06c9b1a0b04
(Advanced C-x C-q): Fix prev change.
André Spiegel <spiegel@gnu.org>
parents:
36385
diff
changeset
|
1244 * Advanced C-x C-q:: Advanced features available with a prefix argument. |
25829 | 1245 * Log Buffer:: Features available in log entry buffers. |
1246 @end menu | |
1247 | |
1248 @node VC with Locking | |
1249 @subsubsection Basic Version Control with Locking | |
1250 | |
1251 If locking is used for the file (as with SCCS, and RCS in its default | |
1252 mode), @kbd{C-x C-q} can either lock a file or check it in: | |
1253 | |
1254 @itemize @bullet | |
1255 @item | |
1256 If the file is not locked, @kbd{C-x C-q} locks it, and | |
1257 makes it writable so that you can change it. | |
1258 | |
1259 @item | |
1260 If the file is locked by you, and contains changes, @kbd{C-x C-q} checks | |
1261 in the changes. In order to do this, it first reads the log entry | |
1262 for the new version. @xref{Log Buffer}. | |
1263 | |
1264 @item | |
1265 If the file is locked by you, but you have not changed it since you | |
1266 locked it, @kbd{C-x C-q} releases the lock and makes the file read-only | |
1267 again. | |
1268 | |
1269 @item | |
1270 If the file is locked by some other user, @kbd{C-x C-q} asks you whether | |
1271 you want to ``steal the lock'' from that user. If you say yes, the file | |
1272 becomes locked by you, but a message is sent to the person who had | |
1273 formerly locked the file, to inform him of what has happened. | |
1274 @end itemize | |
1275 | |
1276 These rules also apply when you use CVS in locking mode, except | |
1277 that there is no such thing as stealing a lock. | |
1278 | |
1279 @node Without Locking | |
1280 @subsubsection Basic Version Control without Locking | |
1281 | |
1282 When there is no locking---the default for CVS---work files are always | |
1283 writable; you do not need to do anything before you begin to edit a | |
1284 file. The status indicator on the mode line is @samp{-} if the file is | |
1285 unmodified; it flips to @samp{:} as soon as you save any changes in the | |
1286 work file. | |
1287 | |
1288 Here is what @kbd{C-x C-q} does when using CVS: | |
1289 | |
1290 @itemize @bullet | |
1291 @item | |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1292 If some other user has checked in changes into the master file, Emacs |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1293 asks you whether you want to merge those changes into your own work |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1294 file. You must do this before you can check in your own changes. (To |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1295 pick up any recent changes from the master file @emph{without} trying |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1296 to commit your own changes, type @kbd{C-x v m @key{RET}}.) |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1297 @xref{Merging}. |
25829 | 1298 |
1299 @item | |
1300 If there are no new changes in the master file, but you have made | |
1301 modifications in your work file, @kbd{C-x C-q} checks in your changes. | |
1302 In order to do this, it first reads the log entry for the new version. | |
1303 @xref{Log Buffer}. | |
1304 | |
1305 @item | |
1306 If the file is not modified, the @kbd{C-x C-q} does nothing. | |
1307 @end itemize | |
1308 | |
1309 These rules also apply when you use RCS in the mode that does not | |
1310 require locking, except that automatic merging of changes from the | |
1311 master file is not implemented. Unfortunately, this means that nothing | |
1312 informs you if another user has checked in changes in the same file | |
1313 since you began editing it, and when this happens, his changes will be | |
1314 effectively removed when you check in your version (though they will | |
1315 remain in the master file, so they will not be entirely lost). You must | |
1316 therefore verify the current version is unchanged, before you check in your | |
1317 changes. We hope to eliminate this risk and provide automatic merging | |
1318 with RCS in a future Emacs version. | |
1319 | |
1320 In addition, locking is possible with RCS even in this mode, although | |
1321 it is not required; @kbd{C-x C-q} with an unmodified file locks the | |
1322 file, just as it does with RCS in its normal (locking) mode. | |
1323 | |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1324 @node Advanced C-x C-q |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1325 @subsubsection Advanced Control in @kbd{C-x C-q} |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1326 |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1327 When you give a prefix argument to @code{vc-next-action} (@kbd{C-u |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1328 C-x C-q}), it still performs the next logical version control |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1329 operation, but accepts additional arguments to specify precisely how |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1330 to do the operation. |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1331 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1332 @itemize @bullet |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1333 @item |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1334 If the file is modified (or locked), you can specify the version |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1335 number to use for the new verion that you check-in. This is one way |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1336 to create a new branch (@pxref{Branches}). |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1337 |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1338 @item |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1339 If the file is not modified (and unlocked), you can specify the |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1340 version to select; this lets you start working from an older version, |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1341 or on another branch. If you do not enter any version, that takes you |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1342 to the highest version on the current branch; therefore @kbd{C-u C-x |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1343 C-q @key{RET}} is a convenient way to get the latest version of a file from |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1344 the repository. |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1345 |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1346 @item |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1347 Instead of the version number, you can also specify the name of a |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1348 version control system. This is useful when one file is being managed |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1349 with two version control systems at the same time file (@pxref{Local |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1350 Version Control}). |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1351 @end itemize |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1352 |
25829 | 1353 @node Log Buffer |
1354 @subsubsection Features of the Log Entry Buffer | |
1355 | |
1356 When you check in changes, @kbd{C-x C-q} first reads a log entry. It | |
1357 pops up a buffer called @samp{*VC-Log*} for you to enter the log entry. | |
1358 When you are finished, type @kbd{C-c C-c} in the @samp{*VC-Log*} buffer. | |
1359 That is when check-in really happens. | |
1360 | |
1361 To abort check-in, just @strong{don't} type @kbd{C-c C-c} in that | |
1362 buffer. You can switch buffers and do other editing. As long as you | |
1363 don't try to check in another file, the entry you were editing remains | |
1364 in the @samp{*VC-Log*} buffer, and you can go back to that buffer at any | |
1365 time to complete the check-in. | |
1366 | |
1367 If you change several source files for the same reason, it is often | |
1368 convenient to specify the same log entry for many of the files. To do | |
1369 this, use the history of previous log entries. The commands @kbd{M-n}, | |
1370 @kbd{M-p}, @kbd{M-s} and @kbd{M-r} for doing this work just like the | |
1371 minibuffer history commands (except that these versions are used outside | |
1372 the minibuffer). | |
1373 | |
1374 @vindex vc-log-mode-hook | |
1375 Each time you check in a file, the log entry buffer is put into VC Log | |
1376 mode, which involves running two hooks: @code{text-mode-hook} and | |
1377 @code{vc-log-mode-hook}. @xref{Hooks}. | |
1378 | |
1379 @node Old Versions | |
1380 @subsection Examining And Comparing Old Versions | |
1381 | |
1382 One of the convenient features of version control is the ability | |
1383 to examine any version of a file, or compare two versions. | |
1384 | |
1385 @table @kbd | |
1386 @item C-x v ~ @var{version} @key{RET} | |
1387 Examine version @var{version} of the visited file, in a buffer of its | |
1388 own. | |
1389 | |
1390 @item C-x v = | |
1391 Compare the current buffer contents with the latest checked-in version | |
1392 of the file. | |
1393 | |
1394 @item C-u C-x v = @var{file} @key{RET} @var{oldvers} @key{RET} @var{newvers} @key{RET} | |
1395 Compare the specified two versions of @var{file}. | |
1396 | |
1397 @item C-x v g | |
1398 Display the result of the CVS annotate command using colors. | |
1399 @end table | |
1400 | |
1401 @findex vc-version-other-window | |
1402 @kindex C-x v ~ | |
1403 To examine an old version in toto, visit the file and then type | |
1404 @kbd{C-x v ~ @var{version} @key{RET}} (@code{vc-version-other-window}). | |
1405 This puts the text of version @var{version} in a file named | |
1406 @file{@var{filename}.~@var{version}~}, and visits it in its own buffer | |
1407 in a separate window. (In RCS, you can also select an old version | |
1408 and create a branch from it. @xref{Branches}.) | |
1409 | |
1410 @findex vc-diff | |
1411 @kindex C-x v = | |
36323
7ecef0fc04b0
(Old versions): Fix "But usually is". From Nelson H. F. Beebe
Eli Zaretskii <eliz@gnu.org>
parents:
36322
diff
changeset
|
1412 It is usually more convenient to compare two versions of the file, |
25829 | 1413 with the command @kbd{C-x v =} (@code{vc-diff}). Plain @kbd{C-x v =} |
1414 compares the current buffer contents (saving them in the file if | |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1415 necessary) with the last checked-in version of the file. @kbd{C-u C-x |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1416 v =}, with a numeric argument, reads a file name and two version |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1417 numbers, then compares those versions of the specified file. Both |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1418 forms display the output in a special buffer in another window. |
25829 | 1419 |
1420 You can specify a checked-in version by its number; an empty input | |
1421 specifies the current contents of the work file (which may be different | |
1422 from all the checked-in versions). You can also specify a snapshot name | |
1423 (@pxref{Snapshots}) instead of one or both version numbers. | |
1424 | |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1425 If you supply a directory name instead of the name of a registered |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1426 file, this command compares the two specified versions of all registered |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1427 files in that directory and its subdirectories. |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1428 |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1429 @vindex diff-switches |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1430 @vindex vc-diff-switches |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1431 @kbd{C-x v =} works by running a variant of the @code{diff} utility |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1432 designed to work with the version control system in use. Emacs passes |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1433 the contents of the variable @code{diff-switches} to it; you can |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1434 specify comparison options for version control in |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1435 @code{vc-diff-switches}, and there are similar variables for each |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1436 specific system---@code{vc-rcs-diff-switches}, and so on. |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1437 |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1438 Unlike the @kbd{M-x diff} command, @kbd{C-x v =} does not try to |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1439 locate the changes in the old and new versions. This is because |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1440 normally one or both versions do not exist as files when you compare |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1441 them; they exist only in the records of the master file. |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1442 @xref{Comparing Files}, for more information about @kbd{M-x diff}. |
25829 | 1443 |
1444 @findex vc-annotate | |
1445 @kindex C-x v g | |
1446 For CVS-controlled files, you can display the result of the CVS | |
1447 annotate command, using colors to enhance the visual appearance. Use | |
1448 the command @kbd{M-x vc-annotate} to do this. Red means new, blue means | |
1449 old, and intermediate colors indicate intermediate ages. A prefix | |
1450 argument @var{n} specifies a stretch factor for the time scale; it makes | |
1451 each color cover a period @var{n} times as long. | |
1452 | |
1453 @node Secondary VC Commands | |
1454 @subsection The Secondary Commands of VC | |
1455 | |
1456 This section explains the secondary commands of VC; those that you might | |
1457 use once a day. | |
1458 | |
1459 @menu | |
1460 * Registering:: Putting a file under version control. | |
1461 * VC Status:: Viewing the VC status of files. | |
1462 * VC Undo:: Cancelling changes before or after check-in. | |
1463 * VC Dired Mode:: Listing files managed by version control. | |
1464 * VC Dired Commands:: Commands to use in a VC Dired buffer. | |
1465 @end menu | |
1466 | |
1467 @node Registering | |
1468 @subsubsection Registering a File for Version Control | |
1469 | |
1470 @kindex C-x v i | |
1471 @findex vc-register | |
1472 You can put any file under version control by simply visiting it, and | |
1473 then typing @w{@kbd{C-x v i}} (@code{vc-register}). | |
1474 | |
1475 @table @kbd | |
1476 @item C-x v i | |
1477 Register the visited file for version control. | |
1478 @end table | |
1479 | |
1480 To register the file, Emacs must choose which version control system | |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1481 to use for it. If the file's directory already contains files |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1482 registered in a version control system, Emacs uses that system. If |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1483 there is more than one system in use for a directory, Emacs uses the one |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1484 that appears first in @var{vc-handled-backends} (@pxref{Customizing VC}). |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1485 On the other hand, if there are no files already registered, |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1486 Emacs uses the first system from @var{vc-handled-backends} that could |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1487 register the file---for example, you cannot register a file under CVS if |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1488 its directory is not already part of a CVS tree. |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1489 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1490 With the default value of @var{vc-handled-backends}, this means that |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1491 Emacs uses RCS if there are any files under RCS control, or CVS if |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1492 there are any files under CVS, or RCS as the ultimate default. |
25829 | 1493 |
1494 If locking is in use, @kbd{C-x v i} leaves the file unlocked and | |
1495 read-only. Type @kbd{C-x C-q} if you wish to start editing it. After | |
1496 registering a file with CVS, you must subsequently commit the initial | |
1497 version by typing @kbd{C-x C-q}. | |
1498 | |
1499 @vindex vc-default-init-version | |
1500 The initial version number for a newly registered file is 1.1, by | |
1501 default. You can specify a different default by setting the variable | |
1502 @code{vc-default-init-version}, or you can give @kbd{C-x v i} a numeric | |
1503 argument; then it reads the initial version number for this particular | |
1504 file using the minibuffer. | |
1505 | |
1506 @vindex vc-initial-comment | |
1507 If @code{vc-initial-comment} is non-@code{nil}, @kbd{C-x v i} reads an | |
1508 initial comment to describe the purpose of this source file. Reading | |
1509 the initial comment works like reading a log entry (@pxref{Log Buffer}). | |
1510 | |
1511 @node VC Status | |
1512 @subsubsection VC Status Commands | |
1513 | |
1514 @table @kbd | |
1515 @item C-x v l | |
1516 Display version control state and change history. | |
1517 @end table | |
1518 | |
1519 @kindex C-x v l | |
1520 @findex vc-print-log | |
1521 To view the detailed version control status and history of a file, | |
1522 type @kbd{C-x v l} (@code{vc-print-log}). It displays the history of | |
1523 changes to the current file, including the text of the log entries. The | |
1524 output appears in a separate window. | |
1525 | |
1526 @node VC Undo | |
1527 @subsubsection Undoing Version Control Actions | |
1528 | |
1529 @table @kbd | |
1530 @item C-x v u | |
1531 Revert the buffer and the file to the last checked-in version. | |
1532 | |
1533 @item C-x v c | |
1534 Remove the last-entered change from the master for the visited file. | |
1535 This undoes your last check-in. | |
1536 @end table | |
1537 | |
1538 @kindex C-x v u | |
1539 @findex vc-revert-buffer | |
1540 If you want to discard your current set of changes and revert to the | |
1541 last version checked in, use @kbd{C-x v u} (@code{vc-revert-buffer}). | |
1542 This leaves the file unlocked; if locking is in use, you must first lock | |
1543 the file again before you change it again. @kbd{C-x v u} requires | |
1544 confirmation, unless it sees that you haven't made any changes since the | |
1545 last checked-in version. | |
1546 | |
1547 @kbd{C-x v u} is also the command to unlock a file if you lock it and | |
1548 then decide not to change it. | |
1549 | |
1550 @kindex C-x v c | |
1551 @findex vc-cancel-version | |
1552 To cancel a change that you already checked in, use @kbd{C-x v c} | |
1553 (@code{vc-cancel-version}). This command discards all record of the | |
1554 most recent checked-in version. @kbd{C-x v c} also offers to revert | |
1555 your work file and buffer to the previous version (the one that precedes | |
1556 the version that is deleted). | |
1557 | |
1558 If you answer @kbd{no}, VC keeps your changes in the buffer, and locks | |
1559 the file. The no-revert option is useful when you have checked in a | |
1560 change and then discover a trivial error in it; you can cancel the | |
1561 erroneous check-in, fix the error, and check the file in again. | |
1562 | |
1563 When @kbd{C-x v c} does not revert the buffer, it unexpands all | |
1564 version control headers in the buffer instead (@pxref{Version Headers}). | |
1565 This is because the buffer no longer corresponds to any existing | |
1566 version. If you check it in again, the check-in process will expand the | |
1567 headers properly for the new version number. | |
1568 | |
1569 However, it is impossible to unexpand the RCS @samp{@w{$}Log$} header | |
1570 automatically. If you use that header feature, you have to unexpand it | |
1571 by hand---by deleting the entry for the version that you just canceled. | |
1572 | |
1573 Be careful when invoking @kbd{C-x v c}, as it is easy to lose a lot of | |
1574 work with it. To help you be careful, this command always requires | |
1575 confirmation with @kbd{yes}. Note also that this command is disabled | |
1576 under CVS, because canceling versions is very dangerous and discouraged | |
1577 with CVS. | |
1578 | |
1579 @node VC Dired Mode | |
1580 @subsubsection Dired under VC | |
1581 | |
31076 | 1582 @cindex PCL-CVS |
1583 @pindex cvs | |
1584 @cindex CVS Dired Mode | |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1585 The VC Dired Mode described here works with all the version control |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1586 systems that VC supports. Another more powerful facility, designed |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1587 specifically for CVS, is called PCL-CVS. @xref{Top, , About PCL-CVS, |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
1588 pcl-cvs, PCL-CVS --- The Emacs Front-End to CVS}. |
31076 | 1589 |
25829 | 1590 @kindex C-x v d |
1591 @findex vc-directory | |
1592 When you are working on a large program, it is often useful to find | |
1593 out which files have changed within an entire directory tree, or to view | |
1594 the status of all files under version control at once, and to perform | |
1595 version control operations on collections of files. You can use the | |
1596 command @kbd{C-x v d} (@code{vc-directory}) to make a directory listing | |
1597 that includes only files relevant for version control. | |
1598 | |
1599 @vindex vc-dired-terse-display | |
1600 @kbd{C-x v d} creates a buffer which uses VC Dired Mode. This looks | |
1601 much like an ordinary Dired buffer (@pxref{Dired}); however, normally it | |
1602 shows only the noteworthy files (those locked or not up-to-date). This | |
1603 is called @dfn{terse display}. If you set the variable | |
1604 @code{vc-dired-terse-display} to @code{nil}, then VC Dired shows all | |
1605 relevant files---those managed under version control, plus all | |
1606 subdirectories (@dfn{full display}). The command @kbd{v t} in a VC | |
1607 Dired buffer toggles between terse display and full display (@pxref{VC | |
1608 Dired Commands}). | |
1609 | |
1610 @vindex vc-dired-recurse | |
1611 By default, VC Dired produces a recursive listing of noteworthy or | |
1612 relevant files at or below the given directory. You can change this by | |
1613 setting the variable @code{vc-dired-recurse} to @code{nil}; then VC | |
1614 Dired shows only the files in the given directory. | |
1615 | |
1616 The line for an individual file shows the version control state in the | |
1617 place of the hard link count, owner, group, and size of the file. If | |
1618 the file is unmodified, in sync with the master file, the version | |
1619 control state shown is blank. Otherwise it consists of text in | |
1620 parentheses. Under RCS and SCCS, the name of the user locking the file | |
1621 is shown; under CVS, an abbreviated version of the @samp{cvs status} | |
1622 output is used. Here is an example using RCS: | |
1623 | |
1624 @smallexample | |
1625 @group | |
1626 /home/jim/project: | |
1627 | |
1628 -rw-r--r-- (jim) Apr 2 23:39 file1 | |
1629 -r--r--r-- Apr 5 20:21 file2 | |
1630 @end group | |
1631 @end smallexample | |
1632 | |
1633 @noindent | |
1634 The files @samp{file1} and @samp{file2} are under version control, | |
1635 @samp{file1} is locked by user jim, and @samp{file2} is unlocked. | |
1636 | |
1637 Here is an example using CVS: | |
1638 | |
1639 @smallexample | |
1640 @group | |
1641 /home/joe/develop: | |
1642 | |
1643 -rw-r--r-- (modified) Aug 2 1997 file1.c | |
1644 -rw-r--r-- Apr 4 20:09 file2.c | |
1645 -rw-r--r-- (merge) Sep 13 1996 file3.c | |
1646 @end group | |
1647 @end smallexample | |
1648 | |
1649 Here @samp{file1.c} is modified with respect to the repository, and | |
1650 @samp{file2.c} is not. @samp{file3.c} is modified, but other changes | |
1651 have also been checked in to the repository---you need to merge them | |
1652 with the work file before you can check it in. | |
1653 | |
1654 @vindex vc-directory-exclusion-list | |
1655 When VC Dired displays subdirectories (in the ``full'' display mode), | |
1656 it omits some that should never contain any files under version control. | |
1657 By default, this includes Version Control subdirectories such as | |
1658 @samp{RCS} and @samp{CVS}; you can customize this by setting the | |
1659 variable @code{vc-directory-exclusion-list}. | |
1660 | |
1661 You can fine-tune VC Dired's format by typing @kbd{C-u C-x v d}---as in | |
1662 ordinary Dired, that allows you to specify additional switches for the | |
1663 @samp{ls} command. | |
1664 | |
1665 @node VC Dired Commands | |
1666 @subsubsection VC Dired Commands | |
1667 | |
1668 All the usual Dired commands work normally in VC Dired mode, except | |
1669 for @kbd{v}, which is redefined as the version control prefix. You can | |
1670 invoke VC commands such as @code{vc-diff} and @code{vc-print-log} by | |
1671 typing @kbd{v =}, or @kbd{v l}, and so on. Most of these commands apply | |
1672 to the file name on the current line. | |
1673 | |
1674 The command @kbd{v v} (@code{vc-next-action}) operates on all the | |
1675 marked files, so that you can lock or check in several files at once. | |
1676 If it operates on more than one file, it handles each file according to | |
1677 its current state; thus, it might lock one file, but check in another | |
1678 file. This could be confusing; it is up to you to avoid confusing | |
1679 behavior by marking a set of files that are in a similar state. | |
1680 | |
1681 If any files call for check-in, @kbd{v v} reads a single log entry, | |
1682 then uses it for all the files being checked in. This is convenient for | |
1683 registering or checking in several files at once, as part of the same | |
1684 change. | |
1685 | |
1686 @findex vc-dired-toggle-terse-mode | |
1687 @findex vc-dired-mark-locked | |
1688 You can toggle between terse display (only locked files, or files not | |
1689 up-to-date) and full display at any time by typing @kbd{v t} | |
1690 @code{vc-dired-toggle-terse-mode}. There is also a special command | |
1691 @kbd{* l} (@code{vc-dired-mark-locked}), which marks all files currently | |
1692 locked (or, with CVS, all files not up-to-date). Thus, typing @kbd{* l | |
1693 t k} is another way to delete from the buffer all files except those | |
1694 currently locked. | |
1695 | |
1696 @node Branches | |
1697 @subsection Multiple Branches of a File | |
1698 @cindex branch (version control) | |
1699 @cindex trunk (version control) | |
1700 | |
1701 One use of version control is to maintain multiple ``current'' | |
1702 versions of a file. For example, you might have different versions of a | |
1703 program in which you are gradually adding various unfinished new | |
1704 features. Each such independent line of development is called a | |
1705 @dfn{branch}. VC allows you to create branches, switch between | |
1706 different branches, and merge changes from one branch to another. | |
1707 Please note, however, that branches are only supported for RCS at the | |
1708 moment. | |
1709 | |
1710 A file's main line of development is usually called the @dfn{trunk}. | |
1711 The versions on the trunk are normally numbered 1.1, 1.2, 1.3, etc. At | |
1712 any such version, you can start an independent branch. A branch | |
1713 starting at version 1.2 would have version number 1.2.1.1, and consecutive | |
1714 versions on this branch would have numbers 1.2.1.2, 1.2.1.3, 1.2.1.4, | |
1715 and so on. If there is a second branch also starting at version 1.2, it | |
1716 would consist of versions 1.2.2.1, 1.2.2.2, 1.2.2.3, etc. | |
1717 | |
1718 @cindex head version | |
1719 If you omit the final component of a version number, that is called a | |
1720 @dfn{branch number}. It refers to the highest existing version on that | |
1721 branch---the @dfn{head version} of that branch. The branches in the | |
1722 example above have branch numbers 1.2.1 and 1.2.2. | |
1723 | |
1724 @menu | |
1725 * Switching Branches:: How to get to another existing branch. | |
1726 * Creating Branches:: How to start a new branch. | |
1727 * Merging:: Transferring changes between branches. | |
1728 * Multi-User Branching:: Multiple users working at multiple branches | |
1729 in parallel. | |
1730 @end menu | |
1731 | |
1732 @node Switching Branches | |
1733 @subsubsection Switching between Branches | |
1734 | |
1735 To switch between branches, type @kbd{C-u C-x C-q} and specify the | |
1736 version number you want to select. This version is then visited | |
1737 @emph{unlocked} (write-protected), so you can examine it before locking | |
1738 it. Switching branches in this way is allowed only when the file is not | |
1739 locked. | |
1740 | |
1741 You can omit the minor version number, thus giving only the branch | |
1742 number; this takes you to the head version on the chosen branch. If you | |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1743 only type @key{RET}, Emacs goes to the highest version on the trunk. |
25829 | 1744 |
1745 After you have switched to any branch (including the main branch), you | |
1746 stay on it for subsequent VC commands, until you explicitly select some | |
1747 other branch. | |
1748 | |
1749 @node Creating Branches | |
1750 @subsubsection Creating New Branches | |
1751 | |
1752 To create a new branch from a head version (one that is the latest in | |
1753 the branch that contains it), first select that version if necessary, | |
1754 lock it with @kbd{C-x C-q}, and make whatever changes you want. Then, | |
1755 when you check in the changes, use @kbd{C-u C-x C-q}. This lets you | |
1756 specify the version number for the new version. You should specify a | |
1757 suitable branch number for a branch starting at the current version. | |
1758 For example, if the current version is 2.5, the branch number should be | |
1759 2.5.1, 2.5.2, and so on, depending on the number of existing branches at | |
1760 that point. | |
1761 | |
1762 To create a new branch at an older version (one that is no longer the | |
1763 head of a branch), first select that version (@pxref{Switching | |
1764 Branches}), then lock it with @kbd{C-x C-q}. You'll be asked to | |
1765 confirm, when you lock the old version, that you really mean to create a | |
1766 new branch---if you say no, you'll be offered a chance to lock the | |
1767 latest version instead. | |
1768 | |
1769 Then make your changes and type @kbd{C-x C-q} again to check in a new | |
1770 version. This automatically creates a new branch starting from the | |
1771 selected version. You need not specially request a new branch, because | |
1772 that's the only way to add a new version at a point that is not the head | |
1773 of a branch. | |
1774 | |
1775 After the branch is created, you ``stay'' on it. That means that | |
1776 subsequent check-ins create new versions on that branch. To leave the | |
1777 branch, you must explicitly select a different version with @kbd{C-u C-x | |
1778 C-q}. To transfer changes from one branch to another, use the merge | |
1779 command, described in the next section. | |
1780 | |
1781 @node Merging | |
1782 @subsubsection Merging Branches | |
1783 | |
1784 @cindex merging changes | |
1785 When you have finished the changes on a certain branch, you will | |
1786 often want to incorporate them into the file's main line of development | |
1787 (the trunk). This is not a trivial operation, because development might | |
1788 also have proceeded on the trunk, so that you must @dfn{merge} the | |
1789 changes into a file that has already been changed otherwise. VC allows | |
1790 you to do this (and other things) with the @code{vc-merge} command. | |
1791 | |
1792 @table @kbd | |
1793 @item C-x v m (vc-merge) | |
1794 Merge changes into the work file. | |
1795 @end table | |
1796 | |
1797 @kindex C-x v m | |
1798 @findex vc-merge | |
1799 @kbd{C-x v m} (@code{vc-merge}) takes a set of changes and merges it | |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1800 into the current version of the work file. It firsts asks you in the |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1801 minibuffer where the changes should come from. If you just type |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1802 @key{RET}, Emacs merges any changes that were made on the same branch |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1803 since you checked the file out (we call this @dfn{merging the news}). |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1804 This is the common way to pick up recent changes from the repository, |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1805 regardless of whether you have already changed the file yourself. |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1806 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1807 You can also enter a branch number or a pair of version numbers in |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1808 the minibuffer. Then it finds the changes from that branch, or between |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1809 the two versions you specified, and merges them into the current version |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1810 of the current file. |
25829 | 1811 |
1812 As an example, suppose that you have finished a certain feature on | |
1813 branch 1.3.1. In the meantime, development on the trunk has proceeded | |
1814 to version 1.5. To merge the changes from the branch to the trunk, | |
1815 first go to the head version of the trunk, by typing @kbd{C-u C-x C-q | |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1816 @key{RET}}. Version 1.5 is now current. If locking is used for the file, |
25829 | 1817 type @kbd{C-x C-q} to lock version 1.5 so that you can change it. Next, |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1818 type @kbd{C-x v m 1.3.1 @key{RET}}. This takes the entire set of changes on |
25829 | 1819 branch 1.3.1 (relative to version 1.3, where the branch started, up to |
1820 the last version on the branch) and merges it into the current version | |
1821 of the work file. You can now check in the changed file, thus creating | |
1822 version 1.6 containing the changes from the branch. | |
1823 | |
1824 It is possible to do further editing after merging the branch, before | |
1825 the next check-in. But it is usually wiser to check in the merged | |
1826 version, then lock it and make the further changes. This will keep | |
1827 a better record of the history of changes. | |
1828 | |
1829 @cindex conflicts | |
1830 @cindex resolving conflicts | |
1831 When you merge changes into a file that has itself been modified, the | |
1832 changes might overlap. We call this situation a @dfn{conflict}, and | |
1833 reconciling the conflicting changes is called @dfn{resolving a | |
1834 conflict}. | |
1835 | |
1836 Whenever conflicts occur during merging, VC detects them, tells you | |
1837 about them in the echo area, and asks whether you want help in merging. | |
1838 If you say yes, it starts an Ediff session (@pxref{Top, | |
1839 Ediff, Ediff, ediff, The Ediff Manual}). | |
1840 | |
1841 If you say no, the conflicting changes are both inserted into the | |
1842 file, surrounded by @dfn{conflict markers}. The example below shows how | |
1843 a conflict region looks; the file is called @samp{name} and the current | |
1844 master file version with user B's changes in it is 1.11. | |
1845 | |
1846 @c @w here is so CVS won't think this is a conflict. | |
1847 @smallexample | |
1848 @group | |
1849 @w{<}<<<<<< name | |
1850 @var{User A's version} | |
1851 ======= | |
1852 @var{User B's version} | |
1853 @w{>}>>>>>> 1.11 | |
1854 @end group | |
1855 @end smallexample | |
1856 | |
1857 @cindex vc-resolve-conflicts | |
1858 Then you can resolve the conflicts by editing the file manually. Or | |
1859 you can type @code{M-x vc-resolve-conflicts} after visiting the file. | |
1860 This starts an Ediff session, as described above. | |
1861 | |
1862 @node Multi-User Branching | |
1863 @subsubsection Multi-User Branching | |
1864 | |
1865 It is often useful for multiple developers to work simultaneously on | |
1866 different branches of a file. CVS allows this by default; for RCS, it | |
1867 is possible if you create multiple source directories. Each source | |
1868 directory should have a link named @file{RCS} which points to a common | |
1869 directory of RCS master files. Then each source directory can have its | |
1870 own choice of selected versions, but all share the same common RCS | |
1871 records. | |
1872 | |
1873 This technique works reliably and automatically, provided that the | |
1874 source files contain RCS version headers (@pxref{Version Headers}). The | |
1875 headers enable Emacs to be sure, at all times, which version number is | |
1876 present in the work file. | |
1877 | |
1878 If the files do not have version headers, you must instead tell Emacs | |
1879 explicitly in each session which branch you are working on. To do this, | |
1880 first find the file, then type @kbd{C-u C-x C-q} and specify the correct | |
1881 branch number. This ensures that Emacs knows which branch it is using | |
1882 during this particular editing session. | |
1883 | |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1884 @node Remote Repositories |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1885 @subsection Remote Repositories |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1886 @cindex remote repositories (CVS) |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1887 |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1888 A common way of using CVS is to set up a central CVS repository on |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1889 some Internet host, then have each developer check out a personal |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1890 working copy of the files on his local machine. Committing changes to |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1891 the repository, and picking up changes from other users into one's own |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1892 working area, then works by direct interactions with the CVS server. |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1893 |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1894 One difficulty is that access to the CVS server is often slow, and |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1895 that developers might need to work offline as well. VC is designed |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1896 to reduce the amount of network interaction necessary. |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1897 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1898 @menu |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1899 * Version Backups:: Keeping local copies of repository versions. |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1900 * Local Version Control:: Using another version system for local editing. |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1901 @end menu |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1902 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1903 @node Version Backups |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1904 @subsubsection Version Backups |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1905 @cindex version backups |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1906 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1907 @cindex automatic version backups |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1908 When VC sees that the CVS repository for a file is on a remote |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1909 machine, it automatically makes local backups of unmodified versions |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1910 of the file---@dfn{automatic version backups}. This means that you |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1911 can compare the file to the repository version (@kbd{C-x v =}), or |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1912 revert to that version (@kbd{C-x v u}), without any network |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1913 interactions. |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1914 |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1915 The local copy of the unmodified file is called a @dfn{version |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1916 backup} to indicate that it corresponds exactly to a version that is |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1917 stored in the repository. Note that version backups are not the same |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1918 as ordinary Emacs backup files (@pxref{Backup}). But they follow a |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1919 similar naming convention. |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1920 |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1921 For a file that comes from a remote CVS repository, VC makes a |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1922 version backup whenever you save the first changes to the file, and |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1923 removes it after you have committed your modified version to the |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1924 repository. You can disable the making of automatic version backups by |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1925 setting @code{vc-cvs-stay-local} to @code{nil} (@pxref{CVS Options}). |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1926 |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1927 @cindex manual version backups |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1928 The name of the automatic version backup for version @var{version} |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1929 of file @var{file} is @code{@var{file}.~@var{version}.~}. This is |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1930 almost the same as the name used by @kbd{C-x v ~} (@pxref{Old |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1931 Versions}), the only difference being the additional dot (@samp{.}) |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1932 after the version number. This similarity is intentional, because |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1933 both kinds of files store the same kind of information. The file made |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1934 by @kbd{C-x v ~} acts as a @dfn{manual version backup}. |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1935 |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1936 All the VC commands that operate on old versions of a file can use |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1937 both kinds of version backups. For instance, @kbd{C-x v ~} uses |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1938 either an automatic or a manual version backup, if possible, to get |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1939 the contents of the version you request. Likewise, @kbd{C-x v =} and |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1940 @kbd{C-x v u} use either an automatic or a manual version backup, if |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1941 one of them exists, to get the contents of a version to compare or |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1942 revert to. If you changed a file outside of Emacs, so that no |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1943 automatic version backup was created for the previous text, you can |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1944 create a manual backup of that version using @kbd{C-x v ~}, and thus |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1945 obtain the benefit of the local copy for Emacs commands. |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1946 |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1947 The only difference in Emacs's handling of manual and automatic |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1948 version backups, once they exist, is that Emacs deletes automatic |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1949 version backups when you commit to the repository. By contrast, |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1950 manual version backups remain until you delete them. |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1951 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1952 @node Local Version Control |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1953 @subsubsection Local Version Control |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1954 @cindex local version control |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1955 @cindex local back end (version control) |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1956 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1957 When you make many changes to a file that comes from a remote |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1958 repository, it can be convenient to have version control on your local |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1959 machine as well. You can then record intermediate versions, revert to |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1960 a previous state, etc., before you actually commit your changes to the |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1961 remote server. |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1962 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1963 VC lets you do this by putting a file under a second, local version |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1964 control system, so that the file is effectively registered in two |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1965 systems at the same time. For the description here, we will assume |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1966 that the remote system is CVS, and you use RCS locally, although the |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1967 mechanism works with any combination of version control systems |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1968 (@dfn{back ends}). |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1969 |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1970 To make it work with other back ends, you must make sure that the |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1971 ``more local'' back end comes before the ``more remote'' back end in |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1972 the setting of @var{vc-handled-backends} (@pxref{Customizing VC}). By |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1973 default, this variable is set up so that you can use remote CVS and |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1974 local RCS as described here. |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1975 |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1976 To start using local RCS for a file that comes from a remote CVS |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1977 server, you must @emph{register the file in RCS}, by typing @kbd{C-u |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1978 C-x v v rcs @key{RET}}. (In other words, use @code{vc-next-action} with a |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1979 prefix argument, and specify RCS as the back end.) |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1980 |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1981 You can do this at any time; it does not matter whether you have |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1982 already modified the file with respect to the version in the CVS |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1983 repository. If possible, VC tries to make the RCS master start with |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1984 the unmodified repository version, then checking in any local changes |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1985 as a new version. This works if you have not made any changes yet, or |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1986 if the unmodified repository version exists locally as a version |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1987 backup (@pxref{Version Backups}). If the unmodified version is not |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1988 available locally, the RCS master starts with the modified version; |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1989 the only drawback of this is that you cannot compare your changes |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1990 locally to what is stored in the repository. |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1991 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1992 The version number of the RCS master is derived from the current CVS |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1993 version, starting a branch from it. For example, if the current CVS |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1994 version is 1.23, the local RCS branch will be 1.23.1. Version 1.23 in |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1995 the RCS master will be identical to version 1.23 under CVS; your first |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1996 changes are checked in as 1.23.1.1. (If the unmodified file is not |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
1997 available locally, VC will check in the modified file twice, both as |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1998 1.23 and 1.23.1.1, to make the revision numbers consistent.) |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
1999 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2000 If you do not use locking under CVS (the default), locking is also |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2001 disabled for RCS, so that editing under RCS works exactly as under |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2002 CVS. |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2003 |
36728
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2004 When you are done with local editing, you can commit the final version |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2005 back to the CVS repository by typing @kbd{C-u C-x v v cvs @key{RET}}. |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2006 This initializes the log entry buffer (@pxref{Log Buffer}) to contain |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2007 all the log entries you have recorded in the RCS master; you can edit |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2008 them as you wish, and then commit in CVS by typing @kbd{C-c C-c}. If |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2009 the commit is successful, VC removes the RCS master, so that the file |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2010 is once again registered under CVS only. (The RCS master is not |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2011 actually deleted, just renamed by appending @samp{~} to the name, so |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2012 that you can refer to it later if you wish.) |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2013 |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2014 While using local RCS, you can pick up recent changes from the CVS |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2015 repository into your local file, or commit some of your changes back |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2016 to CVS, without terminating local RCS version control. To do this, |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2017 switch to the CVS backend temporarily, with the @kbd{C-x v b} command: |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2018 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2019 @table @kbd |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2020 @item C-x v b |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2021 Switch to another back end that the current file is registered |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2022 under (@code{vc-switch-backend}). |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2023 |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2024 @item C-u C-x v b @var{backend} @key{RET} |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2025 Switch to @var{backend} for the current file. |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2026 @end table |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2027 |
36360
0774daebf700
(Local Version Control): Fix last change.
Eli Zaretskii <eliz@gnu.org>
parents:
36356
diff
changeset
|
2028 @kindex C-x v b |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2029 @findex vc-switch-backend |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2030 @kbd{C-x v b} does not change the buffer contents, or any files; it |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2031 only changes VC's perspective on how to handle the file. Any |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2032 subsequent VC commands for that file will operate on the back end that |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2033 is currently selected. |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2034 |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2035 If the current file is registered in more than one back end, typing |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2036 @kbd{C-x v b} ``cycles'' through all of these back ends. With a |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2037 prefix argument, it asks for the back end to use in the minibuffer. |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2038 |
36728
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2039 Thus, if you are using local RCS, and you want to pick up some recent |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2040 changes in the file from remote CVS, first visit the file, then type |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2041 @kbd{C-x v b} to switch to CVS, and finally use @kbd{C-x v m |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2042 @key{RET}} to merge the news (@pxref{Merging}). You can then switch |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2043 back to RCS by typing @kbd{C-x v b} again, and continue to edit |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2044 locally. |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2045 |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2046 But if you do this, the revision numbers in the RCS master no longer |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2047 correspond to those of CVS. Technically, this is not a problem, but |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2048 it can become difficult to keep track of what is in the CVS repository |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2049 and what is not. So we suggest that you return from time to time to |
4906c8088ad5
Clarify C-u C-x v v cvs RET. Clarify the purpose of C-x v b.
Richard M. Stallman <rms@gnu.org>
parents:
36547
diff
changeset
|
2050 CVS-only operation, using @kbd{C-u C-x v v cvs @key{RET}}. |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2051 |
25829 | 2052 @node Snapshots |
2053 @subsection Snapshots | |
2054 @cindex snapshots and version control | |
2055 | |
2056 A @dfn{snapshot} is a named set of file versions (one for each | |
2057 registered file) that you can treat as a unit. One important kind of | |
2058 snapshot is a @dfn{release}, a (theoretically) stable version of the | |
2059 system that is ready for distribution to users. | |
2060 | |
2061 @menu | |
2062 * Making Snapshots:: The snapshot facilities. | |
2063 * Snapshot Caveats:: Things to be careful of when using snapshots. | |
2064 @end menu | |
2065 | |
2066 @node Making Snapshots | |
2067 @subsubsection Making and Using Snapshots | |
2068 | |
2069 There are two basic commands for snapshots; one makes a | |
2070 snapshot with a given name, the other retrieves a named snapshot. | |
2071 | |
2072 @table @code | |
2073 @kindex C-x v s | |
2074 @findex vc-create-snapshot | |
2075 @item C-x v s @var{name} @key{RET} | |
2076 Define the last saved versions of every registered file in or under the | |
2077 current directory as a snapshot named @var{name} | |
2078 (@code{vc-create-snapshot}). | |
2079 | |
2080 @kindex C-x v r | |
2081 @findex vc-retrieve-snapshot | |
2082 @item C-x v r @var{name} @key{RET} | |
2083 For all registered files at or below the current directory level, select | |
2084 whatever versions correspond to the snapshot @var{name} | |
2085 (@code{vc-retrieve-snapshot}). | |
2086 | |
2087 This command reports an error if any files are locked at or below the | |
2088 current directory, without changing anything; this is to avoid | |
2089 overwriting work in progress. | |
2090 @end table | |
2091 | |
2092 A snapshot uses a very small amount of resources---just enough to record | |
2093 the list of file names and which version belongs to the snapshot. Thus, | |
2094 you need not hesitate to create snapshots whenever they are useful. | |
2095 | |
2096 You can give a snapshot name as an argument to @kbd{C-x v =} or | |
2097 @kbd{C-x v ~} (@pxref{Old Versions}). Thus, you can use it to compare a | |
2098 snapshot against the current files, or two snapshots against each other, | |
2099 or a snapshot against a named version. | |
2100 | |
2101 @node Snapshot Caveats | |
2102 @subsubsection Snapshot Caveats | |
2103 | |
2104 @cindex named configurations (RCS) | |
2105 VC's snapshot facilities are modeled on RCS's named-configuration | |
2106 support. They use RCS's native facilities for this, so under VC | |
2107 snapshots made using RCS are visible even when you bypass VC. | |
2108 | |
2109 @c worded verbosely to avoid overfull hbox. | |
2110 For SCCS, VC implements snapshots itself. The files it uses contain | |
2111 name/file/version-number triples. These snapshots are visible only | |
2112 through VC. | |
2113 | |
2114 A snapshot is a set of checked-in versions. So make sure that all the | |
2115 files are checked in and not locked when you make a snapshot. | |
2116 | |
2117 File renaming and deletion can create some difficulties with snapshots. | |
2118 This is not a VC-specific problem, but a general design issue in version | |
2119 control systems that no one has solved very well yet. | |
2120 | |
2121 If you rename a registered file, you need to rename its master along | |
2122 with it (the command @code{vc-rename-file} does this automatically). If | |
2123 you are using SCCS, you must also update the records of the snapshot, to | |
2124 mention the file by its new name (@code{vc-rename-file} does this, | |
2125 too). An old snapshot that refers to a master file that no longer | |
2126 exists under the recorded name is invalid; VC can no longer retrieve | |
2127 it. It would be beyond the scope of this manual to explain enough about | |
2128 RCS and SCCS to explain how to update the snapshots by hand. | |
2129 | |
2130 Using @code{vc-rename-file} makes the snapshot remain valid for | |
2131 retrieval, but it does not solve all problems. For example, some of the | |
2132 files in the program probably refer to others by name. At the very | |
2133 least, the makefile probably mentions the file that you renamed. If you | |
2134 retrieve an old snapshot, the renamed file is retrieved under its new | |
2135 name, which is not the name that the makefile expects. So the program | |
2136 won't really work as retrieved. | |
2137 | |
2138 @node Miscellaneous VC | |
2139 @subsection Miscellaneous Commands and Features of VC | |
2140 | |
2141 This section explains the less-frequently-used features of VC. | |
2142 | |
2143 @menu | |
2144 * Change Logs and VC:: Generating a change log file from log entries. | |
2145 * Renaming and VC:: A command to rename both the source and master | |
2146 file correctly. | |
2147 * Version Headers:: Inserting version control headers into working files. | |
2148 @end menu | |
2149 | |
2150 @node Change Logs and VC | |
2151 @subsubsection Change Logs and VC | |
2152 | |
2153 If you use RCS or CVS for a program and also maintain a change log | |
2154 file for it (@pxref{Change Log}), you can generate change log entries | |
2155 automatically from the version control log entries: | |
2156 | |
2157 @table @kbd | |
2158 @item C-x v a | |
2159 @kindex C-x v a | |
2160 @findex vc-update-change-log | |
2161 Visit the current directory's change log file and, for registered files | |
2162 in that directory, create new entries for versions checked in since the | |
2163 most recent entry in the change log file. | |
2164 (@code{vc-update-change-log}). | |
2165 | |
2166 This command works with RCS or CVS only, not with SCCS. | |
2167 | |
2168 @item C-u C-x v a | |
2169 As above, but only find entries for the current buffer's file. | |
2170 | |
2171 @item M-1 C-x v a | |
2172 As above, but find entries for all the currently visited files that are | |
2173 maintained with version control. This works only with RCS, and it puts | |
2174 all entries in the log for the default directory, which may not be | |
2175 appropriate. | |
2176 @end table | |
2177 | |
2178 For example, suppose the first line of @file{ChangeLog} is dated | |
2179 1999-04-10, and that the only check-in since then was by Nathaniel | |
2180 Bowditch to @file{rcs2log} on 1999-05-22 with log text @samp{Ignore log | |
2181 messages that start with `#'.}. Then @kbd{C-x v a} visits | |
2182 @file{ChangeLog} and inserts text like this: | |
2183 | |
2184 @iftex | |
2185 @medbreak | |
2186 @end iftex | |
2187 @smallexample | |
2188 @group | |
2189 1999-05-22 Nathaniel Bowditch <nat@@apn.org> | |
2190 | |
2191 * rcs2log: Ignore log messages that start with `#'. | |
2192 @end group | |
2193 @end smallexample | |
2194 @iftex | |
2195 @medbreak | |
2196 @end iftex | |
2197 | |
2198 @noindent | |
2199 You can then edit the new change log entry further as you wish. | |
2200 | |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2201 Some of the new change log entry may duplicate what's already in |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2202 ChangeLog. You will have to remove these duplicates by hand. |
25829 | 2203 |
2204 Normally, the log entry for file @file{foo} is displayed as @samp{* | |
2205 foo: @var{text of log entry}}. The @samp{:} after @file{foo} is omitted | |
2206 if the text of the log entry starts with @w{@samp{(@var{functionname}): | |
2207 }}. For example, if the log entry for @file{vc.el} is | |
2208 @samp{(vc-do-command): Check call-process status.}, then the text in | |
2209 @file{ChangeLog} looks like this: | |
2210 | |
2211 @iftex | |
2212 @medbreak | |
2213 @end iftex | |
2214 @smallexample | |
2215 @group | |
2216 1999-05-06 Nathaniel Bowditch <nat@@apn.org> | |
2217 | |
2218 * vc.el (vc-do-command): Check call-process status. | |
2219 @end group | |
2220 @end smallexample | |
2221 @iftex | |
2222 @medbreak | |
2223 @end iftex | |
2224 | |
2225 When @kbd{C-x v a} adds several change log entries at once, it groups | |
2226 related log entries together if they all are checked in by the same | |
2227 author at nearly the same time. If the log entries for several such | |
2228 files all have the same text, it coalesces them into a single entry. | |
2229 For example, suppose the most recent check-ins have the following log | |
2230 entries: | |
2231 | |
2232 @flushleft | |
2233 @bullet{} For @file{vc.texinfo}: @samp{Fix expansion typos.} | |
2234 @bullet{} For @file{vc.el}: @samp{Don't call expand-file-name.} | |
2235 @bullet{} For @file{vc-hooks.el}: @samp{Don't call expand-file-name.} | |
2236 @end flushleft | |
2237 | |
2238 @noindent | |
2239 They appear like this in @file{ChangeLog}: | |
2240 | |
2241 @iftex | |
2242 @medbreak | |
2243 @end iftex | |
2244 @smallexample | |
2245 @group | |
2246 1999-04-01 Nathaniel Bowditch <nat@@apn.org> | |
2247 | |
2248 * vc.texinfo: Fix expansion typos. | |
2249 | |
2250 * vc.el, vc-hooks.el: Don't call expand-file-name. | |
2251 @end group | |
2252 @end smallexample | |
2253 @iftex | |
2254 @medbreak | |
2255 @end iftex | |
2256 | |
2257 Normally, @kbd{C-x v a} separates log entries by a blank line, but you | |
2258 can mark several related log entries to be clumped together (without an | |
2259 intervening blank line) by starting the text of each related log entry | |
2260 with a label of the form @w{@samp{@{@var{clumpname}@} }}. The label | |
2261 itself is not copied to @file{ChangeLog}. For example, suppose the log | |
2262 entries are: | |
2263 | |
2264 @flushleft | |
2265 @bullet{} For @file{vc.texinfo}: @samp{@{expand@} Fix expansion typos.} | |
2266 @bullet{} For @file{vc.el}: @samp{@{expand@} Don't call expand-file-name.} | |
2267 @bullet{} For @file{vc-hooks.el}: @samp{@{expand@} Don't call expand-file-name.} | |
2268 @end flushleft | |
2269 | |
2270 @noindent | |
2271 Then the text in @file{ChangeLog} looks like this: | |
2272 | |
2273 @iftex | |
2274 @medbreak | |
2275 @end iftex | |
2276 @smallexample | |
2277 @group | |
2278 1999-04-01 Nathaniel Bowditch <nat@@apn.org> | |
2279 | |
2280 * vc.texinfo: Fix expansion typos. | |
2281 * vc.el, vc-hooks.el: Don't call expand-file-name. | |
2282 @end group | |
2283 @end smallexample | |
2284 @iftex | |
2285 @medbreak | |
2286 @end iftex | |
2287 | |
2288 A log entry whose text begins with @samp{#} is not copied to | |
2289 @file{ChangeLog}. For example, if you merely fix some misspellings in | |
2290 comments, you can log the change with an entry beginning with @samp{#} | |
2291 to avoid putting such trivia into @file{ChangeLog}. | |
2292 | |
2293 @node Renaming and VC | |
2294 @subsubsection Renaming VC Work Files and Master Files | |
2295 | |
2296 @findex vc-rename-file | |
2297 When you rename a registered file, you must also rename its master | |
2298 file correspondingly to get proper results. Use @code{vc-rename-file} | |
2299 to rename the source file as you specify, and rename its master file | |
2300 accordingly. It also updates any snapshots (@pxref{Snapshots}) that | |
2301 mention the file, so that they use the new name; despite this, the | |
2302 snapshot thus modified may not completely work (@pxref{Snapshot | |
2303 Caveats}). | |
2304 | |
2305 You cannot use @code{vc-rename-file} on a file that is locked by | |
2306 someone else. | |
2307 | |
2308 @node Version Headers | |
2309 @subsubsection Inserting Version Control Headers | |
2310 | |
2311 Sometimes it is convenient to put version identification strings | |
2312 directly into working files. Certain special strings called | |
2313 @dfn{version headers} are replaced in each successive version by the | |
2314 number of that version. | |
2315 | |
2316 If you are using RCS, and version headers are present in your working | |
2317 files, Emacs can use them to determine the current version and the | |
2318 locking state of the files. This is more reliable than referring to the | |
2319 master files, which is done when there are no version headers. Note | |
2320 that in a multi-branch environment, version headers are necessary to | |
2321 make VC behave correctly (@pxref{Multi-User Branching}). | |
2322 | |
2323 Searching for version headers is controlled by the variable | |
2324 @code{vc-consult-headers}. If it is non-@code{nil}, Emacs searches for | |
2325 headers to determine the version number you are editing. Setting it to | |
2326 @code{nil} disables this feature. | |
2327 | |
2328 @kindex C-x v h | |
2329 @findex vc-insert-headers | |
2330 You can use the @kbd{C-x v h} command (@code{vc-insert-headers}) to | |
2331 insert a suitable header string. | |
2332 | |
2333 @table @kbd | |
2334 @item C-x v h | |
2335 Insert headers in a file for use with your version-control system. | |
2336 @end table | |
2337 | |
2338 @vindex vc-header-alist | |
2339 The default header string is @samp{@w{$}Id$} for RCS and | |
2340 @samp{@w{%}W%} for SCCS. You can specify other headers to insert by | |
2341 setting the variable @code{vc-header-alist}. Its value is a list of | |
2342 elements of the form @code{(@var{program} . @var{string})} where | |
2343 @var{program} is @code{RCS} or @code{SCCS} and @var{string} is the | |
2344 string to use. | |
2345 | |
2346 Instead of a single string, you can specify a list of strings; then | |
2347 each string in the list is inserted as a separate header on a line of | |
2348 its own. | |
2349 | |
2350 It is often necessary to use ``superfluous'' backslashes when writing | |
2351 the strings that you put in this variable. This is to prevent the | |
2352 string in the constant from being interpreted as a header itself if the | |
2353 Emacs Lisp file containing it is maintained with version control. | |
2354 | |
2355 @vindex vc-comment-alist | |
2356 Each header is inserted surrounded by tabs, inside comment delimiters, | |
2357 on a new line at point. Normally the ordinary comment | |
2358 start and comment end strings of the current mode are used, but for | |
2359 certain modes, there are special comment delimiters for this purpose; | |
2360 the variable @code{vc-comment-alist} specifies them. Each element of | |
2361 this list has the form @code{(@var{mode} @var{starter} @var{ender})}. | |
2362 | |
2363 @vindex vc-static-header-alist | |
2364 The variable @code{vc-static-header-alist} specifies further strings | |
2365 to add based on the name of the buffer. Its value should be a list of | |
2366 elements of the form @code{(@var{regexp} . @var{format})}. Whenever | |
2367 @var{regexp} matches the buffer name, @var{format} is inserted as part | |
2368 of the header. A header line is inserted for each element that matches | |
2369 the buffer name, and for each string specified by | |
2370 @code{vc-header-alist}. The header line is made by processing the | |
2371 string from @code{vc-header-alist} with the format taken from the | |
2372 element. The default value for @code{vc-static-header-alist} is as follows: | |
2373 | |
2374 @example | |
2375 @group | |
2376 (("\\.c$" . | |
2377 "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n\ | |
2378 #endif /* lint */\n")) | |
2379 @end group | |
2380 @end example | |
2381 | |
2382 @noindent | |
2383 It specifies insertion of text of this form: | |
2384 | |
2385 @example | |
2386 @group | |
2387 | |
2388 #ifndef lint | |
2389 static char vcid[] = "@var{string}"; | |
2390 #endif /* lint */ | |
2391 @end group | |
2392 @end example | |
2393 | |
2394 @noindent | |
2395 Note that the text above starts with a blank line. | |
2396 | |
2397 If you use more than one version header in a file, put them close | |
2398 together in the file. The mechanism in @code{revert-buffer} that | |
2399 preserves markers may not handle markers positioned between two version | |
2400 headers. | |
2401 | |
2402 @node Customizing VC | |
2403 @subsection Customizing VC | |
2404 | |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2405 @vindex vc-handled-backends |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2406 The variable @var{vc-handled-backends} determines which version |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2407 control systems VC should handle. The default value is @code{(RCS CVS |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2408 SCCS)}, so it contains all three version systems that are currently |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2409 supported. If you want VC to ignore one or more of these systems, |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2410 exclude its name from the list. |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2411 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2412 The order of systems in the list is significant: when you visit a file |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2413 is registered in more than one system (@pxref{Local Version Control}), |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2414 VC uses the system that comes first in @var{vc-handled-backends} by |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2415 default. The order is also significant when you register a file for |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2416 the first time, @pxref{Registering} for details. |
25829 | 2417 |
2418 @menu | |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2419 * General VC Options:: Options that apply to multiple back ends. |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2420 * RCS and SCCS:: Options for RCS and SCCS. |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2421 * CVS Options:: Options for CVS. |
25829 | 2422 @end menu |
2423 | |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2424 @node General VC Options |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2425 @subsubsection General Options |
25829 | 2426 |
2427 @vindex vc-make-backup-files | |
2428 Emacs normally does not save backup files for source files that are | |
2429 maintained with version control. If you want to make backup files even | |
2430 for files that use version control, set the variable | |
2431 @code{vc-make-backup-files} to a non-@code{nil} value. | |
2432 | |
2433 @vindex vc-keep-workfiles | |
2434 Normally the work file exists all the time, whether it is locked or | |
2435 not. If you set @code{vc-keep-workfiles} to @code{nil}, then checking | |
2436 in a new version with @kbd{C-x C-q} deletes the work file; but any | |
2437 attempt to visit the file with Emacs creates it again. (With CVS, work | |
2438 files are always kept.) | |
2439 | |
2440 @vindex vc-follow-symlinks | |
2441 Editing a version-controlled file through a symbolic link can be | |
2442 dangerous. It bypasses the version control system---you can edit the | |
2443 file without locking it, and fail to check your changes in. Also, | |
2444 your changes might overwrite those of another user. To protect against | |
2445 this, VC checks each symbolic link that you visit, to see if it points | |
2446 to a file under version control. | |
2447 | |
2448 The variable @code{vc-follow-symlinks} controls what to do when a | |
2449 symbolic link points to a version-controlled file. If it is @code{nil}, | |
2450 VC only displays a warning message. If it is @code{t}, VC automatically | |
2451 follows the link, and visits the real file instead, telling you about | |
2452 this in the echo area. If the value is @code{ask} (the default), VC | |
2453 asks you each time whether to follow the link. | |
2454 | |
2455 @vindex vc-suppress-confirm | |
2456 If @code{vc-suppress-confirm} is non-@code{nil}, then @kbd{C-x C-q} | |
2457 and @kbd{C-x v i} can save the current buffer without asking, and | |
2458 @kbd{C-x v u} also operates without asking for confirmation. (This | |
2459 variable does not affect @kbd{C-x v c}; that operation is so drastic | |
2460 that it should always ask for confirmation.) | |
2461 | |
2462 @vindex vc-command-messages | |
2463 VC mode does much of its work by running the shell commands for RCS, | |
2464 CVS and SCCS. If @code{vc-command-messages} is non-@code{nil}, VC | |
2465 displays messages to indicate which shell commands it runs, and | |
2466 additional messages when the commands finish. | |
2467 | |
2468 @vindex vc-path | |
2469 You can specify additional directories to search for version control | |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2470 programs by setting the variable @code{vc-path}. These directories |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2471 are searched before the usual search path. It is rarely necessary to |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2472 set this variable, because VC normally finds the proper files |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2473 automatically. |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2474 |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2475 @node RCS and SCCS |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2476 @subsubsection Options for RCS and SCCS |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2477 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2478 @cindex non-strict locking (RCS) |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2479 @cindex locking, non-strict (RCS) |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2480 By default, RCS uses locking to coordinate the activities of several |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2481 users, but there is a mode called @dfn{non-strict locking} in which |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2482 you can check-in changes without locking the file first. Use |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2483 @samp{rcs -U} to switch to non-strict locking for a particular file, |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2484 see the @code{rcs} manpage for details. |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2485 |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2486 When deducing the version control state of an RCS file, VC first |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2487 looks for an RCS version header string in the file (@pxref{Version |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2488 Headers}). If there is no header string, VC normally looks at the |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2489 file permissions of the work file; this is fast. But there might be |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2490 situations when the file permissions cannot be trusted. In this case |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2491 the master file has to be consulted, which is rather expensive. Also |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2492 the master file can only tell you @emph{if} there's any lock on the |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2493 file, but not whether your work file really contains that locked |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2494 version. |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2495 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2496 @vindex vc-consult-headers |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2497 You can tell VC not to use version headers to determine the file |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2498 status by setting @code{vc-consult-headers} to @code{nil}. VC then |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2499 always uses the file permissions (if it is supposed to trust them), or |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2500 else checks the master file. |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2501 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2502 @vindex vc-mistrust-permissions |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2503 You can specify the criterion for whether to trust the file |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2504 permissions by setting the variable @code{vc-mistrust-permissions}. |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2505 Its value can be @code{t} (always mistrust the file permissions and |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2506 check the master file), @code{nil} (always trust the file |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2507 permissions), or a function of one argument which makes the decision. |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2508 The argument is the directory name of the @file{RCS} subdirectory. A |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2509 non-@code{nil} value from the function says to mistrust the file |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2510 permissions. If you find that the file permissions of work files are |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2511 changed erroneously, set @code{vc-mistrust-permissions} to @code{t}. |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2512 Then VC always checks the master file to determine the file's status. |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2513 |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2514 VC determines the version control state of files under SCCS much as |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2515 with RCS. It does not consider SCCS version headers, though. Thus, |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2516 the variable @var{vc-mistrust-permissions} affects SCCS use, but |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2517 @var{vc-consult-headers} does not. |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2518 |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2519 @node CVS Options |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2520 @subsubsection Options specific for CVS |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2521 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2522 @cindex locking (CVS) |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2523 By default, CVS does not use locking to coordinate the activities of |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2524 several users; anyone can change a work file at any time. However, |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2525 there are ways to restrict this, resulting in behavior that resembles |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2526 locking. |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2527 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2528 @cindex CVSREAD environment variable (CVS) |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2529 For one thing, you can set the @env{CVSREAD} environment variable |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2530 (the value you use makes no difference). If this variable is defined, |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2531 CVS makes your work files read-only by default. In Emacs, you must |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2532 type @kbd{C-x C-q} to make the file writeable, so that editing works |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2533 in fact similar as if locking was used. Note however, that no actual |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2534 locking is performed, so several users can make their files writeable |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2535 at the same time. When setting @env{CVSREAD} for the first time, make |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2536 sure to check out all your modules anew, so that the file protections |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2537 are set correctly. |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2538 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2539 @cindex cvs watch feature |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2540 @cindex watching files (CVS) |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2541 Another way to achieve something similar to locking is to use the |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2542 @dfn{watch} feature of CVS. If a file is being watched, CVS makes it |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2543 read-only by default, and you must also use @kbd{C-x C-q} in Emacs to |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2544 make it writable. VC calls @code{cvs edit} to make the file writeable, |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2545 and CVS takes care to notify other developers of the fact that you |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2546 intend to change the file. See the CVS documentation for details on |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2547 using the watch feature. |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2548 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2549 @vindex vc-cvs-stay-local |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2550 @cindex remote repositories (CVS) |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2551 When a file's repository is on a remote machine, VC tries to keep |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2552 network interactions to a minimum. This is controlled by the variable |
36356
a10bf38295d2
(CVS Options): Mention that t is the default for vc-cvs-stay-local.
André Spiegel <spiegel@gnu.org>
parents:
36355
diff
changeset
|
2553 @var{vc-cvs-stay-local}. If it is @code{t} (the default), then VC uses |
a10bf38295d2
(CVS Options): Mention that t is the default for vc-cvs-stay-local.
André Spiegel <spiegel@gnu.org>
parents:
36355
diff
changeset
|
2554 only the entry in the local CVS subdirectory to determine the file's |
a10bf38295d2
(CVS Options): Mention that t is the default for vc-cvs-stay-local.
André Spiegel <spiegel@gnu.org>
parents:
36355
diff
changeset
|
2555 state (and possibly information returned by previous CVS commands). One |
a10bf38295d2
(CVS Options): Mention that t is the default for vc-cvs-stay-local.
André Spiegel <spiegel@gnu.org>
parents:
36355
diff
changeset
|
2556 consequence of this is that when you have modified a file, and somebody |
a10bf38295d2
(CVS Options): Mention that t is the default for vc-cvs-stay-local.
André Spiegel <spiegel@gnu.org>
parents:
36355
diff
changeset
|
2557 else has already checked in other changes to the file, you are not |
a10bf38295d2
(CVS Options): Mention that t is the default for vc-cvs-stay-local.
André Spiegel <spiegel@gnu.org>
parents:
36355
diff
changeset
|
2558 notified of it until you actually try to commit. (But you can try to |
a10bf38295d2
(CVS Options): Mention that t is the default for vc-cvs-stay-local.
André Spiegel <spiegel@gnu.org>
parents:
36355
diff
changeset
|
2559 pick up any recent changes from the repository first, using @kbd{C-x v m |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2560 @key{RET}}, @pxref{Merging}). |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2561 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2562 When @var{vc-cvs-stay-local} is @code{t}, VC also makes local |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2563 version backups, so that simple diff and revert operations are |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2564 completely local (@pxref{Version Backups}). |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2565 |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2566 On the other hand, if you set @var{vc-cvs-stay-local} to @code{nil}, |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2567 then VC queries the remote repository @emph{before} it decides what to |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2568 do in @code{vc-next-action} (@kbd{C-x v v}), just as it does for local |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2569 repositories. It also does not make any version backups. |
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2570 |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2571 You can also set @var{vc-cvs-stay-local} to a regular expression |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2572 that is matched against the repository hostname; VC then stays local |
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2573 only for repositories from hosts that match the pattern. |
36355
d8c0e3d0f0aa
VC section updated. Added a subsection on remote repositories,
André Spiegel <spiegel@gnu.org>
parents:
36327
diff
changeset
|
2574 |
25829 | 2575 @node Directories |
2576 @section File Directories | |
2577 | |
2578 @cindex file directory | |
2579 @cindex directory listing | |
2580 The file system groups files into @dfn{directories}. A @dfn{directory | |
2581 listing} is a list of all the files in a directory. Emacs provides | |
2582 commands to create and delete directories, and to make directory | |
2583 listings in brief format (file names only) and verbose format (sizes, | |
2584 dates, and authors included). There is also a directory browser called | |
2585 Dired; see @ref{Dired}. | |
2586 | |
2587 @table @kbd | |
2588 @item C-x C-d @var{dir-or-pattern} @key{RET} | |
2589 Display a brief directory listing (@code{list-directory}). | |
2590 @item C-u C-x C-d @var{dir-or-pattern} @key{RET} | |
2591 Display a verbose directory listing. | |
2592 @item M-x make-directory @key{RET} @var{dirname} @key{RET} | |
2593 Create a new directory named @var{dirname}. | |
2594 @item M-x delete-directory @key{RET} @var{dirname} @key{RET} | |
2595 Delete the directory named @var{dirname}. It must be empty, | |
2596 or you get an error. | |
2597 @end table | |
2598 | |
2599 @findex list-directory | |
2600 @kindex C-x C-d | |
2601 The command to display a directory listing is @kbd{C-x C-d} | |
2602 (@code{list-directory}). It reads using the minibuffer a file name | |
2603 which is either a directory to be listed or a wildcard-containing | |
2604 pattern for the files to be listed. For example, | |
2605 | |
2606 @example | |
2607 C-x C-d /u2/emacs/etc @key{RET} | |
2608 @end example | |
2609 | |
2610 @noindent | |
2611 lists all the files in directory @file{/u2/emacs/etc}. Here is an | |
2612 example of specifying a file name pattern: | |
2613 | |
2614 @example | |
2615 C-x C-d /u2/emacs/src/*.c @key{RET} | |
2616 @end example | |
2617 | |
2618 Normally, @kbd{C-x C-d} prints a brief directory listing containing | |
2619 just file names. A numeric argument (regardless of value) tells it to | |
2620 make a verbose listing including sizes, dates, and authors (like | |
2621 @samp{ls -l}). | |
2622 | |
2623 @vindex list-directory-brief-switches | |
2624 @vindex list-directory-verbose-switches | |
2625 The text of a directory listing is obtained by running @code{ls} in an | |
2626 inferior process. Two Emacs variables control the switches passed to | |
2627 @code{ls}: @code{list-directory-brief-switches} is a string giving the | |
2628 switches to use in brief listings (@code{"-CF"} by default), and | |
2629 @code{list-directory-verbose-switches} is a string giving the switches to | |
2630 use in a verbose listing (@code{"-l"} by default). | |
2631 | |
2632 @node Comparing Files | |
2633 @section Comparing Files | |
2634 @cindex comparing files | |
2635 | |
2636 @findex diff | |
2637 @vindex diff-switches | |
2638 The command @kbd{M-x diff} compares two files, displaying the | |
2639 differences in an Emacs buffer named @samp{*Diff*}. It works by running | |
2640 the @code{diff} program, using options taken from the variable | |
2641 @code{diff-switches}, whose value should be a string. | |
2642 | |
2643 The buffer @samp{*Diff*} has Compilation mode as its major mode, so | |
2644 you can use @kbd{C-x `} to visit successive changed locations in the two | |
2645 source files. You can also move to a particular hunk of changes and | |
2646 type @key{RET} or @kbd{C-c C-c}, or click @kbd{Mouse-2} on it, to move | |
2647 to the corresponding source location. You can also use the other | |
2648 special commands of Compilation mode: @key{SPC} and @key{DEL} for | |
2649 scrolling, and @kbd{M-p} and @kbd{M-n} for cursor motion. | |
2650 @xref{Compilation}. | |
2651 | |
2652 @findex diff-backup | |
2653 The command @kbd{M-x diff-backup} compares a specified file with its most | |
2654 recent backup. If you specify the name of a backup file, | |
2655 @code{diff-backup} compares it with the source file that it is a backup | |
2656 of. | |
2657 | |
2658 @findex compare-windows | |
2659 The command @kbd{M-x compare-windows} compares the text in the current | |
2660 window with that in the next window. Comparison starts at point in each | |
2661 window, and each starting position is pushed on the mark ring in its | |
2662 respective buffer. Then point moves forward in each window, a character | |
2663 at a time, until a mismatch between the two windows is reached. Then | |
2664 the command is finished. For more information about windows in Emacs, | |
2665 @ref{Windows}. | |
2666 | |
2667 @vindex compare-ignore-case | |
2668 With a numeric argument, @code{compare-windows} ignores changes in | |
2669 whitespace. If the variable @code{compare-ignore-case} is | |
2670 non-@code{nil}, it ignores differences in case as well. | |
2671 | |
31076 | 2672 @findex diff-mode |
2673 @cindex diffs | |
2674 @cindex patches | |
2675 @cindex Diff mode | |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2676 Differences between versions of files are often distributed as |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2677 @dfn{patches}, which are the output from @command{diff} or a version |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2678 control system that uses @command{diff}. @kbd{M-x diff-mode} turns on |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2679 Diff mode, a major mode for viewing and editing patches, either as |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2680 ``unified diffs'' or ``context diffs.'' |
31076 | 2681 |
2682 @cindex Smerge mode | |
2683 @findex smerge-mode | |
2684 @cindex failed merges | |
2685 @cindex merges, failed | |
36274
91f2160d4468
Remove two more redundant index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36263
diff
changeset
|
2686 @cindex comparing 3 files (@code{diff3}) |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2687 You can use @kbd{M-x smerge-mode} to turn on Smerge mode, a minor |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2688 mode for editing output from the @command{diff3} program. This is |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2689 typically the result of a failed merge from a version control system |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2690 ``update'' outside VC, due to conflicting changes to a file. Smerge |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2691 mode provides commands to resolve conflicts by selecting specific |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2692 changes. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2693 |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2694 See also @ref{Emerge}, and @ref{Top,,, ediff, The Ediff Manual}, for |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2695 convenient facilities for merging two similar files. |
25829 | 2696 |
2697 @node Misc File Ops | |
2698 @section Miscellaneous File Operations | |
2699 | |
2700 Emacs has commands for performing many other operations on files. | |
2701 All operate on one file; they do not accept wildcard file names. | |
2702 | |
2703 @findex view-file | |
2704 @cindex viewing | |
2705 @cindex View mode | |
2706 @cindex mode, View | |
2707 @kbd{M-x view-file} allows you to scan or read a file by sequential | |
2708 screenfuls. It reads a file name argument using the minibuffer. After | |
2709 reading the file into an Emacs buffer, @code{view-file} displays the | |
2710 beginning. You can then type @key{SPC} to scroll forward one windowful, | |
2711 or @key{DEL} to scroll backward. Various other commands are provided | |
2712 for moving around in the file, but none for changing it; type @kbd{?} | |
2713 while viewing for a list of them. They are mostly the same as normal | |
2714 Emacs cursor motion commands. To exit from viewing, type @kbd{q}. | |
2715 The commands for viewing are defined by a special major mode called View | |
2716 mode. | |
2717 | |
2718 A related command, @kbd{M-x view-buffer}, views a buffer already present | |
2719 in Emacs. @xref{Misc Buffer}. | |
2720 | |
2721 @findex insert-file | |
2722 @kbd{M-x insert-file} inserts a copy of the contents of the specified | |
2723 file into the current buffer at point, leaving point unchanged before the | |
2724 contents and the mark after them. | |
2725 | |
2726 @findex write-region | |
2727 @kbd{M-x write-region} is the inverse of @kbd{M-x insert-file}; it | |
2728 copies the contents of the region into the specified file. @kbd{M-x | |
2729 append-to-file} adds the text of the region to the end of the specified | |
2730 file. @xref{Accumulating Text}. | |
2731 | |
2732 @findex delete-file | |
2733 @cindex deletion (of files) | |
2734 @kbd{M-x delete-file} deletes the specified file, like the @code{rm} | |
2735 command in the shell. If you are deleting many files in one directory, it | |
2736 may be more convenient to use Dired (@pxref{Dired}). | |
2737 | |
2738 @findex rename-file | |
2739 @kbd{M-x rename-file} reads two file names @var{old} and @var{new} using | |
2740 the minibuffer, then renames file @var{old} as @var{new}. If a file named | |
2741 @var{new} already exists, you must confirm with @kbd{yes} or renaming is not | |
2742 done; this is because renaming causes the old meaning of the name @var{new} | |
2743 to be lost. If @var{old} and @var{new} are on different file systems, the | |
2744 file @var{old} is copied and deleted. | |
2745 | |
2746 @findex add-name-to-file | |
2747 The similar command @kbd{M-x add-name-to-file} is used to add an | |
2748 additional name to an existing file without removing its old name. | |
2749 The new name must belong on the same file system that the file is on. | |
2750 | |
2751 @findex copy-file | |
2752 @cindex copying files | |
2753 @kbd{M-x copy-file} reads the file @var{old} and writes a new file named | |
2754 @var{new} with the same contents. Confirmation is required if a file named | |
2755 @var{new} already exists, because copying has the consequence of overwriting | |
2756 the old contents of the file @var{new}. | |
2757 | |
2758 @findex make-symbolic-link | |
2759 @kbd{M-x make-symbolic-link} reads two file names @var{target} and | |
2760 @var{linkname}, then creates a symbolic link named @var{linkname} and | |
2761 pointing at @var{target}. The effect is that future attempts to open file | |
2762 @var{linkname} will refer to whatever file is named @var{target} at the | |
2763 time the opening is done, or will get an error if the name @var{target} is | |
2764 not in use at that time. This command does not expand the argument | |
2765 @var{target}, so that it allows you to specify a relative name | |
2766 as the target of the link. | |
2767 | |
2768 Confirmation is required when creating the link if @var{linkname} is | |
2769 in use. Note that not all systems support symbolic links. | |
2770 | |
2771 @node Compressed Files | |
2772 @section Accessing Compressed Files | |
2773 @cindex compression | |
2774 @cindex uncompression | |
2775 @cindex Auto Compression mode | |
2776 @cindex mode, Auto Compression | |
2777 @pindex gzip | |
2778 | |
2779 @findex auto-compression-mode | |
28123
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2780 @vindex auto-compression-mode |
25829 | 2781 Emacs comes with a library that can automatically uncompress |
2782 compressed files when you visit them, and automatically recompress them | |
2783 if you alter them and save them. To enable this feature, type the | |
28123
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2784 command @kbd{M-x auto-compression-mode}. You can enable it permanently |
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2785 by customizing the option @var{auto-compression-mode}. |
25829 | 2786 |
2787 When automatic compression (which implies automatic uncompression as | |
2788 well) is enabled, Emacs recognizes compressed files by their file names. | |
2789 File names ending in @samp{.gz} indicate a file compressed with | |
2790 @code{gzip}. Other endings indicate other compression programs. | |
2791 | |
2792 Automatic uncompression and compression apply to all the operations in | |
2793 which Emacs uses the contents of a file. This includes visiting it, | |
2794 saving it, inserting its contents into a buffer, loading it, and byte | |
2795 compiling it. | |
2796 | |
28123
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2797 @node File Archives |
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2798 @section File Archives |
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2799 @cindex mode, tar |
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2800 @cindex Tar mode |
36274
91f2160d4468
Remove two more redundant index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36263
diff
changeset
|
2801 @cindex file archives |
29683
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2802 |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2803 A file whose name ends in @samp{.tar} is normally an @dfn{archive} |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2804 made by the @code{tar} program. Emacs views these files in a special |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2805 mode called Tar mode which provides a Dired-like list of the contents |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2806 (@pxref{Dired}). You can move around through the list just as you |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2807 would in Dired, and visit the subfiles contained in the archive. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2808 However, not all Dired commands are available in Tar mode. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2809 |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2810 If you enable Auto Compression mode (@pxref{Compressed Files}), then |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2811 Tar mode is used also for compressed archives---files with extensions |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2812 @samp{.tgz}, @code{.tar.Z} and @code{.tar.gz}. |
29683
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2813 |
36385
d7ca85bd6906
Clean up recent VC updates.
Richard M. Stallman <rms@gnu.org>
parents:
36360
diff
changeset
|
2814 The keys @kbd{e}, @kbd{f} and @key{RET} all extract a component file |
29683
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2815 into its own buffer. You can edit it there and when you save the buffer |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2816 the edited version will replace the version in the Tar buffer. @kbd{v} |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2817 extracts a file into a buffer in View mode. @kbd{o} extracts the file |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2818 and displays it in another window, so you could edit the file and |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2819 operate on the archive simultaneously. @kbd{d} marks a file for |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2820 deletion when you later use @kbd{x}, and @kbd{u} unmarks a file, as in |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2821 Dired. @kbd{C} copies a file from the archive to disk and @kbd{R} |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2822 renames a file. @kbd{g} reverts the buffer from the archive on disk. |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2823 |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2824 The keys @kbd{M}, @kbd{G}, and @kbd{O} change the file's permission |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2825 bits, group, and owner, respectively. |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2826 |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2827 If your display supports colors and the mouse, moving the mouse |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2828 pointer across a file name highlights that file name, indicating that |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2829 you can click on it. Clicking @kbd{Mouse-2} on the highlighted file |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2830 name extracts the file into a buffer and displays that buffer. |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2831 |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2832 Saving the Tar buffer writes a new version of the archive to disk with |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2833 the changes you made to the components. |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2834 |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2835 You don't need the @code{tar} program to use Tar mode---Emacs reads |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2836 the archives directly. However, accessing compressed archives |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2837 requires the appropriate uncompression program. |
31076 | 2838 |
28123
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2839 @cindex Archive mode |
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2840 @cindex mode, archive |
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2841 @cindex @code{arc} |
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2842 @cindex @code{jar} |
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2843 @cindex @code{zip} |
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2844 @cindex @code{lzh} |
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2845 @cindex @code{zoo} |
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2846 @pindex arc |
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2847 @pindex jar |
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2848 @pindex zip |
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2849 @pindex lzh |
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2850 @pindex zoo |
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2851 @cindex Java class archives |
29683
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2852 @cindex unzip archives |
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2853 A separate but similar Archive mode is used for archives produced by |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2854 the programs @code{arc}, @code{jar}, @code{lzh}, @code{zip}, and |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2855 @code{zoo}, which have extensions corresponding to the program names. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2856 |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2857 The keybindings of Archive mode are similar to those in Tar mode, |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2858 with the addition of the @kbd{m} key which marks a file for subsequent |
29683
324386e590b7
(File Archives): Remove redundant index entries. Add some more Tar
Eli Zaretskii <eliz@gnu.org>
parents:
29556
diff
changeset
|
2859 operations, and @kbd{M-@key{DEL}} which unmarks all the marked files. |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2860 Also, the @kbd{a} key toggles the display of detailed file |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2861 information, for those archive types where it won't fit in a single |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2862 line. Operations such as renaming a subfile, or changing its mode or |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2863 owner, are supported only for some of the archive formats. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2864 |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2865 Unlike Tar mode, Archive mode runs the archiving program to unpack |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2866 and repack archives. Details of the program names and their options |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2867 can be set in the @samp{Archive} Customize group. However, you don't |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2868 need these programs to the archive table of contents, only to extract |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2869 or manipulate the subfiles in the archive. |
28123
6e2e72ee55a6
(Compressed Files): Note custom option.
Dave Love <fx@gnu.org>
parents:
26105
diff
changeset
|
2870 |
25829 | 2871 @node Remote Files |
2872 @section Remote Files | |
2873 | |
2874 @cindex FTP | |
2875 @cindex remote file access | |
2876 You can refer to files on other machines using a special file name syntax: | |
2877 | |
2878 @example | |
2879 @group | |
2880 /@var{host}:@var{filename} | |
2881 /@var{user}@@@var{host}:@var{filename} | |
26105 | 2882 /@var{user}@@@var{host}#@var{port}:@var{filename} |
25829 | 2883 @end group |
2884 @end example | |
2885 | |
2886 @noindent | |
2887 When you do this, Emacs uses the FTP program to read and write files on | |
2888 the specified host. It logs in through FTP using your user name or the | |
2889 name @var{user}. It may ask you for a password from time to time; this | |
26105 | 2890 is used for logging in on @var{host}. The form using @var{port} allows |
2891 you to access servers running on a non-default TCP port. | |
25829 | 2892 |
35908
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2893 @cindex backups for remote files |
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2894 @vindex ange-ftp-make-backup-files |
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2895 If you want to disable backups for remote files, set the variable |
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2896 @code{ange-ftp-make-backup-files} to @code{nil}. |
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2897 |
25829 | 2898 @cindex ange-ftp |
2899 @vindex ange-ftp-default-user | |
35908
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2900 @cindex user name for remote file access |
25829 | 2901 Normally, if you do not specify a user name in a remote file name, |
2902 that means to use your own user name. But if you set the variable | |
2903 @code{ange-ftp-default-user} to a string, that string is used instead. | |
2904 (The Emacs package that implements FTP file access is called | |
2905 @code{ange-ftp}.) | |
2906 | |
35908
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2907 @cindex anonymous FTP |
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2908 @vindex ange-ftp-generate-anonymous-password |
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2909 To visit files accessible by anonymous FTP, you use special user |
36155
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36136
diff
changeset
|
2910 names @samp{anonymous} or @samp{ftp}. Passwords for these user names |
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36136
diff
changeset
|
2911 are handled specially. The variable |
35908
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2912 @code{ange-ftp-generate-anonymous-password} controls what happens: if |
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2913 the value of this variable is a string, then that string is used as |
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2914 the password; if non-@code{nil} (the default), then the value of |
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2915 @code{user-mail-address} is used; if @code{nil}, the user is prompted |
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2916 for a password as normal. |
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2917 |
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2918 @cindex firewall, and accessing remote files |
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2919 @cindex gateway, and remote file access with @code{ange-ftp} |
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2920 @vindex ange-ftp-smart-gateway |
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2921 @vindex ange-ftp-gateway-host |
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2922 Sometimes you may be unable to access files on a remote machine |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2923 because a @dfn{firewall} in between blocks the connection for security |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2924 reasons. If you can log in on a @dfn{gateway} machine from which the |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2925 target files @emph{are} accessible, and whose FTP server supports |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2926 gatewaying features, you can still use remote file names; all you have |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2927 to do is specify the name of the gateway machine by setting the |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2928 variable @code{ange-ftp-gateway-host}, and set |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2929 @code{ange-ftp-smart-gateway} to @code{t}. Otherwise you may be able |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2930 to make remote file names work, but the procedure is complex. You can |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2931 read the instructions by typing @kbd{M-x finder-commentary @key{RET} |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2932 ange-ftp @key{RET}}. |
35908
4ba2a6029c03
(Remote Files): Explain how to use ange-ftp behind firewalls. Add a
Eli Zaretskii <eliz@gnu.org>
parents:
35731
diff
changeset
|
2933 |
25829 | 2934 @vindex file-name-handler-alist |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2935 @cindex disabling remote files |
26105 | 2936 You can entirely turn off the FTP file name feature by removing the |
2937 entries @var{ange-ftp-completion-hook-function} and | |
2938 @var{ange-ftp-hook-function} from the variable | |
28327
f7b17a6af3db
(Visiting): List wildcard chars. Mention find-file-wildcards.
Dave Love <fx@gnu.org>
parents:
28123
diff
changeset
|
2939 @code{file-name-handler-alist}. You can turn off the feature in |
f7b17a6af3db
(Visiting): List wildcard chars. Mention find-file-wildcards.
Dave Love <fx@gnu.org>
parents:
28123
diff
changeset
|
2940 individual cases by quoting the file name with @samp{/:} (@pxref{Quoted |
f7b17a6af3db
(Visiting): List wildcard chars. Mention find-file-wildcards.
Dave Love <fx@gnu.org>
parents:
28123
diff
changeset
|
2941 File Names}). |
25829 | 2942 |
2943 @node Quoted File Names | |
2944 @section Quoted File Names | |
2945 | |
2946 @cindex quoting file names | |
2947 You can @dfn{quote} an absolute file name to prevent special | |
2948 characters and syntax in it from having their special effects. | |
2949 The way to do this is to add @samp{/:} at the beginning. | |
2950 | |
2951 For example, you can quote a local file name which appears remote, to | |
2952 prevent it from being treated as a remote file name. Thus, if you have | |
2953 a directory named @file{/foo:} and a file named @file{bar} in it, you | |
2954 can refer to that file in Emacs as @samp{/:/foo:/bar}. | |
2955 | |
2956 @samp{/:} can also prevent @samp{~} from being treated as a special | |
2957 character for a user's home directory. For example, @file{/:/tmp/~hack} | |
2958 refers to a file whose name is @file{~hack} in directory @file{/tmp}. | |
2959 | |
2960 Likewise, quoting with @samp{/:} is one way to enter in the minibuffer | |
2961 a file name that contains @samp{$}. However, the @samp{/:} must be at | |
2962 the beginning of the buffer in order to quote @samp{$}. | |
2963 | |
2964 You can also quote wildcard characters with @samp{/:}, for visiting. | |
2965 For example, @file{/:/tmp/foo*bar} visits the file @file{/tmp/foo*bar}. | |
2966 However, in most cases you can simply type the wildcard characters for | |
2967 themselves. For example, if the only file name in @file{/tmp} that | |
2968 starts with @samp{foo} and ends with @samp{bar} is @file{foo*bar}, then | |
2969 specifying @file{/tmp/foo*bar} will visit just @file{/tmp/foo*bar}. | |
28327
f7b17a6af3db
(Visiting): List wildcard chars. Mention find-file-wildcards.
Dave Love <fx@gnu.org>
parents:
28123
diff
changeset
|
2970 Another way is to specify @file{/tmp/foo[*]bar}. |
28526
297e03ccd7e6
(Backup): backup-enable-predicate.
Dave Love <fx@gnu.org>
parents:
28327
diff
changeset
|
2971 |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2972 @node File Name Cache |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2973 @section File Name Cache |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2974 |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2975 @cindex file name caching |
28671 | 2976 @cindex cache of file names |
2977 @pindex find | |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2978 @kindex C-@key{TAB} |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2979 @findex file-cache-minibuffer-complete |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2980 You can use the @dfn{file name cache} to make it easy to locate a |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2981 file by name, without having to remember exactly where it is located. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2982 When typing a file name in the minibuffer, @kbd{C-@key{tab}} |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2983 (@code{file-cache-minibuffer-complete}) completes it using the file |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2984 name cache. If you repeat @kbd{C-@key{tab}}, that cycles through the |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2985 possible completions of what you had originally typed. Note that the |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2986 @kbd{C-@key{tab}} character cannot be typed on most text-only |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2987 terminals. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2988 |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2989 The file name cache does not fill up automatically. Instead, you |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2990 load file names into the cache using these commands: |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2991 |
31076 | 2992 @findex file-cache-add-directory |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2993 @table @kbd |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2994 @item M-x file-cache-add-directory @key{RET} @var{directory} @key{RET} |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2995 Add each file name in @var{directory} to the file name cache. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2996 @item M-x file-cache-add-directory-using-find @key{RET} @var{directory} @key{RET} |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2997 Add each file name in @var{directory} and all of its nested |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2998 subdirectories to the file name cache. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
2999 @item M-x file-cache-add-directory-using-locate @key{RET} @var{directory} @key{RET} |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3000 Add each file name in @var{directory} and all of its nested |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3001 subdirectories to the file name cache, using @command{locate} to find |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3002 them all. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3003 @item M-x file-cache-add-directory-list @key{RET} @var{variable} @key{RET} |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3004 Add each file name in each directory listed in @var{variable} |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3005 to the file name cache. @var{variable} should be a Lisp variable |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3006 such as @code{load-path} or @code{exec-path}, whose value is a list |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3007 of directory names. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3008 @item M-x file-cache-clear-cache @key{RET} |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3009 Clear the cache; that is, remove all file names from it. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3010 @end table |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3011 |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3012 @node File Conveniences |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3013 @section Convenience Features for Finding Files |
31076 | 3014 |
3015 @findex recentf-mode | |
3016 @vindex recentf-mode | |
3017 @findex recentf-save-list | |
3018 @findex recentf-edit-list | |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3019 If you enable Recentf mode, with @kbd{M-x recentf-mode}, the |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3020 @samp{Files} menu includes a submenu containing a list of recently |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3021 opened files. @kbd{M-x recentf-save-list} saves the current |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3022 recent-file-list to a file, and @kbd{M-x recentf-edit-list} edits it. |
32221 | 3023 |
3024 @findex auto-image-file-mode | |
3025 @findex mode, auto-image-file | |
3026 @cindex images, visiting | |
3027 @cindex visiting image files | |
3028 @vindex image-file-name-regexps | |
3029 @vindex image-file-name-extensions | |
36136
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3030 When Auto-image-file minor mode is enabled, visiting an image file |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3031 displays it as an image, not as text. Likewise, inserting an image |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3032 file into a buffer inserts it as an image. This works only when Emacs |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3033 can display the relevant image type. The variables |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3034 @code{image-file-name-extensions} or @code{image-file-name-regexps} |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3035 control which file names are recognized as containing images. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3036 |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3037 The @kbd{M-x ffap} command generalizes @code{find-file} with more |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3038 powerful heuristic defaults (@pxref{FFAP}), often based on the text at |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3039 point. Partial Completion mode offers other features extending |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3040 @code{find-file}, which can be used with @code{ffap}. |
a5ae50ec6fe7
Many small clarifications.
Richard M. Stallman <rms@gnu.org>
parents:
35919
diff
changeset
|
3041 @xref{Completion Options}. |