summaryrefslogtreecommitdiff
path: root/doc/lispref/backups.texi
diff options
context:
space:
mode:
authorChong Yidong <cyd@gnu.org>2012-09-23 18:46:50 +0800
committerChong Yidong <cyd@gnu.org>2012-09-23 18:46:50 +0800
commite109c4a6514ce0e930f63df1ead56eda1703afcf (patch)
treef1a258be38f7b304561abff46a4fe4ad8fdc35fa /doc/lispref/backups.texi
parent9a93067632c0fc183ad5fb4ef44edc4ea8373716 (diff)
downloademacs-e109c4a6514ce0e930f63df1ead56eda1703afcf.tar.gz
Doc updates for read-only-mode.
* buffers.texi (Misc Buffer): Replace toggle-read-only with read-only-mode. * files.texi (Visiting): Likewise. * backups.texi (Auto-Saving): Refer to Minor Mode Conventions for calling conventions. * buffers.texi (Read Only Buffers): Document read-only-mode. * keymaps.texi (Alias Menu Items): Replace toggle-read-only with read-only-mode.
Diffstat (limited to 'doc/lispref/backups.texi')
-rw-r--r--doc/lispref/backups.texi14
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/lispref/backups.texi b/doc/lispref/backups.texi
index 04aa28e9f04..935a49116cd 100644
--- a/doc/lispref/backups.texi
+++ b/doc/lispref/backups.texi
@@ -441,12 +441,14 @@ buffer-auto-save-file-name
@end defvar
@deffn Command auto-save-mode arg
-When used interactively without an argument, this command is a toggle
-switch: it turns on auto-saving of the current buffer if it is off,
-and vice versa. When called from Lisp with no argument, it turns
-auto-saving on. With an argument @var{arg}, it turns auto-saving on
-if the value of @var{arg} is @code{t}, a nonempty list, or a positive
-integer; otherwise, it turns auto-saving off.
+This is the mode command for Auto Save mode, a buffer-local minor
+mode. When Auto Save mode is enabled, auto-saving is enabled in the
+buffer. The calling convention is the same as for other minor mode
+commands (@pxref{Minor Mode Conventions}).
+
+Unlike most minor modes, there is no @code{auto-save-mode} variable.
+Auto Save mode is enabled if @code{buffer-auto-save-file-name} is
+non-@code{nil} and @code{buffer-saved-size} (see below) is non-zero.
@end deffn
@defun auto-save-file-name-p filename