diff lispref/buffers.texi @ 54893:07ceecd3e471

(Read Only Buffers): Mention optional ARG to `toggle-read-only'.
author Luc Teirlinck <teirllm@auburn.edu>
date Thu, 15 Apr 2004 00:24:55 +0000
parents 8de44f69312c
children c9aa4127a482
line wrap: on
line diff
--- a/lispref/buffers.texi	Wed Apr 14 20:45:43 2004 +0000
+++ b/lispref/buffers.texi	Thu Apr 15 00:24:55 2004 +0000
@@ -737,12 +737,17 @@
 of the list (comparison is done with @code{eq}).
 @end defvar
 
-@deffn Command toggle-read-only
-This command changes whether the current buffer is read-only.  It is
+@deffn Command toggle-read-only &optional arg
+This command toggles whether the current buffer is read-only.  It is
 intended for interactive use; do not use it in programs.  At any given
 point in a program, you should know whether you want the read-only flag
 on or off; so you can set @code{buffer-read-only} explicitly to the
 proper value, @code{t} or @code{nil}.
+
+If @var{arg} is non-@code{nil}, it should be a raw prefix argument.
+@code{toggle-read-only} sets @code{buffer-read-only} to @code{t} if
+the numeric value of that prefix argument is positive and to
+@code{nil} otherwise.  @xref{Prefix Command Arguments}.
 @end deffn
 
 @defun barf-if-buffer-read-only