annotate lispref/backups.texi @ 67177:e59c64acce36

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