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