annotate doc/lispref/backups.texi @ 94837:55eb2a3c59b4

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