changeset 75049:80cfd51d8db9

(Defining Minor Modes): Explain effect of command defined with define-global-minor-mode on new buffers.
author Richard M. Stallman <rms@gnu.org>
date Tue, 02 Jan 2007 20:57:30 +0000
parents b9e4d35eefb4
children 27f521750ce8
files lispref/modes.texi
diffstat 1 files changed, 6 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/lispref/modes.texi	Tue Jan 02 20:56:26 2007 +0000
+++ b/lispref/modes.texi	Tue Jan 02 20:57:30 2007 +0000
@@ -1480,12 +1480,15 @@
 @end smallexample
 
 @defmac define-global-minor-mode global-mode mode turn-on keyword-args@dots{}
-This defines a global minor mode named @var{global-mode} whose meaning
-is to enable the buffer-local minor mode @var{mode} in every buffer.
-To turn on the minor mode in a buffer, it uses the function
+This defines a global toggle named @var{global-mode} whose meaning is
+to enable or disable the buffer-local minor mode @var{mode} in all
+buffers.  To turn on the minor mode in a buffer, it uses the function
 @var{turn-on}; to turn off the minor mode, it calls @code{mode} with
 @minus{}1 as argument.
 
+Globally enabling the mode also affects buffers subsequently created
+by visiting files, but not buffers subsequently created in other ways.
+
 Use @code{:group @var{group}} in @var{keyword-args} to specify the
 custom group for the mode variable of the global minor mode.
 @end defmac