diff options
| author | Chong Yidong <cyd@gnu.org> | 2011-10-19 08:54:24 -0400 |
|---|---|---|
| committer | Chong Yidong <cyd@gnu.org> | 2011-10-19 08:54:24 -0400 |
| commit | 06e21633a4a9de1e8013376cf92d912817df28cd (patch) | |
| tree | 82b50a4f717e0836ae06ea529a4c873282c74ebc /lisp | |
| parent | 12b32963196147a21ac0945396d24ab67e4a221a (diff) | |
Fix minor mode docstrings for the new meaning of a nil ARG.
* abbrev.el (abbrev-mode):
* allout.el (allout-mode):
* autoinsert.el (auto-insert-mode):
* autoarg.el (autoarg-mode, autoarg-kp-mode):
* autorevert.el (auto-revert-mode, auto-revert-tail-mode)
(global-auto-revert-mode):
* battery.el (display-battery-mode):
* composite.el (global-auto-composition-mode)
(auto-composition-mode):
* delsel.el (delete-selection-mode):
* desktop.el (desktop-save-mode):
* dired-x.el (dired-omit-mode):
* dirtrack.el (dirtrack-mode):
* doc-view.el (doc-view-minor-mode):
* double.el (double-mode):
* electric.el (electric-indent-mode, electric-pair-mode):
* emacs-lock.el (emacs-lock-mode):
* epa-hook.el (auto-encryption-mode):
* follow.el (follow-mode):
* font-core.el (font-lock-mode):
* frame.el (auto-raise-mode, auto-lower-mode, blink-cursor-mode):
* help.el (temp-buffer-resize-mode):
* hilit-chg.el (highlight-changes-mode)
(highlight-changes-visible-mode):
* hi-lock.el (hi-lock-mode):
* hl-line.el (hl-line-mode, global-hl-line-mode):
* icomplete.el (icomplete-mode):
* ido.el (ido-everywhere):
* image-file.el (auto-image-file-mode):
* image-mode.el (image-minor-mode):
* iswitchb.el (iswitchb-mode):
* jka-cmpr-hook.el (auto-compression-mode):
* linum.el (linum-mode):
* longlines.el (longlines-mode):
* master.el (master-mode):
* mb-depth.el (minibuffer-depth-indicate-mode):
* menu-bar.el (menu-bar-mode):
* minibuf-eldef.el (minibuffer-electric-default-mode):
* mouse-sel.el (mouse-sel-mode):
* msb.el (msb-mode):
* mwheel.el (mouse-wheel-mode):
* outline.el (outline-minor-mode):
* paren.el (show-paren-mode):
* recentf.el (recentf-mode):
* reveal.el (reveal-mode, global-reveal-mode):
* rfn-eshadow.el (file-name-shadow-mode):
* ruler-mode.el (ruler-mode):
* savehist.el (savehist-mode):
* scroll-all.el (scroll-all-mode):
* scroll-bar.el (scroll-bar-mode):
* server.el (server-mode):
* shell.el (shell-dirtrack-mode):
* simple.el (auto-fill-mode, transient-mark-mode)
(visual-line-mode, overwrite-mode, binary-overwrite-mode)
(line-number-mode, column-number-mode, size-indication-mode)
(auto-save-mode, normal-erase-is-backspace-mode, visible-mode):
* strokes.el (strokes-mode):
* time.el (display-time-mode):
* t-mouse.el (gpm-mouse-mode):
* tool-bar.el (tool-bar-mode):
* tooltip.el (tooltip-mode):
* type-break.el (type-break-mode-line-message-mode)
(type-break-query-mode):
* view.el (view-mode):
* whitespace.el (whitespace-mode, whitespace-newline-mode)
(global-whitespace-mode, global-whitespace-newline-mode):
* xt-mouse.el (xterm-mouse-mode): Doc fix.
* emacs-lisp/easy-mmode.el (define-globalized-minor-mode): Fix
autogenerated docstring.
Diffstat (limited to 'lisp')
67 files changed, 669 insertions, 408 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog index dffbe36308..eec34f9d79 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,79 @@ +2011-10-19 Chong Yidong <cyd@gnu.org> + + Doc fix for minor modes, stating that an omitted argument enables + the mode unconditionally when called from Lisp. + + * abbrev.el (abbrev-mode): + * allout.el (allout-mode): + * autoinsert.el (auto-insert-mode): + * autoarg.el (autoarg-mode, autoarg-kp-mode): + * autorevert.el (auto-revert-mode, auto-revert-tail-mode) + (global-auto-revert-mode): + * battery.el (display-battery-mode): + * composite.el (global-auto-composition-mode) + (auto-composition-mode): + * delsel.el (delete-selection-mode): + * desktop.el (desktop-save-mode): + * dired-x.el (dired-omit-mode): + * dirtrack.el (dirtrack-mode): + * doc-view.el (doc-view-minor-mode): + * double.el (double-mode): + * electric.el (electric-indent-mode, electric-pair-mode): + * emacs-lock.el (emacs-lock-mode): + * epa-hook.el (auto-encryption-mode): + * follow.el (follow-mode): + * font-core.el (font-lock-mode): + * frame.el (auto-raise-mode, auto-lower-mode, blink-cursor-mode): + * help.el (temp-buffer-resize-mode): + * hilit-chg.el (highlight-changes-mode) + (highlight-changes-visible-mode): + * hi-lock.el (hi-lock-mode): + * hl-line.el (hl-line-mode, global-hl-line-mode): + * icomplete.el (icomplete-mode): + * ido.el (ido-everywhere): + * image-file.el (auto-image-file-mode): + * image-mode.el (image-minor-mode): + * iswitchb.el (iswitchb-mode): + * jka-cmpr-hook.el (auto-compression-mode): + * linum.el (linum-mode): + * longlines.el (longlines-mode): + * master.el (master-mode): + * mb-depth.el (minibuffer-depth-indicate-mode): + * menu-bar.el (menu-bar-mode): + * minibuf-eldef.el (minibuffer-electric-default-mode): + * mouse-sel.el (mouse-sel-mode): + * msb.el (msb-mode): + * mwheel.el (mouse-wheel-mode): + * outline.el (outline-minor-mode): + * paren.el (show-paren-mode): + * recentf.el (recentf-mode): + * reveal.el (reveal-mode, global-reveal-mode): + * rfn-eshadow.el (file-name-shadow-mode): + * ruler-mode.el (ruler-mode): + * savehist.el (savehist-mode): + * scroll-all.el (scroll-all-mode): + * scroll-bar.el (scroll-bar-mode): + * server.el (server-mode): + * shell.el (shell-dirtrack-mode): + * simple.el (auto-fill-mode, transient-mark-mode) + (visual-line-mode, overwrite-mode, binary-overwrite-mode) + (line-number-mode, column-number-mode, size-indication-mode) + (auto-save-mode, normal-erase-is-backspace-mode, visible-mode): + * strokes.el (strokes-mode): + * time.el (display-time-mode): + * t-mouse.el (gpm-mouse-mode): + * tool-bar.el (tool-bar-mode): + * tooltip.el (tooltip-mode): + * type-break.el (type-break-mode-line-message-mode) + (type-break-query-mode): + * view.el (view-mode): + * whitespace.el (whitespace-mode, whitespace-newline-mode) + (global-whitespace-mode, global-whitespace-newline-mode): + * xt-mouse.el (xterm-mouse-mode): Doc fix. + + * emacs-lisp/easy-mmode.el (define-globalized-minor-mode): Fix + autogenerated docstring. + 2011-10-19 Juri Linkov <juri@jurta.org> * net/browse-url.el (browse-url-can-use-xdg-open): Support LXDE diff --git a/lisp/abbrev.el b/lisp/abbrev.el index 5a7a741a3a..395810772c 100644 --- a/lisp/abbrev.el +++ b/lisp/abbrev.el @@ -54,9 +54,12 @@ define global abbrevs instead." (define-minor-mode abbrev-mode "Toggle Abbrev mode in the current buffer. -With optional argument ARG, turn abbrev mode on if ARG is -positive, otherwise turn it off. In Abbrev mode, inserting an -abbreviation causes it to expand and be replaced by its expansion." +With a prefix argument ARG, enable Abbrev mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +Abbrev mode if ARG is omitted or nil. + +In Abbrev mode, inserting an abbreviation causes it to expand and +be replaced by its expansion." ;; It's defined in C, this stops the d-m-m macro defining it again. :variable abbrev-mode) diff --git a/lisp/allout-widgets.el b/lisp/allout-widgets.el index ef75e7157e..162da1f481 100644 --- a/lisp/allout-widgets.el +++ b/lisp/allout-widgets.el @@ -486,13 +486,14 @@ happens in the buffer.") ;;;_ > define-minor-mode allout-widgets-mode (arg) ;;;###autoload (define-minor-mode allout-widgets-mode - "Allout-mode extension, providing graphical decoration of outline structure. - -This is meant to operate along with allout-mode, via `allout-mode-hook'. - -If optional argument ARG is greater than 0, enable. -If optional argument ARG is less than 0, disable. -Anything else, toggle between active and inactive. + "Toggle Allout Widgets mode. +With a prefix argument ARG, enable Allout Widgets mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +Allout Widgets mode is an extension of Allout mode that provides +graphical decoration of outline structure. It is meant to +operate along with `allout-mode', via `allout-mode-hook'. The graphics include: diff --git a/lisp/allout.el b/lisp/allout.el index 4002f12e26..18cc3c80dc 100644 --- a/lisp/allout.el +++ b/lisp/allout.el @@ -1702,17 +1702,19 @@ valid values." ;;;###autoload (define-minor-mode allout-mode ;;;_ . Doc string: - "Toggle minor mode for controlling exposure and editing of text outlines. -\\<allout-mode-map-value> - -Allout outline mode always runs as a minor mode. + "Toggle Allout outline mode. +With a prefix argument ARG, enable Allout outline mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. -Allout outline mode provides extensive outline oriented -formatting and manipulation. It enables structural editing of -outlines, as well as navigation and exposure. It also is -specifically aimed at accommodating syntax-sensitive text like -programming languages. \(For example, see the allout code itself, -which is organized as an allout outline.) +\\<allout-mode-map-value> +Allout outline mode is a minor mode that provides extensive +outline oriented formatting and manipulation. It enables +structural editing of outlines, as well as navigation and +exposure. It also is specifically aimed at accommodating +syntax-sensitive text like programming languages. \(For example, +see the allout code itself, which is organized as an allout +outline.) In addition to typical outline navigation and exposure, allout includes: diff --git a/lisp/autoarg.el b/lisp/autoarg.el index 378ec1318b..57f5bcd809 100644 --- a/lisp/autoarg.el +++ b/lisp/autoarg.el @@ -90,15 +90,19 @@ ;;;###autoload (define-minor-mode autoarg-mode - "Toggle Autoarg minor mode globally. -With ARG, turn Autoarg mode on if ARG is positive, off otherwise. + "Toggle Autoarg mode, a global minor mode. +With a prefix argument ARG, enable Autoarg mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + \\<autoarg-mode-map> -In Autoarg mode digits are bound to `digit-argument' -- i.e. they -supply prefix arguments as C-DIGIT and M-DIGIT normally do -- and -C-DIGIT inserts DIGIT. \\[autoarg-terminate] terminates the prefix sequence -and inserts the digits of the autoarg sequence into the buffer. -Without a numeric prefix arg the normal binding of \\[autoarg-terminate] is -invoked, i.e. what it would be with Autoarg mode off. +In Autoarg mode, digits are bound to `digit-argument', i.e. they +supply prefix arguments as C-DIGIT and M-DIGIT normally do. +Furthermore, C-DIGIT inserts DIGIT. +\\[autoarg-terminate] terminates the prefix sequence and inserts +the digits of the autoarg sequence into the buffer. +Without a numeric prefix arg, the normal binding of \\[autoarg-terminate] +is invoked, i.e. what it would be with Autoarg mode off. For example: `6 9 \\[autoarg-terminate]' inserts `69' into the buffer, as does `C-6 C-9'. @@ -112,11 +116,14 @@ then invokes the normal binding of \\[autoarg-terminate]. ;;;###autoload (define-minor-mode autoarg-kp-mode - "Toggle Autoarg-KP minor mode globally. -With ARG, turn Autoarg mode on if ARG is positive, off otherwise. + "Toggle Autoarg-KP mode, a global minor mode. +With a prefix argument ARG, enable Autoarg-KP mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + \\<autoarg-kp-mode-map> -This is similar to \\[autoarg-mode] but rebinds the keypad keys `kp-1' -etc. to supply digit arguments. +This is similar to `autoarg-mode' but rebinds the keypad keys +`kp-1' etc. to supply digit arguments. \\{autoarg-kp-mode-map}" nil " Aakp" autoarg-kp-mode-map :global t :group 'keyboard diff --git a/lisp/autoinsert.el b/lisp/autoinsert.el index 5793c3180b..6d002f4a21 100644 --- a/lisp/autoinsert.el +++ b/lisp/autoinsert.el @@ -397,9 +397,10 @@ or if CONDITION had no actions, after all other CONDITIONs." ;;;###autoload (define-minor-mode auto-insert-mode - "Toggle Auto-insert mode. -With prefix ARG, turn Auto-insert mode on if and only if ARG is positive. -Returns the new status of Auto-insert mode (non-nil means on). + "Toggle Auto-insert mode, a global minor mode. +With a prefix argument ARG, enable Auto-insert mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. When Auto-insert mode is enabled, when new files are created you can insert a template for the file depending on the mode of the buffer." diff --git a/lisp/autorevert.el b/lisp/autorevert.el index c67b6663bd..817aaff55c 100644 --- a/lisp/autorevert.el +++ b/lisp/autorevert.el @@ -284,10 +284,15 @@ the list of old buffers.") ;;;###autoload (define-minor-mode auto-revert-mode - "Toggle reverting buffer when file on disk changes. + "Toggle reverting buffer when the file changes (Auto Revert mode). +With a prefix argument ARG, enable Auto Revert mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +Auto Revert mode is a minor mode that affects only the current +buffer. When enabled, it reverts the buffer when the file on +disk changes. -With arg, turn Auto Revert mode on if and only if arg is positive. -This is a minor mode that affects only the current buffer. Use `global-auto-revert-mode' to automatically revert all buffers. Use `auto-revert-tail-mode' if you know that the file will only grow without being changed in the part that is already in the buffer." @@ -314,14 +319,16 @@ This function is designed to be added to hooks, for example: ;;;###autoload (define-minor-mode auto-revert-tail-mode - "Toggle reverting tail of buffer when file on disk grows. -With arg, turn Tail mode on if arg is positive, otherwise turn it off. + "Toggle reverting tail of buffer when the file grows. +With a prefix argument ARG, enable Auto-Revert Tail mode if ARG +is positive, and disable it otherwise. If called from Lisp, +enable the mode if ARG is omitted or nil. -When Tail mode is enabled, the tail of the file is constantly -followed, as with the shell command `tail -f'. This means that -whenever the file grows on disk (presumably because some -background process is appending to it from time to time), this is -reflected in the current buffer. +When Auto Revert Tail mode is enabled, the tail of the file is +constantly followed, as with the shell command `tail -f'. This +means that whenever the file grows on disk (presumably because +some background process is appending to it from time to time), +this is reflected in the current buffer. You can edit the buffer and turn this mode off and on again as you please. But make sure the background process has stopped @@ -367,7 +374,7 @@ Perform a full revert? ") ;;;###autoload (defun turn-on-auto-revert-tail-mode () - "Turn on Auto-Revert Tail Mode. + "Turn on Auto-Revert Tail mode. This function is designed to be added to hooks, for example: (add-hook 'my-logfile-mode-hook 'turn-on-auto-revert-tail-mode)" @@ -377,12 +384,13 @@ This function is designed to be added to hooks, for example: ;;;###autoload (define-minor-mode global-auto-revert-mode "Toggle Global Auto Revert mode. -With optional prefix argument ARG, enable Global Auto Revert Mode -if ARG > 0, else disable it. +With a prefix argument ARG, enable Global Auto Revert mode if ARG +is positive, and disable it otherwise. If called from Lisp, +enable the mode if ARG is omitted or nil. -This is a global minor mode that reverts any buffer associated -with a file when the file changes on disk. Use `auto-revert-mode' -to revert a particular buffer. +Global Auto Revert mode is a global minor mode that reverts any +buffer associated with a file when the file changes on disk. Use +`auto-revert-mode' to revert a particular buffer. If `global-auto-revert-non-file-buffers' is non-nil, this mode may also revert some non-file buffers, as described in the diff --git a/lisp/battery.el b/lisp/battery.el index f5c01fbef5..3b245ed644 100644 --- a/lisp/battery.el +++ b/lisp/battery.el @@ -164,10 +164,14 @@ The text being displayed in the echo area is controlled by the variables ;;;###autoload (define-minor-mode display-battery-mode - "Display battery status information in the mode line. -The text being displayed in the mode line is controlled by the variables + "Toggle battery status display in mode line (Display Battery mode). +With a prefix argument ARG, enable Display Battery mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +The text displayed in the mode line is controlled by `battery-mode-line-format' and `battery-status-function'. -The mode line will be updated automatically every `battery-update-interval' +The mode line is be updated every `battery-update-interval' seconds." :global t :group 'battery (setq battery-mode-line-string "") diff --git a/lisp/composite.el b/lisp/composite.el index 11a3d5ba38..487962ee07 100644 --- a/lisp/composite.el +++ b/lisp/composite.el @@ -728,12 +728,13 @@ This function is the default value of `auto-composition-function' (which see)." ;;;###autoload (define-minor-mode auto-composition-mode "Toggle Auto Composition mode. -With ARG, turn Auto Composition mode off if and only if ARG is a non-positive -number; if ARG is nil, toggle Auto Composition mode; anything else turns Auto -Composition on. +With a prefix argument ARG, enable Auto Composition mode if ARG +is positive, and disable it otherwise. If called from Lisp, +enable the mode if ARG is omitted or nil. -When Auto Composition is enabled, text characters are automatically composed -by functions registered in `composition-function-table' (which see). +When Auto Composition mode is enabled, text characters are +automatically composed by functions registered in +`composition-function-table'. You can use `global-auto-composition-mode' to turn on Auto Composition mode in all buffers (this is the default)." @@ -744,10 +745,13 @@ Auto Composition mode in all buffers (this is the default)." ;;;###autoload (define-minor-mode global-auto-composition-mode - "Toggle Auto-Composition mode in every possible buffer. -With prefix arg, turn Global-Auto-Composition mode on if and only if arg -is positive. -See `auto-composition-mode' for more information on Auto-Composition mode." + "Toggle Auto Composition mode in all buffers. +With a prefix argument ARG, enable it if ARG is positive, and +disable it otherwise. If called from Lisp, enable it if ARG is +omitted or nil. + +For more information on Auto Composition mode, see +`auto-composition-mode' ." :variable (default-value 'auto-composition-mode)) (defalias 'toggle-auto-composition 'auto-composition-mode) diff --git a/lisp/delsel.el b/lisp/delsel.el index 705b64be89..6d2c47f395 100644 --- a/lisp/delsel.el +++ b/lisp/delsel.el @@ -56,8 +56,9 @@ ;;;###autoload (define-minor-mode delete-selection-mode "Toggle Delete Selection mode. -With prefix ARG, turn Delete Selection mode on if ARG is -positive, off if ARG is not positive. +With a prefix argument ARG, enable Delete Selection mode if ARG +is positive, and disable it otherwise. If called from Lisp, +enable the mode if ARG is omitted or nil. When Delete Selection mode is enabled, Transient Mark mode is also enabled and typed text replaces the selection if the selection is diff --git a/lisp/desktop.el b/lisp/desktop.el index c60745a6b1..cdc787dfde 100644 --- a/lisp/desktop.el +++ b/lisp/desktop.el @@ -147,11 +147,14 @@ backward compatibility.") ;;;###autoload (define-minor-mode desktop-save-mode - "Toggle desktop saving mode. -With numeric ARG, turn desktop saving on if ARG is positive, off -otherwise. If desktop saving is turned on, the state of Emacs is -saved from one session to another. See variable `desktop-save' -and function `desktop-read' for details." + "Toggle desktop saving (Desktop Save mode). +With a prefix argument ARG, enable Desktop Save mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +If Desktop Save mode is enabled, the state of Emacs is saved from +one session to another. See variable `desktop-save' and function +`desktop-read' for details." :global t :group 'desktop) diff --git a/lisp/dired-x.el b/lisp/dired-x.el index 0f2cfd4973..aaddc479b2 100644 --- a/lisp/dired-x.el +++ b/lisp/dired-x.el @@ -133,16 +133,20 @@ If nil, there is no maximum size." :group 'dired-x) (define-minor-mode dired-omit-mode - "Toggle Dired-Omit mode. -With numeric ARG, enable Dired-Omit mode if ARG is positive, disable -otherwise. Enabling and disabling is buffer-local. -If enabled, \"uninteresting\" files are not listed. -Uninteresting files are those whose filenames match regexp `dired-omit-files', -plus those ending with extensions in `dired-omit-extensions'. + "Toggle omission of uninteresting files in Dired (Dired-Omit mode). +With a prefix argument ARG, enable Dired-Omit mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. -To enable omitting in every Dired buffer, you can put in your ~/.emacs +Dired-Omit mode is a buffer-local minor mode. When enabled in a +Dired buffer, Dired does not list files whose filenames match +regexp `dired-omit-files', nor files ending with extensions in +`dired-omit-extensions'. - (add-hook 'dired-mode-hook (lambda () (dired-omit-mode 1))) +To enable omitting in every Dired buffer, you can put this in +your init file: + + (add-hook 'dired-mode-hook (lambda () (dired-omit-mode))) See Info node `(dired-x) Omitting Variables' for more information." :group 'dired-x diff --git a/lisp/dired.el b/lisp/dired.el index 60ba14ade8..3ff86869a7 100644 --- a/lisp/dired.el +++ b/lisp/dired.el @@ -4128,7 +4128,7 @@ instead. ;;;*** ;;;### (autoloads (dired-do-relsymlink dired-jump-other-window dired-jump) -;;;;;; "dired-x" "dired-x.el" "219648338c42c7912fa336680b434db0") +;;;;;; "dired-x" "dired-x.el" "0a19e4cb2cadf007be715af1035c9c36") ;;; Generated autoloads from dired-x.el (autoload 'dired-jump "dired-x" "\ diff --git a/lisp/dirtrack.el b/lisp/dirtrack.el index 23a05816a2..eef8c111da 100644 --- a/lisp/dirtrack.el +++ b/lisp/dirtrack.el @@ -183,7 +183,11 @@ and ends with a forward slash." ;;;###autoload (define-minor-mode dirtrack-mode - "Enable or disable Dirtrack directory tracking in a shell buffer. + "Toggle directory tracking in shell buffers (Dirtrack mode). +With a prefix argument ARG, enable Dirtrack mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + This method requires that your shell prompt contain the full current working directory at all times, and that `dirtrack-list' is set to match the prompt. This is an alternative to @@ -199,7 +203,7 @@ and similar commands which change the shell working directory." (define-minor-mode dirtrack-debug-mode - "Enable or disable Dirtrack debugging." + "Toggle Dirtrack debugging." nil nil nil (if dirtrack-debug-mode (display-buffer (get-buffer-create dirtrack-debug-buffer)))) diff --git a/lisp/doc-view.el b/lisp/doc-view.el index 872b2172c7..ceaad83cd7 100644 --- a/lisp/doc-view.el +++ b/lisp/doc-view.el @@ -1502,8 +1502,11 @@ to the next best mode." ;;;###autoload (define-minor-mode doc-view-minor-mode - "Toggle Doc view minor mode. -With arg, turn Doc view minor mode on if arg is positive, off otherwise. + "Toggle displaying buffer via Doc View (Doc View minor mode). +With a prefix argument ARG, enable Doc View minor mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + See the command `doc-view-mode' for more information on this mode." nil " DocView" doc-view-minor-mode-map :group 'doc-view diff --git a/lisp/double.el b/lisp/double.el index 4aa8da72af..2a845f6194 100644 --- a/lisp/double.el +++ b/lisp/double.el @@ -146,12 +146,13 @@ but not `C-u X' or `ESC X' since the X is not the prefix key." ;;;###autoload (define-minor-mode double-mode - "Toggle Double mode. -With prefix argument ARG, turn Double mode on if ARG is positive, otherwise -turn it off. + "Toggle special insertion on double keypresses (Double mode). +With a prefix argument ARG, enable Double mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. -When Double mode is on, some keys will insert different strings -when pressed twice. See variable `double-map' for details." +When Double mode is enabled, some keys will insert different +strings when pressed twice. See `double-map' for details." :lighter " Double" :link '(emacs-commentary-link "double") (kill-local-variable 'key-translation-map) diff --git a/lisp/electric.el b/lisp/electric.el index 17c33c7d5c..26fba20ea1 100644 --- a/lisp/electric.el +++ b/lisp/electric.el @@ -241,8 +241,14 @@ Returns nil when we can't find this char." ;;;###autoload (define-minor-mode electric-indent-mode - "Automatically reindent lines of code when inserting particular chars. -`electric-indent-chars' specifies the set of chars that should cause reindentation." + "Toggle on-the-fly reindentation (Electric Indent mode). +With a prefix argument ARG, enable Electric Indent mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +Electric Indent mode is a global minor mode. When enabled, +reindentation is triggered whenever you insert a character listed +in `electric-indent-chars'." :global t :group 'electricity (if electric-indent-mode @@ -330,7 +336,14 @@ This can be convenient for people who find it easier to hit ) than C-f." ;;;###autoload (define-minor-mode electric-pair-mode - "Automatically pair-up parens when inserting an open paren." + "Toggle automatic parens pairing (Electric Pair mode). +With a prefix argument ARG, enable Electric Pair mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +Electric Pair mode is a global minor mode. When enabled, typing +an open parenthesis automatically inserts the corresponding +closing parenthesis. \(Likewise for brackets, etc.)" :global t :group 'electricity (if electric-pair-mode diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el index 46dc1f162b..b1cb0615e4 100644 --- a/lisp/emacs-lisp/easy-mmode.el +++ b/lisp/emacs-lisp/easy-mmode.el @@ -350,14 +350,16 @@ call another major mode in their body." (define-minor-mode ,global-mode ;; Very short lines to avoid too long lines in the generated ;; doc string. - ,(format "Toggle %s in every possible buffer. -With prefix ARG, turn %s on if and only if -ARG is positive. + ,(format "Toggle %s in all buffers. +With prefix ARG, enable %s if ARG is positive; +otherwise, disable it. If called from Lisp, enable the mode if +ARG is omitted or nil. + %s is enabled in all buffers where \`%s' would do it. See `%s' for more information on %s." - pretty-name pretty-global-name pretty-name turn-on - mode pretty-name) + pretty-name pretty-global-name + pretty-name turn-on mode pretty-name) :global t ,@group ,@(nreverse extra-keywords) ;; Setup hook to handle future mode changes and new buffers. diff --git a/lisp/emacs-lock.el b/lisp/emacs-lock.el index 18411f7d2e..f2c9347301 100644 --- a/lisp/emacs-lock.el +++ b/lisp/emacs-lock.el @@ -176,14 +176,16 @@ Return a value appropriate for `kill-buffer-query-functions' (which see)." ;;;###autoload (define-minor-mode emacs-lock-mode - "Toggle Emacs Lock mode in the current buffer. - -With \\[universal-argument], ask for the locking mode to be used. -With other prefix ARG, turn mode on if ARG is positive, off otherwise. - -Initially, if the user does not pass an explicit locking mode, it defaults -to `emacs-lock-default-locking-mode' (which see); afterwards, the locking -mode most recently set on the buffer is used instead. + "Toggle Emacs Lock mode in the current buffer. +If called with a plain prefix argument, ask for the locking mode +to be used. With any other prefix ARG, turn mode on if ARG is +positive, off otherwise. If called from Lisp, enable the mode if +ARG is omitted or nil. + +Initially, if the user does not pass an explicit locking mode, it +defaults to `emacs-lock-default-locking-mode' (which see); +afterwards, the locking mode most recently set on the buffer is +used instead. When called from Elisp code, ARG can be any locking mode: diff --git a/lisp/epa-hook.el b/lisp/epa-hook.el index 652ab19ba6..ea036e836e 100644 --- a/lisp/epa-hook.el +++ b/lisp/epa-hook.el @@ -49,7 +49,7 @@ does that automatically." :group 'epa-file) (defvar epa-file-encrypt-to nil - "*Recipient(s) used for encrypting files. + "Recipient(s) used for encrypting files. May either be a string or a list of strings.") (put 'epa-file-encrypt-to 'safe-local-variable @@ -83,9 +83,10 @@ May either be a string or a list of strings.") (auto-save-mode 0))) (define-minor-mode auto-encryption-mode - "Toggle automatic file encryption and decryption. -With prefix argument ARG, turn auto encryption on if positive, else off. -Return the new status of auto encryption (non-nil means on)." + "Toggle automatic file encryption/decryption (Auto Encryption mode). +With a prefix argument ARG, enable Auto Encryption mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil." :global t :init-value t :group 'epa-file :version "23.1" ;; We'd like to use custom-initialize-set here so the setup is done ;; before dumping, but at the point where the defcustom is evaluated, diff --git a/lisp/face-remap.el b/lisp/face-remap.el index 9e5ab58636..bfd973a299 100644 --- a/lisp/face-remap.el +++ b/lisp/face-remap.el @@ -204,7 +204,7 @@ Each positive or negative step scales the default face height by this amount." (make-variable-buffer-local 'text-scale-mode-amount) (define-minor-mode text-scale-mode - "Minor mode for displaying buffer text in a larger/smaller font than usual. + "Minor mode for displaying buffer text in a larger/smaller font. The amount of scaling is determined by the variable `text-scale-mode-amount': one step scales the global default diff --git a/lisp/follow.el b/lisp/follow.el index 94a542f101..37295cc533 100644 --- a/lisp/follow.el +++ b/lisp/follow.el @@ -484,10 +484,13 @@ Used by `follow-window-size-change'.") (put 'follow-mode 'permanent-local t) ;;;###autoload (define-minor-mode follow-mode - "Minor mode that combines windows into one tall virtual window. + "Toggle Follow mode. +With a prefix argument ARG, enable Follow mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. -The feeling of a \"virtual window\" has been accomplished by the use -of two major techniques: +Follow mode is a minor mode that combines windows into one tall +virtual window. This is accomplished by two main techniques: * The windows always displays adjacent sections of the buffer. This means that whenever one window is moved, all the diff --git a/lisp/font-core.el b/lisp/font-core.el index fcaaf33b71..0db17efd7b 100644 --- a/lisp/font-core.el +++ b/lisp/font-core.el @@ -86,12 +86,12 @@ It will be passed one argument, which is the current value of ;; The mode for which font-lock was initialized, or nil if none. (defvar font-lock-major-mode) + (define-minor-mode font-lock-mode - "Toggle Font Lock mode. -With arg, turn Font Lock mode off if and only if arg is a non-positive -number; if arg is nil, toggle Font Lock mode; anything else turns Font -Lock on. -\(Font Lock is also known as \"syntax highlighting\".) + "Toggle syntax highlighting in this buffer (Font Lock mode). +With a prefix argument ARG, enable Font Lock mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. When Font Lock mode is enabled, text is fontified as you type it: diff --git a/lisp/frame.el b/lisp/frame.el index ab9b085f1d..8359fed14a 100644 --- a/lisp/frame.el +++ b/lisp/frame.el @@ -1134,7 +1134,10 @@ To get the frame's current border color, use `frame-parameters'." (define-minor-mode auto-raise-mode "Toggle whether or not the selected frame should auto-raise. -With ARG, turn auto-raise mode on if and only if ARG is positive. +With a prefix argument ARG, enable Auto Raise mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + Note that this controls Emacs's own auto-raise feature. Some window managers allow you to enable auto-raise for certain windows. You can use that for Emacs windows if you wish, but if you do, @@ -1145,7 +1148,10 @@ that is beyond the control of Emacs and this command has no effect on it." (define-minor-mode auto-lower-mode "Toggle whether or not the selected frame should auto-lower. -With ARG, turn auto-lower mode on if and only if ARG is positive. +With a prefix argument ARG, enable Auto Lower mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + Note that this controls Emacs's own auto-lower feature. Some window managers allow you to enable auto-lower for certain windows. You can use that for Emacs windows if you wish, but if you do, @@ -1556,14 +1562,13 @@ itself as a pre-command hook." (setq blink-cursor-timer nil))) (define-minor-mode blink-cursor-mode - "Toggle blinking cursor mode. -With a numeric argument, turn blinking cursor mode on if ARG is positive, -otherwise turn it off. When blinking cursor mode is enabled, the -cursor of the selected window blinks. - -Note that this command is effective only when Emacs -displays through a window system, because then Emacs does its own -cursor display. On a text-only terminal, this is not implemented." + "Toggle cursor blinking (Blink Cursor mode). +With a prefix argument ARG, enable Blink Cursor mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +This command is effective only on graphical frames. On text-only +terminals, cursor blinking is controlled by the terminal." :init-value (not (or noninteractive no-blinking-cursor (eq system-type 'ms-dos) diff --git a/lisp/help.el b/lisp/help.el index e2af0759a6..508a4e3262 100644 --- a/lisp/help.el +++ b/lisp/help.el @@ -977,13 +977,15 @@ function is called, the window to be resized is selected." :version "20.4") (define-minor-mode temp-buffer-resize-mode - "Toggle mode which makes windows smaller for temporary buffers. -With prefix argument ARG, turn the resizing of windows displaying -temporary buffers on if ARG is positive or off otherwise. - -This mode makes a window the right height for its contents, but -never more than `temp-buffer-max-height' nor less than -`window-min-height'. + "Toggle auto-shrinking temp buffer windows (Temp Buffer Resize mode). +With a prefix argument ARG, enable Temp Buffer Resize mode if ARG +is positive, and disable it otherwise. If called from Lisp, +enable the mode if ARG is omitted or nil. + +When Temp Buffer Resize mode is enabled, the windows in which we +show a temporary buffer are automatically reduced in height to +fit the buffer's contents, but never more than +`temp-buffer-max-height' nor less than `window-min-height'. This mode is used by `help', `apropos' and `completion' buffers, and some others." diff --git a/lisp/hi-lock.el b/lisp/hi-lock.el index a254abe33a..f659a7e8ee 100644 --- a/lisp/hi-lock.el +++ b/lisp/hi-lock.el @@ -283,14 +283,17 @@ a library is being loaded.") ;;;###autoload (define-minor-mode hi-lock-mode - "Toggle minor mode for interactively adding font-lock highlighting patterns. - -If ARG positive, turn hi-lock on. Issuing a hi-lock command will also -turn hi-lock on. To turn hi-lock on in all buffers use -`global-hi-lock-mode' or in your .emacs file (global-hi-lock-mode 1). -When hi-lock is turned on, a \"Regexp Highlighting\" submenu is added -to the \"Edit\" menu. The commands in the submenu, which can be -called interactively, are: + "Toggle selective highlighting of patterns (Hi Lock mode). +With a prefix argument ARG, enable Hi Lock mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +Issuing one the highlighting commands listed below will +automatically enable Hi Lock mode. To enable Hi Lock mode in all +buffers, use `global-hi-lock-mode' or add (global-hi-lock-mode 1) +to your init file. When Hi Lock mode is enabled, a \"Regexp +Highlighting\" submenu is added to the \"Edit\" menu. The +commands in the submenu, which can be called interactively, are: \\[highlight-regexp] REGEXP FACE Highlight matches of pattern REGEXP in current buffer with FACE. diff --git a/lisp/hilit-chg.el b/lisp/hilit-chg.el index 041c1ee938..46db428068 100644 --- a/lisp/hilit-chg.el +++ b/lisp/hilit-chg.el @@ -326,14 +326,15 @@ remove it from existing buffers." ;;;###autoload (define-minor-mode highlight-changes-mode - "Toggle Highlight Changes mode. + "Toggle highlighting changes in this buffer (Highlight Changes mode). +With a prefix argument ARG, enable Highlight Changes mode if ARG +is positive, and disable it otherwise. If called from Lisp, +enable the mode if ARG is omitted or nil. -With ARG, turn Highlight Changes mode on if and only if arg is positive. - -In Highlight Changes mode changes are recorded with a text property. -Normally they are displayed in a distinctive face, but command -\\[highlight-changes-visible-mode] can be used to toggles this -on and off. +When Highlight Changes is enabled, changes are marked with a text +property. Normally they are displayed in a distinctive face, but +command \\[highlight-changes-visible-mode] can be used to toggles +this on and off. Other functions for buffers in this mode include: \\[highlight-changes-next-change] - move point to beginning of next change @@ -366,14 +367,17 @@ buffer with the contents of a file ;;;###autoload (define-minor-mode highlight-changes-visible-mode - "Toggle visiblility of changes when buffer is in Highlight Changes mode. + "Toggle visiblility of highlighting due to Highlight Changes mode. +With a prefix argument ARG, enable Highlight Changes Visible mode +if ARG is positive, and disable it otherwise. If called from +Lisp, enable the mode if ARG is omitted or nil. -This mode only has an effect when Highlight Changes mode is on. -It allows toggling between whether or not the changed text is displayed +Highlight Changes Visible mode only has an effect when Highlight +Changes mode is on. When enabled, the changed text is displayed in a distinctive face. The default value can be customized with variable -`highlight-changes-visibility-initial-state' +`highlight-changes-visibility-initial-state'. This command does not itself set highlight-changes mode." diff --git a/lisp/hl-line.el b/lisp/hl-line.el index 846f5f9518..b535398f10 100644 --- a/lisp/hl-line.el +++ b/lisp/hl-line.el @@ -124,10 +124,13 @@ This variable is expected to be made buffer-local by modes.") ;;;###autoload (define-minor-mode hl-line-mode - "Buffer-local minor mode to highlight the line about point. -With ARG, turn Hl-Line mode on if ARG is positive, off otherwise. + "Toggle highlighting of the current line (Hl-Line mode). +With a prefix argument ARG, enable Hl-Line mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. -If `hl-line-sticky-flag' is non-nil, Hl-Line mode highlights the +Hl-Line mode is a buffer-local minor mode. If +`hl-line-sticky-flag' is non-nil, Hl-Line mode highlights the line about the buffer's point in all windows. Caveat: the buffer's point might be different from the point of a non-selected window. Hl-Line mode uses the function @@ -171,8 +174,10 @@ addition to `hl-line-highlight' on `post-command-hook'." ;;;###autoload (define-minor-mode global-hl-line-mode - "Global minor mode to highlight the line about point in the current window. -With ARG, turn Global-Hl-Line mode on if ARG is positive, off otherwise. + "Toggle line highlighting in all buffers (Global Hl-Line mode). +With a prefix argument ARG, enable Global Hl-Line mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. If `global-hl-line-sticky-flag' is non-nil, Global Hl-Line mode highlights the line about the current buffer's point in all diff --git a/lisp/ibuf-ext.el b/lisp/ibuf-ext.el index 073efaeee2..6c8db872c0 100644 --- a/lisp/ibuf-ext.el +++ b/lisp/ibuf-ext.el @@ -217,8 +217,10 @@ Currently, this only applies to `ibuffer-saved-filters' and ;;;###autoload (define-minor-mode ibuffer-auto-mode - "Toggle use of Ibuffer's auto-update facility. -With numeric ARG, enable auto-update if and only if ARG is positive." + "Toggle use of Ibuffer's auto-update facility (Ibuffer Auto mode). +With a prefix argument ARG, enable Ibuffer Auto mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil." nil nil nil (unless (derived-mode-p 'ibuffer-mode) (error "This buffer is not in Ibuffer mode")) diff --git a/lisp/ibuffer.el b/lisp/ibuffer.el index 5a86508e14..17ddddbd17 100644 --- a/lisp/ibuffer.el +++ b/lisp/ibuffer.el @@ -2648,12 +2648,14 @@ will be inserted before the group at point." ;;;;;; ibuffer-backward-filter-group ibuffer-forward-filter-group ;;;;;; ibuffer-toggle-filter-group ibuffer-mouse-toggle-filter-group ;;;;;; ibuffer-interactive-filter-by-mode ibuffer-mouse-filter-by-mode -;;;;;; ibuffer-auto-mode) "ibuf-ext" "ibuf-ext.el" "617b36fc8479547d679cf0103f82e3ff") +;;;;;; ibuffer-auto-mode) "ibuf-ext" "ibuf-ext.el" "25e69a1e030791b3a3e7d91d4377173a") ;;; Generated autoloads from ibuf-ext.el (autoload 'ibuffer-auto-mode "ibuf-ext" "\ -Toggle use of Ibuffer's auto-update facility. -With numeric ARG, enable auto-update if and only if ARG is positive. +Toggle use of Ibuffer's auto-update facility (Ibuffer Auto mode). +With a prefix argument ARG, enable Ibuffer Auto mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. \(fn &optional ARG)" t nil) diff --git a/lisp/icomplete.el b/lisp/icomplete.el index bdd19194c2..53876f48a0 100644 --- a/lisp/icomplete.el +++ b/lisp/icomplete.el @@ -172,9 +172,10 @@ except those on this list.") ;;;_ > icomplete-mode (&optional prefix) ;;;###autoload (define-minor-mode icomplete-mode - "Toggle incremental minibuffer completion for this Emacs session. -With a numeric argument, turn Icomplete mode on if ARG is positive, -otherwise turn it off." + "Toggle incremental minibuffer completion (Icomplete mode). +With a prefix argument ARG, enable Icomplete mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil." :global t :group 'icomplete (if icomplete-mode ;; The following is not really necessary after first time - diff --git a/lisp/ido.el b/lisp/ido.el index 0844c2c50c..88599013ce 100644 --- a/lisp/ido.el +++ b/lisp/ido.el @@ -1469,8 +1469,10 @@ Removes badly formatted data and ignored directories." (add-hook 'choose-completion-string-functions 'ido-choose-completion-string)) (define-minor-mode ido-everywhere - "Toggle using ido-mode everywhere file and directory names are read. -With ARG, turn ido-mode on if arg is positive, off otherwise." + "Toggle use of Ido for all buffer/file reading. +With a prefix argument ARG, enable this feature if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil." :global t :group 'ido (when (get 'ido-everywhere 'file) diff --git a/lisp/image-file.el b/lisp/image-file.el index bd1c101d52..52012b12a5 100644 --- a/lisp/image-file.el +++ b/lisp/image-file.el @@ -178,11 +178,12 @@ Optional argument ARGS are the arguments to call FUNCTION with." ;;;###autoload (define-minor-mode auto-image-file-mode - "Toggle visiting of image files as images. -With prefix argument ARG, turn on if positive, otherwise off. -Returns non-nil if the new state is enabled. + "Toggle visiting of image files as images (Auto Image File mode). +With a prefix argument ARG, enable Auto Image File mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. -Image files are those whose name has an extension in +An image file is one whose name has an extension in `image-file-name-extensions', or matches a regexp in `image-file-name-regexps'." :global t diff --git a/lisp/image-mode.el b/lisp/image-mode.el index 0995048fce..30223e69ae 100644 --- a/lisp/image-mode.el +++ b/lisp/image-mode.el @@ -396,11 +396,14 @@ to toggle between display as an image and display as text." ;;;###autoload (define-minor-mode image-minor-mode - "Toggle Image minor mode. -With arg, turn Image minor mode on if arg is positive, off otherwise. -It provides the key \\<image-mode-map>\\[image-toggle-display] \ -to switch back to `image-mode' -to display an image file as the actual image." + "Toggle Image minor mode in this buffer. +With a prefix argument ARG, enable Image minor mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +Image minor mode provides the key \\<image-mode-map>\\[image-toggle-display], +to switch back to `image-mode' and display an image file as the +actual image." nil (:eval (if image-type (format " Image[%s]" image-type) " Image")) image-minor-mode-map :group 'image diff --git a/lisp/iswitchb.el b/lisp/iswitchb.el index 70dda5442d..a7d3328526 100644 --- a/lisp/iswitchb.el +++ b/lisp/iswitchb.el @@ -1424,10 +1424,13 @@ See the variable `iswitchb-case' for details." ;;;###autoload (define-minor-mode iswitchb-mode - "Toggle Iswitchb global minor mode. -With arg, turn Iswitchb mode on if ARG is positive, otherwise turn it off. -This mode enables switching between buffers using substrings. See -`iswitchb' for details." + "Toggle Iswitchb mode. +With a prefix argument ARG, enable Iswitchb mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +Iswitchb mode is a global minor mode that enables switching +between buffers using substrings. See `iswitchb' for details." nil nil iswitchb-global-map :global t :group 'iswitchb (if iswitchb-mode (add-hook 'minibuffer-setup-hook 'iswitchb-minibuffer-setup) diff --git a/lisp/jka-cmpr-hook.el b/lisp/jka-cmpr-hook.el index d28fde0b21..bf312445f1 100644 --- a/lisp/jka-cmpr-hook.el +++ b/lisp/jka-cmpr-hook.el @@ -333,9 +333,14 @@ variables. Setting this through Custom does that automatically." :group 'jka-compr) (define-minor-mode auto-compression-mode - "Toggle automatic file compression and uncompression. -With prefix argument ARG, turn auto compression on if positive, else off. -Return the new status of auto compression (non-nil means on)." + "Toggle Auto Compression mode. +With a prefix argument ARG, enable Auto Compression mode if ARG +is positive, and disable it otherwise. If called from Lisp, +enable the mode if ARG is omitted or nil. + +Auto Compression mode is a global minor mode. When enabled, +compressed files are automatically uncompressed for reading, and +compressed when writing." :global t :init-value t :group 'jka-compr :version "22.1" (let* ((installed (jka-compr-installed-p)) (flag auto-compression-mode)) diff --git a/lisp/linum.el b/lisp/linum.el index db6e4c4997..4e58a1b711 100644 --- a/lisp/linum.el +++ b/lisp/linum.el @@ -73,7 +73,12 @@ and you have to scroll or press \\[recenter-top-bottom] to update the numbers." ;;;###autoload (define-minor-mode linum-mode - "Toggle display of line numbers in the left margin." + "Toggle display of line numbers in the left margin (Linum mode). +With a prefix argument ARG, enable Linum mode if ARG is positive, +and disable it otherwise. If called from Lisp, enable the mode +if ARG is omitted or nil. + +Linum mode is a buffer-local minor mode." :lighter "" ; for desktop.el (if linum-mode (progn diff --git a/lisp/longlines.el b/lisp/longlines.el index f625d8fcac..b4d15da78a 100644 --- a/lisp/longlines.el +++ b/lisp/longlines.el @@ -95,21 +95,22 @@ This is used when `longlines-show-hard-newlines' is on." ;;;###autoload (define-minor-mode longlines-mode - "Minor mode to wrap long lines. -In Long Lines mode, long lines are wrapped if they extend beyond -`fill-column'. The soft newlines used for line wrapping will not -show up when the text is yanked or saved to disk. - -With no argument, this command toggles Long Lines mode. -With a prefix argument ARG, turn Long Lines minor mode on if ARG is positive, -otherwise turn it off. - -If the variable `longlines-auto-wrap' is non-nil, lines are automatically -wrapped whenever the buffer is changed. You can always call -`fill-paragraph' to fill individual paragraphs. - -If the variable `longlines-show-hard-newlines' is non-nil, hard newlines -are indicated with a symbol." + "Toggle Long Lines mode in this buffer. +With a prefix argument ARG, enable Long Lines mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +When Long Lines mode is enabled, long lines are wrapped if they +extend beyond `fill-column'. The soft newlines used for line +wrapping will not show up when the text is yanked or saved to +disk. + +If the variable `longlines-auto-wrap' is non-nil, lines are +automatically wrapped whenever the buffer is changed. You can +always call `fill-paragraph' to fill individual paragraphs. + +If the variable `longlines-show-hard-newlines' is non-nil, hard +newlines are indicated with a symbol." :group 'longlines :lighter " ll" (if longlines-mode ;; Turn on longlines mode diff --git a/lisp/master.el b/lisp/master.el index 1ea0a24ca9..c3e9004ca0 100644 --- a/lisp/master.el +++ b/lisp/master.el @@ -72,12 +72,12 @@ You can set this variable using `master-set-slave'.") ;;;###autoload (define-minor-mode master-mode "Toggle Master mode. -With no argument, this command toggles the mode. -Non-null prefix argument turns on the mode. -Null prefix argument turns off the mode. +With a prefix argument ARG, enable Master mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. -When Master mode is enabled, you can scroll the slave buffer using the -following commands: +When Master mode is enabled, you can scroll the slave buffer +using the following commands: \\{master-mode-map} diff --git a/lisp/mb-depth.el b/lisp/mb-depth.el index 2ed692c1b8..22fd84a67a 100644 --- a/lisp/mb-depth.el +++ b/lisp/mb-depth.el @@ -56,12 +56,14 @@ The prompt should already have been inserted." ;;;###autoload (define-minor-mode minibuffer-depth-indicate-mode "Toggle Minibuffer Depth Indication mode. -When active, any recursive use of the minibuffer will show -the recursion depth in the minibuffer prompt. This is only -useful if `enable-recursive-minibuffers' is non-nil. +With a prefix argument ARG, enable Minibuffer Depth Indication +mode if ARG is positive, and disable it otherwise. If called +from Lisp, enable the mode if ARG is omitted or nil. -With prefix argument ARG, turn on if positive, otherwise off. -Returns non-nil if the new state is enabled." +Minibuffer Depth Indication mode is a global minor mode. When +enabled, any recursive use of the minibuffer will show the +recursion depth in the minibuffer prompt. This is only useful if +`enable-recursive-minibuffers' is non-nil." :global t :group 'minibuffer (if minibuffer-depth-indicate-mode diff --git a/lisp/menu-bar.el b/lisp/menu-bar.el index d75a768e2d..75a2d70da5 100644 --- a/lisp/menu-bar.el +++ b/lisp/menu-bar.el @@ -2169,11 +2169,13 @@ It must accept a buffer as its only required argument.") :help ,(purecopy "Put previous minibuffer history element in the minibuffer")))) (define-minor-mode menu-bar-mode - "Toggle display of a menu bar on each frame. + "Toggle display of a menu bar on each frame (Menu Bar mode). +With a prefix argument ARG, enable Menu Bar mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +Menu Bar mode if ARG is omitted or nil. + This command applies to all frames that exist and frames to be -created in the future. -With a numeric argument, if the argument is positive, -turn on menu bars; otherwise, turn off menu bars." +created in the future." :init-value t :global t ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again. diff --git a/lisp/minibuf-eldef.el b/lisp/minibuf-eldef.el index e6ebe3c53f..405721f97e 100644 --- a/lisp/minibuf-eldef.el +++ b/lisp/minibuf-eldef.el @@ -131,14 +131,16 @@ been set up by `minibuf-eldef-setup-minibuffer'." ;;;###autoload (define-minor-mode minibuffer-electric-default-mode "Toggle Minibuffer Electric Default mode. -When active, minibuffer prompts that show a default value only show the -default when it's applicable -- that is, when hitting RET would yield -the default value. If the user modifies the input such that hitting RET -would enter a non-default value, the prompt is modified to remove the -default indication. - -With prefix argument ARG, turn on if positive, otherwise off. -Returns non-nil if the new state is enabled." +With a prefix argument ARG, enable Minibuffer Electric Default +mode if ARG is positive, and disable it otherwise. If called +from Lisp, enable the mode if ARG is omitted or nil. + +Minibuffer Electric Default mode is a global minor mode. When +enabled, minibuffer prompts that show a default value only show +the default when it's applicable -- that is, when hitting RET +would yield the default value. If the user modifies the input +such that hitting RET would enter a non-default value, the prompt +is modified to remove the default indication." :global t :group 'minibuffer (if minibuffer-electric-default-mode diff --git a/lisp/mouse-sel.el b/lisp/mouse-sel.el index 50d221b6fa..bcf1749e13 100644 --- a/lisp/mouse-sel.el +++ b/lisp/mouse-sel.el @@ -199,11 +199,12 @@ If nil, point will always be placed at the beginning of the region." ;;;###autoload (define-minor-mode mouse-sel-mode "Toggle Mouse Sel mode. -With prefix ARG, turn Mouse Sel mode on if and only if ARG is positive. -Returns the new status of Mouse Sel mode (non-nil means on). +With a prefix argument ARG, enable Mouse Sel mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. -When Mouse Sel mode is enabled, mouse selection is enhanced in -various ways: +Mouse Sel mode is a global minor mode. When enabled, mouse +selection is enhanced in various ways: - Double-clicking on symbol constituents selects symbols. Double-clicking on quotes or parentheses selects sexps. diff --git a/lisp/msb.el b/lisp/msb.el index 12e5a0192f..74ceff1a9c 100644 --- a/lisp/msb.el +++ b/lisp/msb.el @@ -1133,7 +1133,10 @@ variable `msb-menu-cond'." ;;;###autoload (define-minor-mode msb-mode "Toggle Msb mode. -With arg, turn Msb mode on if and only if arg is positive. +With a prefix argument ARG, enable Msb mode if ARG is positive, +and disable it otherwise. If called from Lisp, enable the mode +if ARG is omitted or nil. + This mode overrides the binding(s) of `mouse-buffer-menu' to provide a different buffer menu using the function `msb'." :global t :group 'msb diff --git a/lisp/mwheel.el b/lisp/mwheel.el index 4ead168b18..05aeb12acf 100644 --- a/lisp/mwheel.el +++ b/lisp/mwheel.el @@ -250,11 +250,11 @@ This should only be bound to mouse buttons 4 and 5." (defvar mwheel-installed-bindings nil) -;; preloaded ;;;###autoload (define-minor-mode mouse-wheel-mode - "Toggle mouse wheel support. -With prefix argument ARG, turn on if positive, otherwise off. -Return non-nil if the new state is enabled." + "Toggle mouse wheel support (Mouse Wheel mode). +With a prefix argument ARG, enable Mouse Wheel mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil." :init-value t ;; We'd like to use custom-initialize-set here so the setup is done ;; before dumping, but at the point where the defcustom is evaluated, diff --git a/lisp/outline.el b/lisp/outline.el index f864058c6f..34d30fc459 100644 --- a/lisp/outline.el +++ b/lisp/outline.el @@ -356,7 +356,10 @@ After that, changing the prefix key requires manipulating keymaps." ;;;###autoload (define-minor-mode outline-minor-mode "Toggle Outline minor mode. -With arg, turn Outline minor mode on if arg is positive, off otherwise. +With a prefix argument ARG, enable Outline minor mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + See the command `outline-mode' for more information on this mode." nil " Outl" (list (cons [menu-bar] outline-minor-mode-menu-bar-map) (cons outline-minor-mode-prefix outline-mode-prefix-map)) diff --git a/lisp/paren.el b/lisp/paren.el index fb5c0bf36e..ee550228d4 100644 --- a/lisp/paren.el +++ b/lisp/paren.el @@ -102,12 +102,14 @@ otherwise)." ;;;###autoload (define-minor-mode show-paren-mode - "Toggle Show Paren mode. -With prefix ARG, turn Show Paren mode on if and only if ARG is positive. -Returns the new status of Show Paren mode (non-nil means on). + "Toggle visualization of matching parens (Show Paren mode). +With a prefix argument ARG, enable Show Paren mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. -When Show Paren mode is enabled, any matching parenthesis is highlighted -in `show-paren-style' after `show-paren-delay' seconds of Emacs idle time." +Show Paren mode is a global minor mode. When enabled, any +matching parenthesis is highlighted in `show-paren-style' after +`show-paren-delay' seconds of Emacs idle time." :global t :group 'paren-showing ;; Enable or disable the mechanism. ;; First get rid of the old idle timer. diff --git a/lisp/recentf.el b/lisp/recentf.el index fc9b788173..79f4eb437d 100644 --- a/lisp/recentf.el +++ b/lisp/recentf.el @@ -1336,12 +1336,14 @@ That is, remove duplicates, non-kept, and excluded files." ;;;###autoload (define-minor-mode recentf-mode - "Toggle recentf mode. -With prefix argument ARG, turn on if positive, otherwise off. -Returns non-nil if the new state is enabled. - -When recentf mode is enabled, it maintains a menu for visiting files -that were operated on recently." + "Toggle \"Open Recent\" menu (Recentf mode). +With a prefix argument ARG, enable Recentf mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +Recentf mode if ARG is omitted or nil. + +When Recentf mode is enabled, a \"Open Recent\" submenu is +displayed in the \"File\" menu, containing a list of files that +were operated on recently." :global t :group 'recentf :keymap recentf-mode-map diff --git a/lisp/reveal.el b/lisp/reveal.el index bf18602379..ea46cfd1dd 100644 --- a/lisp/reveal.el +++ b/lisp/reveal.el @@ -189,12 +189,13 @@ Each element has the form (WINDOW . OVERLAY).") ;;;###autoload (define-minor-mode reveal-mode - "Toggle Reveal mode on or off. -Reveal mode renders invisible text around point visible again. + "Toggle decloaking of invisible text near point (Reveal mode). +With a prefix argument ARG, enable Reveal mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +Reveal mode if ARG is omitted or nil. -Interactively, with no prefix argument, toggle the mode. -With universal prefix ARG (or if ARG is nil) turn mode on. -With zero or negative ARG turn mode off." +Reveral mode is a buffer-local minor mode. When enabled, it +reveals invisible text around point." :group 'reveal :lighter (global-reveal-mode nil " Reveal") :keymap reveal-mode-map @@ -207,12 +208,12 @@ With zero or negative ARG turn mode off." ;;;###autoload (define-minor-mode global-reveal-mode - "Toggle Reveal mode in all buffers on or off. + "Toggle Reveal mode in all buffers (Global Reveal mode). Reveal mode renders invisible text around point visible again. -Interactively, with no prefix argument, toggle the mode. -With universal prefix ARG (or if ARG is nil) turn mode on. -With zero or negative ARG turn mode off." +With a prefix argument ARG, enable Global Reveal mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil." :global t :group 'reveal (setq-default reveal-mode global-reveal-mode) (if global-reveal-mode diff --git a/lisp/rfn-eshadow.el b/lisp/rfn-eshadow.el index 9eb2d2abde..2d8c6e0964 100644 --- a/lisp/rfn-eshadow.el +++ b/lisp/rfn-eshadow.el @@ -207,15 +207,17 @@ been set up by `rfn-eshadow-setup-minibuffer'." (error nil))) (define-minor-mode file-name-shadow-mode - "Toggle File-Name Shadow mode. -When active, any part of a filename being read in the minibuffer -that would be ignored (because the result is passed through + "Toggle file-name shadowing in minibuffers (File-Name Shadow mode). +With a prefix argument ARG, enable File-Name Shadow mode if ARG +is positive, and disable it otherwise. If called from Lisp, +enable the mode if ARG is omitted or nil. + +File-Name Shadow mode is a global minor mode. When enabled, any +part of a filename being read in the minibuffer that would be +ignored (because the result is passed through `substitute-in-file-name') is given the properties in -`file-name-shadow-properties', which can be used to make -that portion dim, invisible, or otherwise less visually noticeable. - -With prefix argument ARG, turn on if positive, otherwise off. -Returns non-nil if the new state is enabled." +`file-name-shadow-properties', which can be used to make that +portion dim, invisible, or otherwise less visually noticeable." :global t ;; We'd like to use custom-initialize-set here so the setup is done ;; before dumping, but at the point where the defcustom is evaluated, diff --git a/lisp/ruler-mode.el b/lisp/ruler-mode.el index fc62bf6b63..046c29471a 100644 --- a/lisp/ruler-mode.el +++ b/lisp/ruler-mode.el @@ -567,8 +567,10 @@ format first." ;;;###autoload (define-minor-mode ruler-mode - "Toggle Ruler mode. -In Ruler mode, Emacs displays a ruler in the header line." + "Toggle display of ruler in header line (Ruler mode). +With a prefix argument ARG, enable Ruler mode if ARG is positive, +and disable it otherwise. If called from Lisp, enable the mode +if ARG is omitted or nil." nil nil ruler-mode-map :group 'ruler-mode diff --git a/lisp/savehist.el b/lisp/savehist.el index 653d0312a1..faeab324e5 100644 --- a/lisp/savehist.el +++ b/lisp/savehist.el @@ -170,15 +170,19 @@ minibuffer history.") ;;;###autoload (define-minor-mode savehist-mode - "Toggle savehist-mode. -Positive ARG turns on `savehist-mode'. When on, savehist-mode causes -minibuffer history to be saved periodically and when exiting Emacs. -When turned on for the first time in an Emacs session, it causes the -previous minibuffer history to be loaded from `savehist-file'. + "Toggle saving of minibuffer history (Savehist mode). +With a prefix argument ARG, enable Savehist mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +When Savehist mode is enabled, minibuffer history is saved +periodically and when exiting Emacs. When Savehist mode is +enabled for the first time in an Emacs session, it loads the +previous minibuffer history from `savehist-file'. This mode should normally be turned on from your Emacs init file. -Calling it at any other time replaces your current minibuffer histories, -which is probably undesirable." +Calling it at any other time replaces your current minibuffer +histories, which is probably undesirable." :global t (if (not savehist-mode) (savehist-uninstall) diff --git a/lisp/scroll-all.el b/lisp/scroll-all.el index 6dbdc9ab90..81a4d2c86e 100644 --- a/lisp/scroll-all.el +++ b/lisp/scroll-all.el @@ -101,10 +101,13 @@ ;;;###autoload (define-minor-mode scroll-all-mode - "Toggle Scroll-All minor mode. -With ARG, turn Scroll-All minor mode on if ARG is positive, off otherwise. -When Scroll-All mode is on, scrolling commands entered in one window -apply to all visible windows in the same frame." + "Toggle shared scrolling in same-frame windows (Scroll-All mode). +With a prefix argument ARG, enable Scroll-All mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +When Scroll-All mode is enabled, scrolling commands invoked in +one window apply to all visible windows in the same frame." nil " *SL*" nil :global t :group 'windows diff --git a/lisp/scroll-bar.el b/lisp/scroll-bar.el index 0c68bca4d2..37a31460cd 100644 --- a/lisp/scroll-bar.el +++ b/lisp/scroll-bar.el @@ -114,12 +114,15 @@ Setting the variable with a customization buffer also takes effect." (defun get-scroll-bar-mode () scroll-bar-mode) (defsetf get-scroll-bar-mode set-scroll-bar-mode) + (define-minor-mode scroll-bar-mode - "Toggle display of vertical scroll bars on all frames. + "Toggle vertical scroll bars on all frames (Scroll Bar mode). +With a prefix argument ARG, enable Scroll Bar mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + This command applies to all frames that exist and frames to be -created in the future. -With a numeric argument, if the argument is positive -turn on scroll bars; otherwise turn off scroll bars." +created in the future." :variable (eq (get-scroll-bar-mode) (or previous-scroll-bar-mode default-frame-scroll-bars))) diff --git a/lisp/server.el b/lisp/server.el index 63d46a365c..bc989c55ed 100644 --- a/lisp/server.el +++ b/lisp/server.el @@ -669,9 +669,13 @@ Return values: ;;;###autoload (define-minor-mode server-mode "Toggle Server mode. -With ARG, turn Server mode on if ARG is positive, off otherwise. +With a prefix argument ARG, enable Server mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +Server mode if ARG is omitted or nil. + Server mode runs a process that accepts commands from the -`emacsclient' program. See `server-start' and Info node `Emacs server'." +`emacsclient' program. See Info node `Emacs server' and +`server-start' for details." :global t :group 'server :version "22.1" diff --git a/lisp/shell.el b/lisp/shell.el index cefe42bb3e..c75594ddbe 100644 --- a/lisp/shell.el +++ b/lisp/shell.el @@ -890,9 +890,13 @@ Environment variables are expanded, see function `substitute-in-file-name'." (defvaralias 'shell-dirtrack-mode 'shell-dirtrackp) (define-minor-mode shell-dirtrack-mode - "Turn directory tracking on and off in a shell buffer. -The `dirtrack' package provides an alternative implementation of this -feature - see the function `dirtrack-mode'." + "Toggle directory tracking in this shell buffer (Shell Dirtrack mode). +With a prefix argument ARG, enable Shell Dirtrack mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +The `dirtrack' package provides an alternative implementation of +this feature; see the function `dirtrack-mode'." nil nil nil (setq list-buffers-directory (if shell-dirtrack-mode default-directory)) (if shell-dirtrack-mode diff --git a/lisp/simple.el b/lisp/simple.el index 6d0e754354..79de6aea3d 100644 --- a/lisp/simple.el +++ b/lisp/simple.el @@ -4086,13 +4086,15 @@ its earlier value." (define-minor-mode transient-mark-mode "Toggle Transient Mark mode. -With ARG, turn Transient Mark mode on if ARG is positive, off otherwise. +With a prefix argument ARG, enable Transient Mark mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +Transient Mark mode if ARG is omitted or nil. -In Transient Mark mode, when the mark is active, the region is highlighted. -Changing the buffer \"deactivates\" the mark. -So do certain other operations that set the mark -but whose main purpose is something else--for example, -incremental search, \\[beginning-of-buffer], and \\[end-of-buffer]. +Transient Mark mode is a global minor mode. When enabled, the +region is highlighted whenever the mark is active. The mark is +\"deactivated\" by changing the buffer, and after certain other +operations that set the mark but whose main purpose is something +else--for example, incremental search, \\[beginning-of-buffer], and \\[end-of-buffer]. You can also deactivate the mark by typing \\[keyboard-quit] or \\[keyboard-escape-quit]. @@ -4906,8 +4908,15 @@ other purposes." (defvar visual-line--saved-state nil) (define-minor-mode visual-line-mode - "Redefine simple editing commands to act on visual lines, not logical lines. -This also turns on `word-wrap' in the buffer." + "Toggle visual line based editing (Visual Line mode). +With a prefix argument ARG, enable Visual Line mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +When Visual Line mode is enabled, `word-wrap' is turned on in +this buffer, and simple editing commands are redefined to act on +visual lines, not logical lines. See Info node `Visual Line +Mode' for details." :keymap visual-line-mode-map :group 'visual-line :lighter " Wrap" @@ -5301,10 +5310,14 @@ Some major modes set this.") (put 'auto-fill-function 'safe-local-variable 'null) (define-minor-mode auto-fill-mode - "Toggle Auto Fill mode. -With ARG, turn Auto Fill mode on if and only if ARG is positive. -In Auto Fill mode, inserting a space at a column beyond `current-fill-column' -automatically breaks the line at a previous space. + "Toggle automatic line breaking (Auto Fill mode). +With a prefix argument ARG, enable Auto Fill mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +When Auto Fill mode is enabled, inserting a space at a column +beyond `current-fill-column' automatically breaks the line at a +previous space. When `auto-fill-mode' is on, the `auto-fill-function' variable is non-`nil'. @@ -5412,36 +5425,44 @@ if long lines are truncated." "The string displayed in the mode line when in binary overwrite mode.") (define-minor-mode overwrite-mode - "Toggle overwrite mode. -With prefix argument ARG, turn overwrite mode on if ARG is positive, -otherwise turn it off. In overwrite mode, printing characters typed -in replace existing text on a one-for-one basis, rather than pushing -it to the right. At the end of a line, such characters extend the line. -Before a tab, such characters insert until the tab is filled in. -\\[quoted-insert] still inserts characters in overwrite mode; this -is supposed to make it easier to insert characters when necessary." + "Toggle Overwrite mode. +With a prefix argument ARG, enable Overwrite mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +When Overwrite mode is enabled, printing characters typed in +replace existing text on a one-for-one basis, rather than pushing +it to the right. At the end of a line, such characters extend +the line. Before a tab, such characters insert until the tab is +filled in. \\[quoted-insert] still inserts characters in +overwrite mode; this is supposed to make it easier to insert +characters when necessary." :variable (eq overwrite-mode 'overwrite-mode-textual)) (define-minor-mode binary-overwrite-mode - "Toggle binary overwrite mode. -With prefix argument ARG, turn binary overwrite mode on if ARG is -positive, otherwise turn it off. In binary overwrite mode, printing -characters typed in replace existing text. Newlines are not treated -specially, so typing at the end of a line joins the line to the next, -with the typed character between them. Typing before a tab character -simply replaces the tab with the character typed. \\[quoted-insert] -replaces the text at the cursor, just as ordinary typing characters do. - -Note that binary overwrite mode is not its own minor mode; it is a -specialization of overwrite mode, entered by setting the + "Toggle Binary Overwrite mode. +With a prefix argument ARG, enable Binary Overwrite mode if ARG +is positive, and disable it otherwise. If called from Lisp, +enable the mode if ARG is omitted or nil. + +When Binary Overwrite mode is enabled, printing characters typed +in replace existing text. Newlines are not treated specially, so +typing at the end of a line joins the line to the next, with the +typed character between them. Typing before a tab character +simply replaces the tab with the character typed. +\\[quoted-insert] replaces the text at the cursor, just as +ordinary typing characters do. + +Note that Binary Overwrite mode is not its own minor mode; it is +a specialization of overwrite mode, entered by setting the `overwrite-mode' variable to `overwrite-mode-binary'." :variable (eq overwrite-mode 'overwrite-mode-binary)) (define-minor-mode line-number-mode - "Toggle Line Number mode. -With ARG, turn Line Number mode on if ARG is positive, otherwise -turn it off. When Line Number mode is enabled, the line number -appears in the mode line. + "Toggle line number display in the mode line (Line Number mode). +With a prefix argument ARG, enable Line Number mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. Line numbers do not appear for very large buffers and buffers with very long lines; see variables `line-number-display-limit' @@ -5449,22 +5470,27 @@ and `line-number-display-limit-width'." :init-value t :global t :group 'mode-line) (define-minor-mode column-number-mode - "Toggle Column Number mode. -With ARG, turn Column Number mode on if ARG is positive, -otherwise turn it off. When Column Number mode is enabled, the -column number appears in the mode line." + "Toggle column number display in the mode line (Column Number mode). +With a prefix argument ARG, enable Column Number mode if ARG is +positive, and disable it otherwise. + +If called from Lisp, enable the mode if ARG is omitted or nil." :global t :group 'mode-line) (define-minor-mode size-indication-mode - "Toggle Size Indication mode. -With ARG, turn Size Indication mode on if ARG is positive, -otherwise turn it off. When Size Indication mode is enabled, the -size of the accessible part of the buffer appears in the mode line." + "Toggle buffer size display in the mode line (Size Indication mode). +With a prefix argument ARG, enable Size Indication mode if ARG is +positive, and disable it otherwise. + +If called from Lisp, enable the mode if ARG is omitted or nil." :global t :group 'mode-line) (define-minor-mode auto-save-mode - "Toggle auto-saving of contents of current buffer. -With prefix argument ARG, turn auto-saving on if positive, else off." + "Toggle auto-saving in the current buffer (Auto Save mode). +With a prefix argument ARG, enable Auto Save mode if ARG is +positive, and disable it otherwise. + +If called from Lisp, enable the mode if ARG is omitted or nil." :variable ((and buffer-auto-save-file-name ;; If auto-save is off because buffer has shrunk, ;; then toggling should turn it on. @@ -6634,8 +6660,9 @@ call `normal-erase-is-backspace-mode' (which see) instead." (define-minor-mode normal-erase-is-backspace-mode "Toggle the Erase and Delete mode of the Backspace and Delete keys. - -With numeric ARG, turn the mode on if and only if ARG is positive. +With a prefix argument ARG, enable this feature if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. On window systems, when this mode is on, Delete is mapped to C-d and Backspace is mapped to DEL; when this mode is off, both @@ -6709,13 +6736,13 @@ See also `normal-erase-is-backspace'." "Saved value of `buffer-invisibility-spec' when Visible mode is on.") (define-minor-mode visible-mode - "Toggle Visible mode. -With argument ARG turn Visible mode on if ARG is positive, otherwise -turn it off. + "Toggle making all invisible text temporarily visible (Visible mode). +With a prefix argument ARG, enable Visible mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. -Enabling Visible mode makes all invisible text temporarily visible. -Disabling Visible mode turns off that effect. Visible mode works by -saving the value of `buffer-invisibility-spec' and setting it to nil." +This mode works by saving the value of `buffer-invisibility-spec' +and setting it to nil." :lighter " Vis" :group 'editing-basics (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec) diff --git a/lisp/strokes.el b/lisp/strokes.el index ca0086b3b9..5ff94bb22c 100644 --- a/lisp/strokes.el +++ b/lisp/strokes.el @@ -1386,8 +1386,12 @@ If STROKES-MAP is not given, `strokes-global-map' will be used instead." ;;;###autoload (define-minor-mode strokes-mode - "Toggle Strokes global minor mode.\\<strokes-mode-map> -With ARG, turn strokes on if and only if ARG is positive. + "Toggle Strokes mode, a global minor mode. +With a prefix argument ARG, enable Strokes mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. + +\\<strokes-mode-map> Strokes are pictographic mouse gestures which invoke commands. Strokes are invoked with \\[strokes-do-stroke]. You can define new strokes with \\[strokes-global-set-stroke]. See also diff --git a/lisp/t-mouse.el b/lisp/t-mouse.el index 059024c4bc..78857b0414 100644 --- a/lisp/t-mouse.el +++ b/lisp/t-mouse.el @@ -33,7 +33,7 @@ ;; mev. Now the interface with gpm is directly through a Unix socket, so this ;; file is reduced to a single minor mode macro call. -;; +;; ;;; Code: @@ -65,9 +65,10 @@ (define-obsolete-function-alias 't-mouse-mode 'gpm-mouse-mode "23.1") ;;;###autoload (define-minor-mode gpm-mouse-mode - "Toggle gpm-mouse mode to use the mouse in GNU/Linux consoles. -With prefix arg, turn gpm-mouse mode on if arg is positive, -otherwise turn it off. + "Toggle mouse support in GNU/Linux consoles (GPM Mouse mode). +With a prefix argument ARG, enable GPM Mouse mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. This allows the use of the mouse when operating on a GNU/Linux console, in the same way as you can use the mouse under X11. diff --git a/lisp/time.el b/lisp/time.el index f8fea0c64a..ac4a011bdf 100644 --- a/lisp/time.el +++ b/lisp/time.el @@ -484,14 +484,15 @@ update which can wait for the next redisplay." ;;;###autoload (define-minor-mode display-time-mode "Toggle display of time, load level, and mail flag in mode lines. -With a numeric arg, enable this display if arg is positive. - -When this display is enabled, it updates automatically every minute -\(you can control the number of seconds between updates by -customizing `display-time-interval'). -If `display-time-day-and-date' is non-nil, the current day and date -are displayed as well. -This runs the normal hook `display-time-hook' after each update." +With a prefix argument ARG, enable Display Time mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +it if ARG is omitted or nil. + +When Display Time mode is enabled, it updates every minute (you +can control the number of seconds between updates by customizing +`display-time-interval'). If `display-time-day-and-date' is +non-nil, the current day and date are displayed as well. This +runs the normal hook `display-time-hook' after each update." :global t :group 'display-time (and display-time-timer (cancel-timer display-time-timer)) (setq display-time-timer nil) diff --git a/lisp/tool-bar.el b/lisp/tool-bar.el index 05208abb72..8759e0f77f 100644 --- a/lisp/tool-bar.el +++ b/lisp/tool-bar.el @@ -43,9 +43,10 @@ ;; Deleting it means invoking this command won't work ;; when you are on a tty. I hope that won't cause too much trouble -- rms. (define-minor-mode tool-bar-mode - "Toggle use of the tool bar. -With a numeric argument, if the argument is positive, turn on the -tool bar; otherwise, turn off the tool bar. + "Toggle the tool bar in all graphical frames (Tool Bar mode). +With a prefix argument ARG, enable Tool Bar mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +Tool Bar mode if ARG is omitted or nil. See `tool-bar-add-item' and `tool-bar-add-item-from-menu' for conveniently adding tool bar items." diff --git a/lisp/tooltip.el b/lisp/tooltip.el index bfe53dc71b..59115122c3 100644 --- a/lisp/tooltip.el +++ b/lisp/tooltip.el @@ -39,11 +39,14 @@ ;;; Switching tooltips on/off (define-minor-mode tooltip-mode - "Toggle Tooltip mode. -With ARG, turn Tooltip mode on if and only if ARG is positive. -When this minor mode is enabled, Emacs displays help text -in a pop-up window for buttons and menu items that you put the mouse on. -\(However, if `tooltip-use-echo-area' is non-nil, this and + "Toggle use of graphical tooltips (Tooltip mode). +With a prefix argument ARG, enable Tooltip mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +it if ARG is omitted or nil. + +When Tooltip mode is enabled, Emacs displays help text in a +pop-up window for buttons and menu items that you put the mouse +on. \(However, if `tooltip-use-echo-area' is non-nil, this and all pop-up help appears in the echo area.) When Tooltip mode is disabled, Emacs displays one line of diff --git a/lisp/type-break.el b/lisp/type-break.el index d276e64f6d..da3129ec57 100644 --- a/lisp/type-break.el +++ b/lisp/type-break.el @@ -431,13 +431,13 @@ problems." type-break-mode) (define-minor-mode type-break-mode-line-message-mode - "Enable or disable warnings in the mode line about typing breaks. + "Toggle warnings about typing breaks in the mode line. +With a prefix argument ARG, enable these warnings if ARG is +positive, and disable them otherwise. If called from Lisp, +enable them if ARG is omitted or nil. -A negative PREFIX argument disables this mode. -No argument or any non-negative argument enables it. - -The user may also enable or disable this mode simply by setting the -variable of the same name. +The user may also enable or disable this mode simply by setting +the variable of the same name. Variables controlling the display of messages in the mode line include: @@ -448,17 +448,13 @@ Variables controlling the display of messages in the mode line include: :global t) (define-minor-mode type-break-query-mode - "Enable or disable warnings in the mode line about typing breaks. - -When enabled, the user is periodically queried about whether to take a -typing break at that moment. The function which does this query is -specified by the variable `type-break-query-function'. - -A negative PREFIX argument disables this mode. -No argument or any non-negative argument enables it. + "Toggle typing break queries. +With a prefix argument ARG, enable these queries if ARG is +positive, and disable them otherwise. If called from Lisp, +enable them if ARG is omitted or nil. -The user may also enable or disable this mode simply by setting the -variable of the same name." +The user may also enable or disable this mode simply by setting +the variable of the same name." :global t) diff --git a/lisp/view.el b/lisp/view.el index 11cbc79449..ef86500733 100644 --- a/lisp/view.el +++ b/lisp/view.el @@ -369,19 +369,24 @@ this argument instead of explicitly setting `view-exit-action'." ;; bindings instead of using the \\[] construction. The reason for this ;; is that most commands have more than one key binding. "Toggle View mode, a minor mode for viewing text but not editing it. -With prefix argument ARG, turn View mode on if ARG is positive, otherwise -turn it off. +With a prefix argument ARG, enable View mode if ARG is positive, +and disable it otherwise. If called from Lisp, enable View mode +if ARG is omitted or nil. + +When View mode is enabled, commands that do not change the buffer +contents are available as usual. Kill commands insert text in +kill buffers but do not delete. Most other commands beep and +tell the user that the buffer is read-only. -Emacs commands that do not change the buffer contents are available as usual. -Kill commands insert text in kill buffers but do not delete. Other commands -\(among them most letters and punctuation) beep and tell that the buffer is -read-only. \\<view-mode-map> -The following additional commands are provided. Most commands take prefix -arguments. Page commands default to \"page size\" lines which is almost a whole -window full, or number of lines set by \\[View-scroll-page-forward-set-page-size] or \\[View-scroll-page-backward-set-page-size]. Half page commands default to -and set \"half page size\" lines which initially is half a window full. Search -commands default to a repeat count of one. + +The following additional commands are provided. Most commands +take prefix arguments. Page commands default to \"page size\" +lines which is almost a whole window, or number of lines set by +\\[View-scroll-page-forward-set-page-size] or \\[View-scroll-page-backward-set-page-size]. +Half page commands default to and set \"half page size\" lines +which initially is half a window full. Search commands default +to a repeat count of one. H, h, ? This message. Digits provide prefix arguments. diff --git a/lisp/whitespace.el b/lisp/whitespace.el index e0bc74343d..8dc1996734 100644 --- a/lisp/whitespace.el +++ b/lisp/whitespace.el @@ -1064,11 +1064,10 @@ Any other value is treated as nil." ;;;###autoload (define-minor-mode whitespace-mode - "Toggle whitespace minor mode visualization (\"ws\" on modeline). - -If ARG is null, toggle whitespace visualization. -If ARG is a number greater than zero, turn on visualization; -otherwise, turn off visualization. + "Toggle whitespace visualization (Whitespace mode). +With a prefix argument ARG, enable Whitespace mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. See also `whitespace-style', `whitespace-newline' and `whitespace-display-mappings'." @@ -1088,11 +1087,10 @@ See also `whitespace-style', `whitespace-newline' and ;;;###autoload (define-minor-mode whitespace-newline-mode - "Toggle NEWLINE minor mode visualization (\"nl\" on modeline). - -If ARG is null, toggle NEWLINE visualization. -If ARG is a number greater than zero, turn on visualization; -otherwise, turn off visualization. + "Toggle newline visualization (Whitespace Newline mode). +With a prefix argument ARG, enable Whitespace Newline mode if ARG +is positive, and disable it otherwise. If called from Lisp, +enable the mode if ARG is omitted or nil. Use `whitespace-newline-mode' only for NEWLINE visualization exclusively. For other visualizations, including NEWLINE @@ -1116,11 +1114,10 @@ See also `whitespace-newline' and `whitespace-display-mappings'." ;;;###autoload (define-minor-mode global-whitespace-mode - "Toggle whitespace global minor mode visualization (\"WS\" on modeline). - -If ARG is null, toggle whitespace visualization. -If ARG is a number greater than zero, turn on visualization; -otherwise, turn off visualization. + "Toggle whitespace visualization globally (Global Whitespace mode). +With a prefix argument ARG, enable Global Whitespace mode if ARG +is positive, and disable it otherwise. If called from Lisp, +enable it if ARG is omitted or nil. See also `whitespace-style', `whitespace-newline' and `whitespace-display-mappings'." @@ -1174,11 +1171,10 @@ See also `whitespace-style', `whitespace-newline' and ;;;###autoload (define-minor-mode global-whitespace-newline-mode - "Toggle NEWLINE global minor mode visualization (\"NL\" on modeline). - -If ARG is null, toggle NEWLINE visualization. -If ARG is a number greater than zero, turn on visualization; -otherwise, turn off visualization. + "Toggle global newline visualization (Global Whitespace Newline mode). +With a prefix argument ARG, enable Global Whitespace Newline mode +if ARG is positive, and disable it otherwise. If called from +Lisp, enable it if ARG is omitted or nil. Use `global-whitespace-newline-mode' only for NEWLINE visualization exclusively. For other visualizations, including diff --git a/lisp/wid-browse.el b/lisp/wid-browse.el index b765e46b9c..7ca13baeb5 100644 --- a/lisp/wid-browse.el +++ b/lisp/wid-browse.el @@ -270,8 +270,7 @@ VALUE is assumed to be a list of widgets." ;;;###autoload (define-minor-mode widget-minor-mode - "Togle minor mode for traversing widgets. -With arg, turn widget mode on if and only if arg is positive." + "Minor mode for traversing widgets." :lighter " Widget") ;;; The End: diff --git a/lisp/xt-mouse.el b/lisp/xt-mouse.el index eca5f813ca..09b2a7b88b 100644 --- a/lisp/xt-mouse.el +++ b/lisp/xt-mouse.el @@ -199,8 +199,9 @@ ;;;###autoload (define-minor-mode xterm-mouse-mode "Toggle XTerm mouse mode. -With prefix arg, turn XTerm mouse mode on if arg is positive, otherwise turn -it off. +With a prefix argument ARG, enable XTerm mouse mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil. Turn it on to use Emacs mouse commands, and off to use xterm mouse commands. This works in terminal emulators compatible with xterm. It only |