annotate lispref/backups.texi @ 52712:b84a5201d855

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