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