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