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