Mercurial > emacs
annotate lispref/backups.texi @ 25852:03ddf0b96330
#CENSORSHIP
author | Dave Love <fx@gnu.org> |
---|---|
date | Sun, 03 Oct 1999 12:17:04 +0000 |
parents | 467b88fab665 |
children | 6a17c48b52ef |
rev | line source |
---|---|
6564 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995 Free Software Foundation, Inc. |
6564 | 4 @c See the file elisp.texi for copying conditions. |
5 @setfilename ../info/backups | |
6 @node Backups and Auto-Saving, Buffers, Files, Top | |
7 @chapter Backups and Auto-Saving | |
8 | |
9 Backup files and auto-save files are two methods by which Emacs tries | |
10 to protect the user from the consequences of crashes or of the user's | |
11 own errors. Auto-saving preserves the text from earlier in the current | |
12 editing session; backup files preserve file contents prior to the | |
13 current session. | |
14 | |
15 @menu | |
16 * Backup Files:: How backup files are made; how their names are chosen. | |
17 * Auto-Saving:: How auto-save files are made; how their names are chosen. | |
18 * Reverting:: @code{revert-buffer}, and how to customize what it does. | |
19 @end menu | |
20 | |
6966
cf60a8adeadd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
21 @node Backup Files |
6564 | 22 @section Backup Files |
23 @cindex backup file | |
24 | |
25 A @dfn{backup file} is a copy of the old contents of a file you are | |
26 editing. Emacs makes a backup file the first time you save a buffer | |
27 into its visited file. Normally, this means that the backup file | |
28 contains the contents of the file as it was before the current editing | |
29 session. The contents of the backup file normally remain unchanged once | |
30 it exists. | |
31 | |
32 Backups are usually made by renaming the visited file to a new name. | |
33 Optionally, you can specify that backup files should be made by copying | |
34 the visited file. This choice makes a difference for files with | |
35 multiple names; it also can affect whether the edited file remains owned | |
36 by the original owner or becomes owned by the user editing it. | |
37 | |
38 By default, Emacs makes a single backup file for each file edited. | |
39 You can alternatively request numbered backups; then each new backup | |
40 file gets a new name. You can delete old numbered backups when you | |
41 don't want them any more, or Emacs can delete them automatically. | |
42 | |
43 @menu | |
44 * Making Backups:: How Emacs makes backup files, and when. | |
45 * Rename or Copy:: Two alternatives: renaming the old file or copying it. | |
46 * Numbered Backups:: Keeping multiple backups for each source file. | |
47 * Backup Names:: How backup file names are computed; customization. | |
48 @end menu | |
49 | |
6966
cf60a8adeadd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
50 @node Making Backups |
6564 | 51 @subsection Making Backup Files |
52 | |
53 @defun backup-buffer | |
54 This function makes a backup of the file visited by the current | |
55 buffer, if appropriate. It is called by @code{save-buffer} before | |
56 saving the buffer the first time. | |
57 @end defun | |
58 | |
59 @defvar buffer-backed-up | |
60 This buffer-local variable indicates whether this buffer's file has | |
61 been backed up on account of this buffer. If it is non-@code{nil}, then | |
62 the backup file has been written. Otherwise, the file should be backed | |
7336 | 63 up when it is next saved (if backups are enabled). This is a |
6564 | 64 permanent local; @code{kill-local-variables} does not alter it. |
65 @end defvar | |
66 | |
67 @defopt make-backup-files | |
12098 | 68 This variable determines whether or not to make backup files. If it |
6564 | 69 is non-@code{nil}, then Emacs creates a backup of each file when it is |
12098 | 70 saved for the first time---provided that @code{backup-inhibited} |
71 is @code{nil} (see below). | |
6564 | 72 |
12098 | 73 The following example shows how to change the @code{make-backup-files} |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
74 variable only in the Rmail buffers and not elsewhere. Setting it |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
75 @code{nil} stops Emacs from making backups of these files, which may |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
76 save disk space. (You would put this code in your @file{.emacs} file.) |
6564 | 77 |
78 @smallexample | |
79 @group | |
80 (add-hook 'rmail-mode-hook | |
81 (function (lambda () | |
82 (make-local-variable | |
83 'make-backup-files) | |
84 (setq make-backup-files nil)))) | |
85 @end group | |
86 @end smallexample | |
87 @end defopt | |
88 | |
7336 | 89 @defvar backup-enable-predicate |
6564 | 90 This variable's value is a function to be called on certain occasions to |
7336 | 91 decide whether a file should have backup files. The function receives |
92 one argument, a file name to consider. If the function returns | |
93 @code{nil}, backups are disabled for that file. Otherwise, the other | |
94 variables in this section say whether and how to make backups. | |
6564 | 95 |
96 The default value is this: | |
97 | |
98 @example | |
99 (lambda (name) | |
100 (or (< (length name) 5) | |
101 (not (string-equal "/tmp/" | |
102 (substring name 0 5))))) | |
103 @end example | |
104 @end defvar | |
105 | |
106 @defvar backup-inhibited | |
107 If this variable is non-@code{nil}, backups are inhibited. It records | |
108 the result of testing @code{backup-enable-predicate} on the visited file | |
109 name. It can also coherently be used by other mechanisms that inhibit | |
12098 | 110 backups based on which file is visited. For example, VC sets this |
111 variable non-@code{nil} to prevent making backups for files managed | |
112 with a version control system. | |
7336 | 113 |
12098 | 114 This is a permanent local, so that changing the major mode does not lose |
115 its value. Major modes should not set this variable---they should set | |
7336 | 116 @code{make-backup-files} instead. |
6564 | 117 @end defvar |
118 | |
6966
cf60a8adeadd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
119 @node Rename or Copy |
6564 | 120 @subsection Backup by Renaming or by Copying? |
121 @cindex backup files, how to make them | |
122 | |
123 There are two ways that Emacs can make a backup file: | |
124 | |
125 @itemize @bullet | |
126 @item | |
127 Emacs can rename the original file so that it becomes a backup file, and | |
128 then write the buffer being saved into a new file. After this | |
129 procedure, any other names (i.e., hard links) of the original file now | |
130 refer to the backup file. The new file is owned by the user doing the | |
131 editing, and its group is the default for new files written by the user | |
132 in that directory. | |
133 | |
134 @item | |
135 Emacs can copy the original file into a backup file, and then overwrite | |
136 the original file with new contents. After this procedure, any other | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
137 names (i.e., hard links) of the original file continue to refer to the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
138 current (updated) version of the file. The file's owner and group will |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
139 be unchanged. |
6564 | 140 @end itemize |
141 | |
142 The first method, renaming, is the default. | |
143 | |
144 The variable @code{backup-by-copying}, if non-@code{nil}, says to use | |
145 the second method, which is to copy the original file and overwrite it | |
146 with the new buffer contents. The variable @code{file-precious-flag}, | |
147 if non-@code{nil}, also has this effect (as a sideline of its main | |
148 significance). @xref{Saving Buffers}. | |
149 | |
150 @defvar backup-by-copying | |
151 If this variable is non-@code{nil}, Emacs always makes backup files by | |
152 copying. | |
153 @end defvar | |
154 | |
155 The following two variables, when non-@code{nil}, cause the second | |
156 method to be used in certain special cases. They have no effect on the | |
157 treatment of files that don't fall into the special cases. | |
158 | |
159 @defvar backup-by-copying-when-linked | |
160 If this variable is non-@code{nil}, Emacs makes backups by copying for | |
161 files with multiple names (hard links). | |
162 | |
163 This variable is significant only if @code{backup-by-copying} is | |
164 @code{nil}, since copying is always used when that variable is | |
165 non-@code{nil}. | |
166 @end defvar | |
167 | |
168 @defvar backup-by-copying-when-mismatch | |
169 If this variable is non-@code{nil}, Emacs makes backups by copying in cases | |
170 where renaming would change either the owner or the group of the file. | |
171 | |
172 The value has no effect when renaming would not alter the owner or | |
173 group of the file; that is, for files which are owned by the user and | |
174 whose group matches the default for a new file created there by the | |
175 user. | |
176 | |
177 This variable is significant only if @code{backup-by-copying} is | |
178 @code{nil}, since copying is always used when that variable is | |
179 non-@code{nil}. | |
180 @end defvar | |
181 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
182 @defvar backup-by-copying-when-privileged-mismatch |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
183 This variable, if non-@code{nil}, specifies the same behavior as |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
184 @code{backup-by-copying-when-mismatch}, but only for certain user-id |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
185 values: namely, those less than or equal to a certain number. You set |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
186 this variable to that number. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
187 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
188 Thus, if you set @code{backup-by-copying-when-privileged-mismatch} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
189 to 0, backup by copying is done for the superuser only, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
190 when necessary to prevent a change in the owner of the file. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
191 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
192 The default is 200. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
193 @end defvar |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
194 |
6966
cf60a8adeadd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
195 @node Numbered Backups |
6564 | 196 @subsection Making and Deleting Numbered Backup Files |
197 | |
198 If a file's name is @file{foo}, the names of its numbered backup | |
199 versions are @file{foo.~@var{v}~}, for various integers @var{v}, like | |
200 this: @file{foo.~1~}, @file{foo.~2~}, @file{foo.~3~}, @dots{}, | |
201 @file{foo.~259~}, and so on. | |
202 | |
203 @defopt version-control | |
204 This variable controls whether to make a single non-numbered backup | |
205 file or multiple numbered backups. | |
206 | |
207 @table @asis | |
208 @item @code{nil} | |
209 Make numbered backups if the visited file already has numbered backups; | |
210 otherwise, do not. | |
211 | |
212 @item @code{never} | |
213 Do not make numbered backups. | |
214 | |
215 @item @var{anything else} | |
7336 | 216 Make numbered backups. |
6564 | 217 @end table |
218 @end defopt | |
219 | |
220 The use of numbered backups ultimately leads to a large number of | |
221 backup versions, which must then be deleted. Emacs can do this | |
7336 | 222 automatically or it can ask the user whether to delete them. |
6564 | 223 |
224 @defopt kept-new-versions | |
7336 | 225 The value of this variable is the number of newest versions to keep |
6564 | 226 when a new numbered backup is made. The newly made backup is included |
227 in the count. The default value is 2. | |
228 @end defopt | |
229 | |
230 @defopt kept-old-versions | |
231 The value of this variable is the number of oldest versions to keep | |
232 when a new numbered backup is made. The default value is 2. | |
233 @end defopt | |
234 | |
235 If there are backups numbered 1, 2, 3, 5, and 7, and both of these | |
236 variables have the value 2, then the backups numbered 1 and 2 are kept | |
237 as old versions and those numbered 5 and 7 are kept as new versions; | |
7336 | 238 backup version 3 is excess. The function @code{find-backup-file-name} |
6564 | 239 (@pxref{Backup Names}) is responsible for determining which backup |
240 versions to delete, but does not delete them itself. | |
241 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
242 @tindex delete-old-versions |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
243 @defopt delete-old-versions |
6564 | 244 If this variable is non-@code{nil}, then saving a file deletes excess |
245 backup versions silently. Otherwise, it asks the user whether to delete | |
246 them. | |
247 @end defopt | |
248 | |
249 @defopt dired-kept-versions | |
250 This variable specifies how many of the newest backup versions to keep | |
251 in the Dired command @kbd{.} (@code{dired-clean-directory}). That's the | |
7336 | 252 same thing @code{kept-new-versions} specifies when you make a new backup |
6564 | 253 file. The default value is 2. |
254 @end defopt | |
255 | |
6966
cf60a8adeadd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
256 @node Backup Names |
6564 | 257 @subsection Naming Backup Files |
258 | |
259 The functions in this section are documented mainly because you can | |
260 customize the naming conventions for backup files by redefining them. | |
261 If you change one, you probably need to change the rest. | |
262 | |
263 @defun backup-file-name-p filename | |
264 This function returns a non-@code{nil} value if @var{filename} is a | |
265 possible name for a backup file. A file with the name @var{filename} | |
266 need not exist; the function just checks the name. | |
267 | |
268 @smallexample | |
269 @group | |
270 (backup-file-name-p "foo") | |
271 @result{} nil | |
272 @end group | |
273 @group | |
274 (backup-file-name-p "foo~") | |
275 @result{} 3 | |
276 @end group | |
277 @end smallexample | |
278 | |
279 The standard definition of this function is as follows: | |
280 | |
281 @smallexample | |
282 @group | |
283 (defun backup-file-name-p (file) | |
284 "Return non-nil if FILE is a backup file \ | |
285 name (numeric or not)..." | |
286 (string-match "~$" file)) | |
287 @end group | |
288 @end smallexample | |
289 | |
290 @noindent | |
291 Thus, the function returns a non-@code{nil} value if the file name ends | |
292 with a @samp{~}. (We use a backslash to split the documentation | |
293 string's first line into two lines in the text, but produce just one | |
294 line in the string itself.) | |
295 | |
296 This simple expression is placed in a separate function to make it easy | |
297 to redefine for customization. | |
298 @end defun | |
299 | |
300 @defun make-backup-file-name filename | |
7336 | 301 This function returns a string that is the name to use for a |
6564 | 302 non-numbered backup file for file @var{filename}. On Unix, this is just |
303 @var{filename} with a tilde appended. | |
304 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
305 The standard definition of this function, on most operating systems, is |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
306 as follows: |
6564 | 307 |
308 @smallexample | |
309 @group | |
310 (defun make-backup-file-name (file) | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
311 "Create the non-numeric backup file name for FILE@enddots{}" |
6564 | 312 (concat file "~")) |
313 @end group | |
314 @end smallexample | |
315 | |
7336 | 316 You can change the backup-file naming convention by redefining this |
6564 | 317 function. The following example redefines @code{make-backup-file-name} |
7336 | 318 to prepend a @samp{.} in addition to appending a tilde: |
6564 | 319 |
320 @smallexample | |
321 @group | |
322 (defun make-backup-file-name (filename) | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
323 (expand-file-name |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
324 (concat "." (file-name-nondirectory filename) "~") |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
325 (file-name-directory filename))) |
6564 | 326 @end group |
327 | |
328 @group | |
329 (make-backup-file-name "backups.texi") | |
330 @result{} ".backups.texi~" | |
331 @end group | |
332 @end smallexample | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
333 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
334 Some parts of Emacs, including some Dired commands, assume that backup |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
335 file names end with @samp{~}. If you do not follow that convention, it |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
336 will not cause serious problems, but these commands may give |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
337 less-than-desirable results. |
6564 | 338 @end defun |
339 | |
340 @defun find-backup-file-name filename | |
341 This function computes the file name for a new backup file for | |
342 @var{filename}. It may also propose certain existing backup files for | |
343 deletion. @code{find-backup-file-name} returns a list whose @sc{car} is | |
344 the name for the new backup file and whose @sc{cdr} is a list of backup | |
345 files whose deletion is proposed. | |
346 | |
347 Two variables, @code{kept-old-versions} and @code{kept-new-versions}, | |
348 determine which backup versions should be kept. This function keeps | |
349 those versions by excluding them from the @sc{cdr} of the value. | |
350 @xref{Numbered Backups}. | |
351 | |
352 In this example, the value says that @file{~rms/foo.~5~} is the name | |
353 to use for the new backup file, and @file{~rms/foo.~3~} is an ``excess'' | |
354 version that the caller should consider deleting now. | |
355 | |
356 @smallexample | |
357 @group | |
358 (find-backup-file-name "~rms/foo") | |
359 @result{} ("~rms/foo.~5~" "~rms/foo.~3~") | |
360 @end group | |
361 @end smallexample | |
362 @end defun | |
363 | |
364 @c Emacs 19 feature | |
365 @defun file-newest-backup filename | |
366 This function returns the name of the most recent backup file for | |
7336 | 367 @var{filename}, or @code{nil} if that file has no backup files. |
6564 | 368 |
7336 | 369 Some file comparison commands use this function so that they can |
370 automatically compare a file with its most recent backup. | |
6564 | 371 @end defun |
372 | |
6966
cf60a8adeadd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
373 @node Auto-Saving |
6564 | 374 @section Auto-Saving |
375 @cindex auto-saving | |
376 | |
377 Emacs periodically saves all files that you are visiting; this is | |
378 called @dfn{auto-saving}. Auto-saving prevents you from losing more | |
379 than a limited amount of work if the system crashes. By default, | |
380 auto-saves happen every 300 keystrokes, or after around 30 seconds of | |
381 idle time. @xref{Auto-Save, Auto-Save, Auto-Saving: Protection Against | |
382 Disasters, emacs, The GNU Emacs Manual}, for information on auto-save | |
383 for users. Here we describe the functions used to implement auto-saving | |
384 and the variables that control them. | |
385 | |
386 @defvar buffer-auto-save-file-name | |
387 This buffer-local variable is the name of the file used for | |
388 auto-saving the current buffer. It is @code{nil} if the buffer | |
389 should not be auto-saved. | |
390 | |
391 @example | |
392 @group | |
393 buffer-auto-save-file-name | |
394 => "/xcssun/users/rms/lewis/#files.texi#" | |
395 @end group | |
396 @end example | |
397 @end defvar | |
398 | |
399 @deffn Command auto-save-mode arg | |
400 When used interactively without an argument, this command is a toggle | |
401 switch: it turns on auto-saving of the current buffer if it is off, and | |
402 vice-versa. With an argument @var{arg}, the command turns auto-saving | |
403 on if the value of @var{arg} is @code{t}, a nonempty list, or a positive | |
404 integer. Otherwise, it turns auto-saving off. | |
405 @end deffn | |
406 | |
407 @defun auto-save-file-name-p filename | |
408 This function returns a non-@code{nil} value if @var{filename} is a | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
409 string that could be the name of an auto-save file. It assumes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
410 the usual naming convention for auto-save files: a name that |
6564 | 411 begins and ends with hash marks (@samp{#}) is a possible auto-save file |
412 name. The argument @var{filename} should not contain a directory part. | |
413 | |
414 @example | |
415 @group | |
416 (make-auto-save-file-name) | |
417 @result{} "/xcssun/users/rms/lewis/#files.texi#" | |
418 @end group | |
419 @group | |
420 (auto-save-file-name-p "#files.texi#") | |
421 @result{} 0 | |
422 @end group | |
423 @group | |
424 (auto-save-file-name-p "files.texi") | |
425 @result{} nil | |
426 @end group | |
427 @end example | |
428 | |
429 The standard definition of this function is as follows: | |
430 | |
431 @example | |
432 @group | |
433 (defun auto-save-file-name-p (filename) | |
434 "Return non-nil if FILENAME can be yielded by..." | |
435 (string-match "^#.*#$" filename)) | |
436 @end group | |
437 @end example | |
438 | |
439 This function exists so that you can customize it if you wish to | |
440 change the naming convention for auto-save files. If you redefine it, | |
441 be sure to redefine the function @code{make-auto-save-file-name} | |
442 correspondingly. | |
443 @end defun | |
444 | |
445 @defun make-auto-save-file-name | |
446 This function returns the file name to use for auto-saving the current | |
24934 | 447 buffer. This is just the file name with hash marks (@samp{#}) prepended |
448 and appended to it. This function does not look at the variable | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
449 @code{auto-save-visited-file-name} (described below); callers of this |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
450 function should check that variable first. |
6564 | 451 |
452 @example | |
453 @group | |
454 (make-auto-save-file-name) | |
455 @result{} "/xcssun/users/rms/lewis/#backup.texi#" | |
456 @end group | |
457 @end example | |
458 | |
459 The standard definition of this function is as follows: | |
460 | |
461 @example | |
462 @group | |
463 (defun make-auto-save-file-name () | |
464 "Return file name to use for auto-saves \ | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
465 of current buffer@enddots{}" |
6564 | 466 (if buffer-file-name |
467 @end group | |
468 @group | |
469 (concat | |
470 (file-name-directory buffer-file-name) | |
471 "#" | |
472 (file-name-nondirectory buffer-file-name) | |
473 "#") | |
474 (expand-file-name | |
475 (concat "#%" (buffer-name) "#")))) | |
476 @end group | |
477 @end example | |
478 | |
479 This exists as a separate function so that you can redefine it to | |
480 customize the naming convention for auto-save files. Be sure to | |
481 change @code{auto-save-file-name-p} in a corresponding way. | |
482 @end defun | |
483 | |
484 @defvar auto-save-visited-file-name | |
485 If this variable is non-@code{nil}, Emacs auto-saves buffers in | |
486 the files they are visiting. That is, the auto-save is done in the same | |
7336 | 487 file that you are editing. Normally, this variable is @code{nil}, so |
6564 | 488 auto-save files have distinct names that are created by |
489 @code{make-auto-save-file-name}. | |
490 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
491 When you change the value of this variable, the new value does not take |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
492 effect in an existing buffer until the next time auto-save mode is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
493 reenabled in it. If auto-save mode is already enabled, auto-saves |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
494 continue to go in the same file name until @code{auto-save-mode} is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
495 called again. |
6564 | 496 @end defvar |
497 | |
498 @defun recent-auto-save-p | |
499 This function returns @code{t} if the current buffer has been | |
500 auto-saved since the last time it was read in or saved. | |
501 @end defun | |
502 | |
503 @defun set-buffer-auto-saved | |
504 This function marks the current buffer as auto-saved. The buffer will | |
505 not be auto-saved again until the buffer text is changed again. The | |
506 function returns @code{nil}. | |
507 @end defun | |
508 | |
509 @defopt auto-save-interval | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
510 The value of this variable specifies how often to do auto-saving, in |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
511 terms of number of input events. Each time this many additional input |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
512 events are read, Emacs does auto-saving for all buffers in which that is |
6564 | 513 enabled. |
514 @end defopt | |
515 | |
516 @defopt auto-save-timeout | |
517 The value of this variable is the number of seconds of idle time that | |
518 should cause auto-saving. Each time the user pauses for this long, | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
519 Emacs does auto-saving for all buffers in which that is enabled. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
520 (Actually, the specified timeout is multiplied by a factor depending on |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
521 the size of the current buffer.) |
6564 | 522 @end defopt |
523 | |
524 @defvar auto-save-hook | |
525 This normal hook is run whenever an auto-save is about to happen. | |
526 @end defvar | |
527 | |
528 @defopt auto-save-default | |
529 If this variable is non-@code{nil}, buffers that are visiting files | |
530 have auto-saving enabled by default. Otherwise, they do not. | |
531 @end defopt | |
532 | |
12098 | 533 @deffn Command do-auto-save &optional no-message current-only |
6564 | 534 This function auto-saves all buffers that need to be auto-saved. It |
535 saves all buffers for which auto-saving is enabled and that have been | |
536 changed since the previous auto-save. | |
537 | |
538 Normally, if any buffers are auto-saved, a message that says | |
539 @samp{Auto-saving...} is displayed in the echo area while auto-saving is | |
540 going on. However, if @var{no-message} is non-@code{nil}, the message | |
541 is inhibited. | |
12098 | 542 |
543 If @var{current-only} is non-@code{nil}, only the current buffer | |
544 is auto-saved. | |
6564 | 545 @end deffn |
546 | |
547 @defun delete-auto-save-file-if-necessary | |
548 This function deletes the current buffer's auto-save file if | |
549 @code{delete-auto-save-files} is non-@code{nil}. It is called every | |
550 time a buffer is saved. | |
551 @end defun | |
552 | |
553 @defvar delete-auto-save-files | |
554 This variable is used by the function | |
555 @code{delete-auto-save-file-if-necessary}. If it is non-@code{nil}, | |
556 Emacs deletes auto-save files when a true save is done (in the visited | |
557 file). This saves disk space and unclutters your directory. | |
558 @end defvar | |
559 | |
560 @defun rename-auto-save-file | |
561 This function adjusts the current buffer's auto-save file name if the | |
562 visited file name has changed. It also renames an existing auto-save | |
563 file. If the visited file name has not changed, this function does | |
564 nothing. | |
565 @end defun | |
566 | |
6966
cf60a8adeadd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
567 @defvar buffer-saved-size |
7336 | 568 The value of this buffer-local variable is the length of the current |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
569 buffer, when it was last read in, saved, or auto-saved. This is |
7336 | 570 used to detect a substantial decrease in size, and turn off auto-saving |
571 in response. | |
6966
cf60a8adeadd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
572 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
573 If it is @minus{}1, that means auto-saving is temporarily shut off in |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
574 this buffer due to a substantial decrease in size. Explicitly saving |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
575 the buffer stores a positive value in this variable, thus reenabling |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
576 auto-saving. Turning auto-save mode off or on also updates this |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
577 variable, so that the substantial decrease in size is forgotten. |
6966
cf60a8adeadd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
578 @end defvar |
cf60a8adeadd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
579 |
11665
6e1c2ecf280b
Doc auto-save-list-file-name.
Richard M. Stallman <rms@gnu.org>
parents:
7336
diff
changeset
|
580 @defvar auto-save-list-file-name |
6e1c2ecf280b
Doc auto-save-list-file-name.
Richard M. Stallman <rms@gnu.org>
parents:
7336
diff
changeset
|
581 This variable (if non-@code{nil}) specifies a file for recording the |
6e1c2ecf280b
Doc auto-save-list-file-name.
Richard M. Stallman <rms@gnu.org>
parents:
7336
diff
changeset
|
582 names of all the auto-save files. Each time Emacs does auto-saving, it |
12098 | 583 writes two lines into this file for each buffer that has auto-saving |
584 enabled. The first line gives the name of the visited file (it's empty | |
585 if the buffer has none), and the second gives the name of the auto-save | |
586 file. | |
587 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
588 When Emacs exits normally, it deletes this file; if Emacs crashes, you |
12098 | 589 can look in the file to find all the auto-save files that might contain |
590 work that was otherwise lost. The @code{recover-session} command uses | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
591 this file to find them. |
11665
6e1c2ecf280b
Doc auto-save-list-file-name.
Richard M. Stallman <rms@gnu.org>
parents:
7336
diff
changeset
|
592 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
593 The default name for this file specifies your home directory and starts |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
594 with @samp{.saves-}. It also contains the Emacs process @sc{id} and the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
595 host name. |
11665
6e1c2ecf280b
Doc auto-save-list-file-name.
Richard M. Stallman <rms@gnu.org>
parents:
7336
diff
changeset
|
596 @end defvar |
6e1c2ecf280b
Doc auto-save-list-file-name.
Richard M. Stallman <rms@gnu.org>
parents:
7336
diff
changeset
|
597 |
6966
cf60a8adeadd
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6564
diff
changeset
|
598 @node Reverting |
6564 | 599 @section Reverting |
600 | |
601 If you have made extensive changes to a file and then change your mind | |
602 about them, you can get rid of them by reading in the previous version | |
603 of the file with the @code{revert-buffer} command. @xref{Reverting, , | |
604 Reverting a Buffer, emacs, The GNU Emacs Manual}. | |
605 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
606 @deffn Command revert-buffer &optional ignore-auto noconfirm |
6564 | 607 This command replaces the buffer text with the text of the visited |
608 file on disk. This action undoes all changes since the file was visited | |
609 or saved. | |
610 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
611 By default, if the latest auto-save file is more recent than the visited |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
612 file, and the argument @var{ignore-auto} is non-@code{nil}, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
613 @code{revert-buffer} asks the user whether to use that auto-save |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
614 instead. When you invoke this command interactively, @var{ignore-auto} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
615 is @code{t} unless there is a numeric prefix argument; thus, the |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
616 interactive default is to check the auto-save file. |
6564 | 617 |
618 Normally, @code{revert-buffer} asks for confirmation before it changes | |
619 the buffer; but if the argument @var{noconfirm} is non-@code{nil}, | |
620 @code{revert-buffer} does not ask for confirmation. | |
621 | |
622 Reverting tries to preserve marker positions in the buffer by using the | |
7336 | 623 replacement feature of @code{insert-file-contents}. If the buffer |
624 contents and the file contents are identical before the revert | |
625 operation, reverting preserves all the markers. If they are not | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
626 identical, reverting does change the buffer; in that case, it preserves |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
627 the markers in the unchanged text (if any) at the beginning and end of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
628 the buffer. Preserving any additional markers would be problematical. |
6564 | 629 @end deffn |
630 | |
7336 | 631 You can customize how @code{revert-buffer} does its work by setting |
632 these variables---typically, as buffer-local variables. | |
633 | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
634 @defvar revert-without-query |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
635 This variable holds a list of files that should be reverted without |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
636 query. The value is a list of regular expressions. If the visited file |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
637 name matches one of these regular expressions, and the file has changed |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
638 on disk but the buffer is not modified, then @code{revert-buffer} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
639 reverts the file without asking the user for confirmation. |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
640 @end defvar |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
641 |
6564 | 642 @defvar revert-buffer-function |
7336 | 643 The value of this variable is the function to use to revert this buffer. |
644 If non-@code{nil}, it is called as a function with no arguments to do | |
645 the work of reverting. If the value is @code{nil}, reverting works the | |
646 usual way. | |
647 | |
648 Modes such as Dired mode, in which the text being edited does not | |
649 consist of a file's contents but can be regenerated in some other | |
650 fashion, give this variable a buffer-local value that is a function to | |
651 regenerate the contents. | |
6564 | 652 @end defvar |
653 | |
654 @defvar revert-buffer-insert-file-contents-function | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
655 The value of this variable, if non-@code{nil}, specifies the function to use to |
12098 | 656 insert the updated contents when reverting this buffer. The function |
657 receives two arguments: first the file name to use; second, @code{t} if | |
658 the user has asked to read the auto-save file. | |
6564 | 659 @end defvar |
660 | |
661 @defvar before-revert-hook | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
662 This normal hook is run by @code{revert-buffer} before |
6564 | 663 inserting the modified contents---but only if |
664 @code{revert-buffer-function} is @code{nil}. | |
665 @end defvar | |
666 | |
667 @defvar after-revert-hook | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24934
diff
changeset
|
668 This normal hook is run by @code{revert-buffer} after inserting |
6564 | 669 the modified contents---but only if @code{revert-buffer-function} is |
670 @code{nil}. | |
671 @end defvar |