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