annotate man/files.texi @ 59701:5f125540565b

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