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