annotate lispref/backups.texi @ 8414:8a8d2cdd4218

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