diff options
| author | Chong Yidong | 2011-10-19 08:54:24 -0400 |
|---|---|---|
| committer | Chong Yidong | 2011-10-19 08:54:24 -0400 |
| commit | 06e21633a4a9de1e8013376cf92d912817df28cd (patch) | |
| tree | 82b50a4f717e0836ae06ea529a4c873282c74ebc | |
| parent | 12b32963196147a21ac0945396d24ab67e4a221a (diff) | |
| download | emacs-06e21633a4a9de1e8013376cf92d912817df28cd.tar.gz emacs-06e21633a4a9de1e8013376cf92d912817df28cd.zip | |
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.
67 files changed, 669 insertions, 408 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog index dffbe363089..eec34f9d79c 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog | |||
| @@ -1,3 +1,79 @@ | |||
| 1 | 2011-10-19 Chong Yidong <cyd@gnu.org> | ||
| 2 | |||
| 3 | Doc fix for minor modes, stating that an omitted argument enables | ||
| 4 | the mode unconditionally when called from Lisp. | ||
| 5 | |||
| 6 | * abbrev.el (abbrev-mode): | ||
| 7 | * allout.el (allout-mode): | ||
| 8 | * autoinsert.el (auto-insert-mode): | ||
| 9 | * autoarg.el (autoarg-mode, autoarg-kp-mode): | ||
| 10 | * autorevert.el (auto-revert-mode, auto-revert-tail-mode) | ||
| 11 | (global-auto-revert-mode): | ||
| 12 | * battery.el (display-battery-mode): | ||
| 13 | * composite.el (global-auto-composition-mode) | ||
| 14 | (auto-composition-mode): | ||
| 15 | * delsel.el (delete-selection-mode): | ||
| 16 | * desktop.el (desktop-save-mode): | ||
| 17 | * dired-x.el (dired-omit-mode): | ||
| 18 | * dirtrack.el (dirtrack-mode): | ||
| 19 | * doc-view.el (doc-view-minor-mode): | ||
| 20 | * double.el (double-mode): | ||
| 21 | * electric.el (electric-indent-mode, electric-pair-mode): | ||
| 22 | * emacs-lock.el (emacs-lock-mode): | ||
| 23 | * epa-hook.el (auto-encryption-mode): | ||
| 24 | * follow.el (follow-mode): | ||
| 25 | * font-core.el (font-lock-mode): | ||
| 26 | * frame.el (auto-raise-mode, auto-lower-mode, blink-cursor-mode): | ||
| 27 | * help.el (temp-buffer-resize-mode): | ||
| 28 | * hilit-chg.el (highlight-changes-mode) | ||
| 29 | (highlight-changes-visible-mode): | ||
| 30 | * hi-lock.el (hi-lock-mode): | ||
| 31 | * hl-line.el (hl-line-mode, global-hl-line-mode): | ||
| 32 | * icomplete.el (icomplete-mode): | ||
| 33 | * ido.el (ido-everywhere): | ||
| 34 | * image-file.el (auto-image-file-mode): | ||
| 35 | * image-mode.el (image-minor-mode): | ||
| 36 | * iswitchb.el (iswitchb-mode): | ||
| 37 | * jka-cmpr-hook.el (auto-compression-mode): | ||
| 38 | * linum.el (linum-mode): | ||
| 39 | * longlines.el (longlines-mode): | ||
| 40 | * master.el (master-mode): | ||
| 41 | * mb-depth.el (minibuffer-depth-indicate-mode): | ||
| 42 | * menu-bar.el (menu-bar-mode): | ||
| 43 | * minibuf-eldef.el (minibuffer-electric-default-mode): | ||
| 44 | * mouse-sel.el (mouse-sel-mode): | ||
| 45 | * msb.el (msb-mode): | ||
| 46 | * mwheel.el (mouse-wheel-mode): | ||
| 47 | * outline.el (outline-minor-mode): | ||
| 48 | * paren.el (show-paren-mode): | ||
| 49 | * recentf.el (recentf-mode): | ||
| 50 | * reveal.el (reveal-mode, global-reveal-mode): | ||
| 51 | * rfn-eshadow.el (file-name-shadow-mode): | ||
| 52 | * ruler-mode.el (ruler-mode): | ||
| 53 | * savehist.el (savehist-mode): | ||
| 54 | * scroll-all.el (scroll-all-mode): | ||
| 55 | * scroll-bar.el (scroll-bar-mode): | ||
| 56 | * server.el (server-mode): | ||
| 57 | * shell.el (shell-dirtrack-mode): | ||
| 58 | * simple.el (auto-fill-mode, transient-mark-mode) | ||
| 59 | (visual-line-mode, overwrite-mode, binary-overwrite-mode) | ||
| 60 | (line-number-mode, column-number-mode, size-indication-mode) | ||
| 61 | (auto-save-mode, normal-erase-is-backspace-mode, visible-mode): | ||
| 62 | * strokes.el (strokes-mode): | ||
| 63 | * time.el (display-time-mode): | ||
| 64 | * t-mouse.el (gpm-mouse-mode): | ||
| 65 | * tool-bar.el (tool-bar-mode): | ||
| 66 | * tooltip.el (tooltip-mode): | ||
| 67 | * type-break.el (type-break-mode-line-message-mode) | ||
| 68 | (type-break-query-mode): | ||
| 69 | * view.el (view-mode): | ||
| 70 | * whitespace.el (whitespace-mode, whitespace-newline-mode) | ||
| 71 | (global-whitespace-mode, global-whitespace-newline-mode): | ||
| 72 | * xt-mouse.el (xterm-mouse-mode): Doc fix. | ||
| 73 | |||
| 74 | * emacs-lisp/easy-mmode.el (define-globalized-minor-mode): Fix | ||
| 75 | autogenerated docstring. | ||
| 76 | |||
| 1 | 2011-10-19 Juri Linkov <juri@jurta.org> | 77 | 2011-10-19 Juri Linkov <juri@jurta.org> |
| 2 | 78 | ||
| 3 | * net/browse-url.el (browse-url-can-use-xdg-open): Support LXDE | 79 | * net/browse-url.el (browse-url-can-use-xdg-open): Support LXDE |
diff --git a/lisp/abbrev.el b/lisp/abbrev.el index 5a7a741a3a6..395810772c5 100644 --- a/lisp/abbrev.el +++ b/lisp/abbrev.el | |||
| @@ -54,9 +54,12 @@ define global abbrevs instead." | |||
| 54 | 54 | ||
| 55 | (define-minor-mode abbrev-mode | 55 | (define-minor-mode abbrev-mode |
| 56 | "Toggle Abbrev mode in the current buffer. | 56 | "Toggle Abbrev mode in the current buffer. |
| 57 | With optional argument ARG, turn abbrev mode on if ARG is | 57 | With a prefix argument ARG, enable Abbrev mode if ARG is |
| 58 | positive, otherwise turn it off. In Abbrev mode, inserting an | 58 | positive, and disable it otherwise. If called from Lisp, enable |
| 59 | abbreviation causes it to expand and be replaced by its expansion." | 59 | Abbrev mode if ARG is omitted or nil. |
| 60 | |||
| 61 | In Abbrev mode, inserting an abbreviation causes it to expand and | ||
| 62 | be replaced by its expansion." | ||
| 60 | ;; It's defined in C, this stops the d-m-m macro defining it again. | 63 | ;; It's defined in C, this stops the d-m-m macro defining it again. |
| 61 | :variable abbrev-mode) | 64 | :variable abbrev-mode) |
| 62 | 65 | ||
diff --git a/lisp/allout-widgets.el b/lisp/allout-widgets.el index ef75e7157e6..162da1f4815 100644 --- a/lisp/allout-widgets.el +++ b/lisp/allout-widgets.el | |||
| @@ -486,13 +486,14 @@ happens in the buffer.") | |||
| 486 | ;;;_ > define-minor-mode allout-widgets-mode (arg) | 486 | ;;;_ > define-minor-mode allout-widgets-mode (arg) |
| 487 | ;;;###autoload | 487 | ;;;###autoload |
| 488 | (define-minor-mode allout-widgets-mode | 488 | (define-minor-mode allout-widgets-mode |
| 489 | "Allout-mode extension, providing graphical decoration of outline structure. | 489 | "Toggle Allout Widgets mode. |
| 490 | 490 | With a prefix argument ARG, enable Allout Widgets mode if ARG is | |
| 491 | This is meant to operate along with allout-mode, via `allout-mode-hook'. | 491 | positive, and disable it otherwise. If called from Lisp, enable |
| 492 | 492 | the mode if ARG is omitted or nil. | |
| 493 | If optional argument ARG is greater than 0, enable. | 493 | |
| 494 | If optional argument ARG is less than 0, disable. | 494 | Allout Widgets mode is an extension of Allout mode that provides |
| 495 | Anything else, toggle between active and inactive. | 495 | graphical decoration of outline structure. It is meant to |
| 496 | operate along with `allout-mode', via `allout-mode-hook'. | ||
| 496 | 497 | ||
| 497 | The graphics include: | 498 | The graphics include: |
| 498 | 499 | ||
diff --git a/lisp/allout.el b/lisp/allout.el index 4002f12e264..18cc3c80dc6 100644 --- a/lisp/allout.el +++ b/lisp/allout.el | |||
| @@ -1702,17 +1702,19 @@ valid values." | |||
| 1702 | ;;;###autoload | 1702 | ;;;###autoload |
| 1703 | (define-minor-mode allout-mode | 1703 | (define-minor-mode allout-mode |
| 1704 | ;;;_ . Doc string: | 1704 | ;;;_ . Doc string: |
| 1705 | "Toggle minor mode for controlling exposure and editing of text outlines. | 1705 | "Toggle Allout outline mode. |
| 1706 | \\<allout-mode-map-value> | 1706 | With a prefix argument ARG, enable Allout outline mode if ARG is |
| 1707 | 1707 | positive, and disable it otherwise. If called from Lisp, enable | |
| 1708 | Allout outline mode always runs as a minor mode. | 1708 | the mode if ARG is omitted or nil. |
| 1709 | 1709 | ||
| 1710 | Allout outline mode provides extensive outline oriented | 1710 | \\<allout-mode-map-value> |
| 1711 | formatting and manipulation. It enables structural editing of | 1711 | Allout outline mode is a minor mode that provides extensive |
| 1712 | outlines, as well as navigation and exposure. It also is | 1712 | outline oriented formatting and manipulation. It enables |
| 1713 | specifically aimed at accommodating syntax-sensitive text like | 1713 | structural editing of outlines, as well as navigation and |
| 1714 | programming languages. \(For example, see the allout code itself, | 1714 | exposure. It also is specifically aimed at accommodating |
| 1715 | which is organized as an allout outline.) | 1715 | syntax-sensitive text like programming languages. \(For example, |
| 1716 | see the allout code itself, which is organized as an allout | ||
| 1717 | outline.) | ||
| 1716 | 1718 | ||
| 1717 | In addition to typical outline navigation and exposure, allout includes: | 1719 | In addition to typical outline navigation and exposure, allout includes: |
| 1718 | 1720 | ||
diff --git a/lisp/autoarg.el b/lisp/autoarg.el index 378ec1318b1..57f5bcd809c 100644 --- a/lisp/autoarg.el +++ b/lisp/autoarg.el | |||
| @@ -90,15 +90,19 @@ | |||
| 90 | 90 | ||
| 91 | ;;;###autoload | 91 | ;;;###autoload |
| 92 | (define-minor-mode autoarg-mode | 92 | (define-minor-mode autoarg-mode |
| 93 | "Toggle Autoarg minor mode globally. | 93 | "Toggle Autoarg mode, a global minor mode. |
| 94 | With ARG, turn Autoarg mode on if ARG is positive, off otherwise. | 94 | With a prefix argument ARG, enable Autoarg mode if ARG is |
| 95 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 96 | the mode if ARG is omitted or nil. | ||
| 97 | |||
| 95 | \\<autoarg-mode-map> | 98 | \\<autoarg-mode-map> |
| 96 | In Autoarg mode digits are bound to `digit-argument' -- i.e. they | 99 | In Autoarg mode, digits are bound to `digit-argument', i.e. they |
| 97 | supply prefix arguments as C-DIGIT and M-DIGIT normally do -- and | 100 | supply prefix arguments as C-DIGIT and M-DIGIT normally do. |
| 98 | C-DIGIT inserts DIGIT. \\[autoarg-terminate] terminates the prefix sequence | 101 | Furthermore, C-DIGIT inserts DIGIT. |
| 99 | and inserts the digits of the autoarg sequence into the buffer. | 102 | \\[autoarg-terminate] terminates the prefix sequence and inserts |
| 100 | Without a numeric prefix arg the normal binding of \\[autoarg-terminate] is | 103 | the digits of the autoarg sequence into the buffer. |
| 101 | invoked, i.e. what it would be with Autoarg mode off. | 104 | Without a numeric prefix arg, the normal binding of \\[autoarg-terminate] |
| 105 | is invoked, i.e. what it would be with Autoarg mode off. | ||
| 102 | 106 | ||
| 103 | For example: | 107 | For example: |
| 104 | `6 9 \\[autoarg-terminate]' inserts `69' into the buffer, as does `C-6 C-9'. | 108 | `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]. | |||
| 112 | 116 | ||
| 113 | ;;;###autoload | 117 | ;;;###autoload |
| 114 | (define-minor-mode autoarg-kp-mode | 118 | (define-minor-mode autoarg-kp-mode |
| 115 | "Toggle Autoarg-KP minor mode globally. | 119 | "Toggle Autoarg-KP mode, a global minor mode. |
| 116 | With ARG, turn Autoarg mode on if ARG is positive, off otherwise. | 120 | With a prefix argument ARG, enable Autoarg-KP mode if ARG is |
| 121 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 122 | the mode if ARG is omitted or nil. | ||
| 123 | |||
| 117 | \\<autoarg-kp-mode-map> | 124 | \\<autoarg-kp-mode-map> |
| 118 | This is similar to \\[autoarg-mode] but rebinds the keypad keys `kp-1' | 125 | This is similar to `autoarg-mode' but rebinds the keypad keys |
| 119 | etc. to supply digit arguments. | 126 | `kp-1' etc. to supply digit arguments. |
| 120 | 127 | ||
| 121 | \\{autoarg-kp-mode-map}" | 128 | \\{autoarg-kp-mode-map}" |
| 122 | nil " Aakp" autoarg-kp-mode-map :global t :group 'keyboard | 129 | nil " Aakp" autoarg-kp-mode-map :global t :group 'keyboard |
diff --git a/lisp/autoinsert.el b/lisp/autoinsert.el index 5793c3180be..6d002f4a217 100644 --- a/lisp/autoinsert.el +++ b/lisp/autoinsert.el | |||
| @@ -397,9 +397,10 @@ or if CONDITION had no actions, after all other CONDITIONs." | |||
| 397 | 397 | ||
| 398 | ;;;###autoload | 398 | ;;;###autoload |
| 399 | (define-minor-mode auto-insert-mode | 399 | (define-minor-mode auto-insert-mode |
| 400 | "Toggle Auto-insert mode. | 400 | "Toggle Auto-insert mode, a global minor mode. |
| 401 | With prefix ARG, turn Auto-insert mode on if and only if ARG is positive. | 401 | With a prefix argument ARG, enable Auto-insert mode if ARG is |
| 402 | Returns the new status of Auto-insert mode (non-nil means on). | 402 | positive, and disable it otherwise. If called from Lisp, enable |
| 403 | the mode if ARG is omitted or nil. | ||
| 403 | 404 | ||
| 404 | When Auto-insert mode is enabled, when new files are created you can | 405 | When Auto-insert mode is enabled, when new files are created you can |
| 405 | insert a template for the file depending on the mode of the buffer." | 406 | insert a template for the file depending on the mode of the buffer." |
diff --git a/lisp/autorevert.el b/lisp/autorevert.el index c67b6663bd0..817aaff55ca 100644 --- a/lisp/autorevert.el +++ b/lisp/autorevert.el | |||
| @@ -284,10 +284,15 @@ the list of old buffers.") | |||
| 284 | 284 | ||
| 285 | ;;;###autoload | 285 | ;;;###autoload |
| 286 | (define-minor-mode auto-revert-mode | 286 | (define-minor-mode auto-revert-mode |
| 287 | "Toggle reverting buffer when file on disk changes. | 287 | "Toggle reverting buffer when the file changes (Auto Revert mode). |
| 288 | With a prefix argument ARG, enable Auto Revert mode if ARG is | ||
| 289 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 290 | the mode if ARG is omitted or nil. | ||
| 291 | |||
| 292 | Auto Revert mode is a minor mode that affects only the current | ||
| 293 | buffer. When enabled, it reverts the buffer when the file on | ||
| 294 | disk changes. | ||
| 288 | 295 | ||
| 289 | With arg, turn Auto Revert mode on if and only if arg is positive. | ||
| 290 | This is a minor mode that affects only the current buffer. | ||
| 291 | Use `global-auto-revert-mode' to automatically revert all buffers. | 296 | Use `global-auto-revert-mode' to automatically revert all buffers. |
| 292 | Use `auto-revert-tail-mode' if you know that the file will only grow | 297 | Use `auto-revert-tail-mode' if you know that the file will only grow |
| 293 | without being changed in the part that is already in the buffer." | 298 | 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: | |||
| 314 | 319 | ||
| 315 | ;;;###autoload | 320 | ;;;###autoload |
| 316 | (define-minor-mode auto-revert-tail-mode | 321 | (define-minor-mode auto-revert-tail-mode |
| 317 | "Toggle reverting tail of buffer when file on disk grows. | 322 | "Toggle reverting tail of buffer when the file grows. |
| 318 | With arg, turn Tail mode on if arg is positive, otherwise turn it off. | 323 | With a prefix argument ARG, enable Auto-Revert Tail mode if ARG |
| 324 | is positive, and disable it otherwise. If called from Lisp, | ||
| 325 | enable the mode if ARG is omitted or nil. | ||
| 319 | 326 | ||
| 320 | When Tail mode is enabled, the tail of the file is constantly | 327 | When Auto Revert Tail mode is enabled, the tail of the file is |
| 321 | followed, as with the shell command `tail -f'. This means that | 328 | constantly followed, as with the shell command `tail -f'. This |
| 322 | whenever the file grows on disk (presumably because some | 329 | means that whenever the file grows on disk (presumably because |
| 323 | background process is appending to it from time to time), this is | 330 | some background process is appending to it from time to time), |
| 324 | reflected in the current buffer. | 331 | this is reflected in the current buffer. |
| 325 | 332 | ||
| 326 | You can edit the buffer and turn this mode off and on again as | 333 | You can edit the buffer and turn this mode off and on again as |
| 327 | you please. But make sure the background process has stopped | 334 | you please. But make sure the background process has stopped |
| @@ -367,7 +374,7 @@ Perform a full revert? ") | |||
| 367 | 374 | ||
| 368 | ;;;###autoload | 375 | ;;;###autoload |
| 369 | (defun turn-on-auto-revert-tail-mode () | 376 | (defun turn-on-auto-revert-tail-mode () |
| 370 | "Turn on Auto-Revert Tail Mode. | 377 | "Turn on Auto-Revert Tail mode. |
| 371 | 378 | ||
| 372 | This function is designed to be added to hooks, for example: | 379 | This function is designed to be added to hooks, for example: |
| 373 | (add-hook 'my-logfile-mode-hook 'turn-on-auto-revert-tail-mode)" | 380 | (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: | |||
| 377 | ;;;###autoload | 384 | ;;;###autoload |
| 378 | (define-minor-mode global-auto-revert-mode | 385 | (define-minor-mode global-auto-revert-mode |
| 379 | "Toggle Global Auto Revert mode. | 386 | "Toggle Global Auto Revert mode. |
| 380 | With optional prefix argument ARG, enable Global Auto Revert Mode | 387 | With a prefix argument ARG, enable Global Auto Revert mode if ARG |
| 381 | if ARG > 0, else disable it. | 388 | is positive, and disable it otherwise. If called from Lisp, |
| 389 | enable the mode if ARG is omitted or nil. | ||
| 382 | 390 | ||
| 383 | This is a global minor mode that reverts any buffer associated | 391 | Global Auto Revert mode is a global minor mode that reverts any |
| 384 | with a file when the file changes on disk. Use `auto-revert-mode' | 392 | buffer associated with a file when the file changes on disk. Use |
| 385 | to revert a particular buffer. | 393 | `auto-revert-mode' to revert a particular buffer. |
| 386 | 394 | ||
| 387 | If `global-auto-revert-non-file-buffers' is non-nil, this mode | 395 | If `global-auto-revert-non-file-buffers' is non-nil, this mode |
| 388 | may also revert some non-file buffers, as described in the | 396 | may also revert some non-file buffers, as described in the |
diff --git a/lisp/battery.el b/lisp/battery.el index f5c01fbef58..3b245ed644d 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 | |||
| 164 | 164 | ||
| 165 | ;;;###autoload | 165 | ;;;###autoload |
| 166 | (define-minor-mode display-battery-mode | 166 | (define-minor-mode display-battery-mode |
| 167 | "Display battery status information in the mode line. | 167 | "Toggle battery status display in mode line (Display Battery mode). |
| 168 | The text being displayed in the mode line is controlled by the variables | 168 | With a prefix argument ARG, enable Display Battery mode if ARG is |
| 169 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 170 | the mode if ARG is omitted or nil. | ||
| 171 | |||
| 172 | The text displayed in the mode line is controlled by | ||
| 169 | `battery-mode-line-format' and `battery-status-function'. | 173 | `battery-mode-line-format' and `battery-status-function'. |
| 170 | The mode line will be updated automatically every `battery-update-interval' | 174 | The mode line is be updated every `battery-update-interval' |
| 171 | seconds." | 175 | seconds." |
| 172 | :global t :group 'battery | 176 | :global t :group 'battery |
| 173 | (setq battery-mode-line-string "") | 177 | (setq battery-mode-line-string "") |
diff --git a/lisp/composite.el b/lisp/composite.el index 11a3d5ba388..487962ee07c 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)." | |||
| 728 | ;;;###autoload | 728 | ;;;###autoload |
| 729 | (define-minor-mode auto-composition-mode | 729 | (define-minor-mode auto-composition-mode |
| 730 | "Toggle Auto Composition mode. | 730 | "Toggle Auto Composition mode. |
| 731 | With ARG, turn Auto Composition mode off if and only if ARG is a non-positive | 731 | With a prefix argument ARG, enable Auto Composition mode if ARG |
| 732 | number; if ARG is nil, toggle Auto Composition mode; anything else turns Auto | 732 | is positive, and disable it otherwise. If called from Lisp, |
| 733 | Composition on. | 733 | enable the mode if ARG is omitted or nil. |
| 734 | 734 | ||
| 735 | When Auto Composition is enabled, text characters are automatically composed | 735 | When Auto Composition mode is enabled, text characters are |
| 736 | by functions registered in `composition-function-table' (which see). | 736 | automatically composed by functions registered in |
| 737 | `composition-function-table'. | ||
| 737 | 738 | ||
| 738 | You can use `global-auto-composition-mode' to turn on | 739 | You can use `global-auto-composition-mode' to turn on |
| 739 | Auto Composition mode in all buffers (this is the default)." | 740 | Auto Composition mode in all buffers (this is the default)." |
| @@ -744,10 +745,13 @@ Auto Composition mode in all buffers (this is the default)." | |||
| 744 | 745 | ||
| 745 | ;;;###autoload | 746 | ;;;###autoload |
| 746 | (define-minor-mode global-auto-composition-mode | 747 | (define-minor-mode global-auto-composition-mode |
| 747 | "Toggle Auto-Composition mode in every possible buffer. | 748 | "Toggle Auto Composition mode in all buffers. |
| 748 | With prefix arg, turn Global-Auto-Composition mode on if and only if arg | 749 | With a prefix argument ARG, enable it if ARG is positive, and |
| 749 | is positive. | 750 | disable it otherwise. If called from Lisp, enable it if ARG is |
| 750 | See `auto-composition-mode' for more information on Auto-Composition mode." | 751 | omitted or nil. |
| 752 | |||
| 753 | For more information on Auto Composition mode, see | ||
| 754 | `auto-composition-mode' ." | ||
| 751 | :variable (default-value 'auto-composition-mode)) | 755 | :variable (default-value 'auto-composition-mode)) |
| 752 | 756 | ||
| 753 | (defalias 'toggle-auto-composition 'auto-composition-mode) | 757 | (defalias 'toggle-auto-composition 'auto-composition-mode) |
diff --git a/lisp/delsel.el b/lisp/delsel.el index 705b64be89d..6d2c47f3957 100644 --- a/lisp/delsel.el +++ b/lisp/delsel.el | |||
| @@ -56,8 +56,9 @@ | |||
| 56 | ;;;###autoload | 56 | ;;;###autoload |
| 57 | (define-minor-mode delete-selection-mode | 57 | (define-minor-mode delete-selection-mode |
| 58 | "Toggle Delete Selection mode. | 58 | "Toggle Delete Selection mode. |
| 59 | With prefix ARG, turn Delete Selection mode on if ARG is | 59 | With a prefix argument ARG, enable Delete Selection mode if ARG |
| 60 | positive, off if ARG is not positive. | 60 | is positive, and disable it otherwise. If called from Lisp, |
| 61 | enable the mode if ARG is omitted or nil. | ||
| 61 | 62 | ||
| 62 | When Delete Selection mode is enabled, Transient Mark mode is also | 63 | When Delete Selection mode is enabled, Transient Mark mode is also |
| 63 | enabled and typed text replaces the selection if the selection is | 64 | enabled and typed text replaces the selection if the selection is |
diff --git a/lisp/desktop.el b/lisp/desktop.el index c60745a6b16..cdc787dfde9 100644 --- a/lisp/desktop.el +++ b/lisp/desktop.el | |||
| @@ -147,11 +147,14 @@ backward compatibility.") | |||
| 147 | 147 | ||
| 148 | ;;;###autoload | 148 | ;;;###autoload |
| 149 | (define-minor-mode desktop-save-mode | 149 | (define-minor-mode desktop-save-mode |
| 150 | "Toggle desktop saving mode. | 150 | "Toggle desktop saving (Desktop Save mode). |
| 151 | With numeric ARG, turn desktop saving on if ARG is positive, off | 151 | With a prefix argument ARG, enable Desktop Save mode if ARG is |
| 152 | otherwise. If desktop saving is turned on, the state of Emacs is | 152 | positive, and disable it otherwise. If called from Lisp, enable |
| 153 | saved from one session to another. See variable `desktop-save' | 153 | the mode if ARG is omitted or nil. |
| 154 | and function `desktop-read' for details." | 154 | |
| 155 | If Desktop Save mode is enabled, the state of Emacs is saved from | ||
| 156 | one session to another. See variable `desktop-save' and function | ||
| 157 | `desktop-read' for details." | ||
| 155 | :global t | 158 | :global t |
| 156 | :group 'desktop) | 159 | :group 'desktop) |
| 157 | 160 | ||
diff --git a/lisp/dired-x.el b/lisp/dired-x.el index 0f2cfd4973f..aaddc479b2a 100644 --- a/lisp/dired-x.el +++ b/lisp/dired-x.el | |||
| @@ -133,16 +133,20 @@ If nil, there is no maximum size." | |||
| 133 | :group 'dired-x) | 133 | :group 'dired-x) |
| 134 | 134 | ||
| 135 | (define-minor-mode dired-omit-mode | 135 | (define-minor-mode dired-omit-mode |
| 136 | "Toggle Dired-Omit mode. | 136 | "Toggle omission of uninteresting files in Dired (Dired-Omit mode). |
| 137 | With numeric ARG, enable Dired-Omit mode if ARG is positive, disable | 137 | With a prefix argument ARG, enable Dired-Omit mode if ARG is |
| 138 | otherwise. Enabling and disabling is buffer-local. | 138 | positive, and disable it otherwise. If called from Lisp, enable |
| 139 | If enabled, \"uninteresting\" files are not listed. | 139 | the mode if ARG is omitted or nil. |
| 140 | Uninteresting files are those whose filenames match regexp `dired-omit-files', | ||
| 141 | plus those ending with extensions in `dired-omit-extensions'. | ||
| 142 | 140 | ||
| 143 | To enable omitting in every Dired buffer, you can put in your ~/.emacs | 141 | Dired-Omit mode is a buffer-local minor mode. When enabled in a |
| 142 | Dired buffer, Dired does not list files whose filenames match | ||
| 143 | regexp `dired-omit-files', nor files ending with extensions in | ||
| 144 | `dired-omit-extensions'. | ||
| 144 | 145 | ||
| 145 | (add-hook 'dired-mode-hook (lambda () (dired-omit-mode 1))) | 146 | To enable omitting in every Dired buffer, you can put this in |
| 147 | your init file: | ||
| 148 | |||
| 149 | (add-hook 'dired-mode-hook (lambda () (dired-omit-mode))) | ||
| 146 | 150 | ||
| 147 | See Info node `(dired-x) Omitting Variables' for more information." | 151 | See Info node `(dired-x) Omitting Variables' for more information." |
| 148 | :group 'dired-x | 152 | :group 'dired-x |
diff --git a/lisp/dired.el b/lisp/dired.el index 60ba14ade84..3ff86869a78 100644 --- a/lisp/dired.el +++ b/lisp/dired.el | |||
| @@ -4128,7 +4128,7 @@ instead. | |||
| 4128 | ;;;*** | 4128 | ;;;*** |
| 4129 | 4129 | ||
| 4130 | ;;;### (autoloads (dired-do-relsymlink dired-jump-other-window dired-jump) | 4130 | ;;;### (autoloads (dired-do-relsymlink dired-jump-other-window dired-jump) |
| 4131 | ;;;;;; "dired-x" "dired-x.el" "219648338c42c7912fa336680b434db0") | 4131 | ;;;;;; "dired-x" "dired-x.el" "0a19e4cb2cadf007be715af1035c9c36") |
| 4132 | ;;; Generated autoloads from dired-x.el | 4132 | ;;; Generated autoloads from dired-x.el |
| 4133 | 4133 | ||
| 4134 | (autoload 'dired-jump "dired-x" "\ | 4134 | (autoload 'dired-jump "dired-x" "\ |
diff --git a/lisp/dirtrack.el b/lisp/dirtrack.el index 23a05816a2d..eef8c111da5 100644 --- a/lisp/dirtrack.el +++ b/lisp/dirtrack.el | |||
| @@ -183,7 +183,11 @@ and ends with a forward slash." | |||
| 183 | 183 | ||
| 184 | ;;;###autoload | 184 | ;;;###autoload |
| 185 | (define-minor-mode dirtrack-mode | 185 | (define-minor-mode dirtrack-mode |
| 186 | "Enable or disable Dirtrack directory tracking in a shell buffer. | 186 | "Toggle directory tracking in shell buffers (Dirtrack mode). |
| 187 | With a prefix argument ARG, enable Dirtrack mode if ARG is | ||
| 188 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 189 | the mode if ARG is omitted or nil. | ||
| 190 | |||
| 187 | This method requires that your shell prompt contain the full | 191 | This method requires that your shell prompt contain the full |
| 188 | current working directory at all times, and that `dirtrack-list' | 192 | current working directory at all times, and that `dirtrack-list' |
| 189 | is set to match the prompt. This is an alternative to | 193 | is set to match the prompt. This is an alternative to |
| @@ -199,7 +203,7 @@ and similar commands which change the shell working directory." | |||
| 199 | 203 | ||
| 200 | 204 | ||
| 201 | (define-minor-mode dirtrack-debug-mode | 205 | (define-minor-mode dirtrack-debug-mode |
| 202 | "Enable or disable Dirtrack debugging." | 206 | "Toggle Dirtrack debugging." |
| 203 | nil nil nil | 207 | nil nil nil |
| 204 | (if dirtrack-debug-mode | 208 | (if dirtrack-debug-mode |
| 205 | (display-buffer (get-buffer-create dirtrack-debug-buffer)))) | 209 | (display-buffer (get-buffer-create dirtrack-debug-buffer)))) |
diff --git a/lisp/doc-view.el b/lisp/doc-view.el index 872b2172c7e..ceaad83cd7c 100644 --- a/lisp/doc-view.el +++ b/lisp/doc-view.el | |||
| @@ -1502,8 +1502,11 @@ to the next best mode." | |||
| 1502 | 1502 | ||
| 1503 | ;;;###autoload | 1503 | ;;;###autoload |
| 1504 | (define-minor-mode doc-view-minor-mode | 1504 | (define-minor-mode doc-view-minor-mode |
| 1505 | "Toggle Doc view minor mode. | 1505 | "Toggle displaying buffer via Doc View (Doc View minor mode). |
| 1506 | With arg, turn Doc view minor mode on if arg is positive, off otherwise. | 1506 | With a prefix argument ARG, enable Doc View minor mode if ARG is |
| 1507 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 1508 | the mode if ARG is omitted or nil. | ||
| 1509 | |||
| 1507 | See the command `doc-view-mode' for more information on this mode." | 1510 | See the command `doc-view-mode' for more information on this mode." |
| 1508 | nil " DocView" doc-view-minor-mode-map | 1511 | nil " DocView" doc-view-minor-mode-map |
| 1509 | :group 'doc-view | 1512 | :group 'doc-view |
diff --git a/lisp/double.el b/lisp/double.el index 4aa8da72af7..2a845f61942 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." | |||
| 146 | 146 | ||
| 147 | ;;;###autoload | 147 | ;;;###autoload |
| 148 | (define-minor-mode double-mode | 148 | (define-minor-mode double-mode |
| 149 | "Toggle Double mode. | 149 | "Toggle special insertion on double keypresses (Double mode). |
| 150 | With prefix argument ARG, turn Double mode on if ARG is positive, otherwise | 150 | With a prefix argument ARG, enable Double mode if ARG is |
| 151 | turn it off. | 151 | positive, and disable it otherwise. If called from Lisp, enable |
| 152 | the mode if ARG is omitted or nil. | ||
| 152 | 153 | ||
| 153 | When Double mode is on, some keys will insert different strings | 154 | When Double mode is enabled, some keys will insert different |
| 154 | when pressed twice. See variable `double-map' for details." | 155 | strings when pressed twice. See `double-map' for details." |
| 155 | :lighter " Double" | 156 | :lighter " Double" |
| 156 | :link '(emacs-commentary-link "double") | 157 | :link '(emacs-commentary-link "double") |
| 157 | (kill-local-variable 'key-translation-map) | 158 | (kill-local-variable 'key-translation-map) |
diff --git a/lisp/electric.el b/lisp/electric.el index 17c33c7d5cd..26fba20ea12 100644 --- a/lisp/electric.el +++ b/lisp/electric.el | |||
| @@ -241,8 +241,14 @@ Returns nil when we can't find this char." | |||
| 241 | 241 | ||
| 242 | ;;;###autoload | 242 | ;;;###autoload |
| 243 | (define-minor-mode electric-indent-mode | 243 | (define-minor-mode electric-indent-mode |
| 244 | "Automatically reindent lines of code when inserting particular chars. | 244 | "Toggle on-the-fly reindentation (Electric Indent mode). |
| 245 | `electric-indent-chars' specifies the set of chars that should cause reindentation." | 245 | With a prefix argument ARG, enable Electric Indent mode if ARG is |
| 246 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 247 | the mode if ARG is omitted or nil. | ||
| 248 | |||
| 249 | Electric Indent mode is a global minor mode. When enabled, | ||
| 250 | reindentation is triggered whenever you insert a character listed | ||
| 251 | in `electric-indent-chars'." | ||
| 246 | :global t | 252 | :global t |
| 247 | :group 'electricity | 253 | :group 'electricity |
| 248 | (if electric-indent-mode | 254 | (if electric-indent-mode |
| @@ -330,7 +336,14 @@ This can be convenient for people who find it easier to hit ) than C-f." | |||
| 330 | 336 | ||
| 331 | ;;;###autoload | 337 | ;;;###autoload |
| 332 | (define-minor-mode electric-pair-mode | 338 | (define-minor-mode electric-pair-mode |
| 333 | "Automatically pair-up parens when inserting an open paren." | 339 | "Toggle automatic parens pairing (Electric Pair mode). |
| 340 | With a prefix argument ARG, enable Electric Pair mode if ARG is | ||
| 341 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 342 | the mode if ARG is omitted or nil. | ||
| 343 | |||
| 344 | Electric Pair mode is a global minor mode. When enabled, typing | ||
| 345 | an open parenthesis automatically inserts the corresponding | ||
| 346 | closing parenthesis. \(Likewise for brackets, etc.)" | ||
| 334 | :global t | 347 | :global t |
| 335 | :group 'electricity | 348 | :group 'electricity |
| 336 | (if electric-pair-mode | 349 | (if electric-pair-mode |
diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el index 46dc1f162ba..b1cb0615e43 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." | |||
| 350 | (define-minor-mode ,global-mode | 350 | (define-minor-mode ,global-mode |
| 351 | ;; Very short lines to avoid too long lines in the generated | 351 | ;; Very short lines to avoid too long lines in the generated |
| 352 | ;; doc string. | 352 | ;; doc string. |
| 353 | ,(format "Toggle %s in every possible buffer. | 353 | ,(format "Toggle %s in all buffers. |
| 354 | With prefix ARG, turn %s on if and only if | 354 | With prefix ARG, enable %s if ARG is positive; |
| 355 | ARG is positive. | 355 | otherwise, disable it. If called from Lisp, enable the mode if |
| 356 | ARG is omitted or nil. | ||
| 357 | |||
| 356 | %s is enabled in all buffers where | 358 | %s is enabled in all buffers where |
| 357 | \`%s' would do it. | 359 | \`%s' would do it. |
| 358 | See `%s' for more information on %s." | 360 | See `%s' for more information on %s." |
| 359 | pretty-name pretty-global-name pretty-name turn-on | 361 | pretty-name pretty-global-name |
| 360 | mode pretty-name) | 362 | pretty-name turn-on mode pretty-name) |
| 361 | :global t ,@group ,@(nreverse extra-keywords) | 363 | :global t ,@group ,@(nreverse extra-keywords) |
| 362 | 364 | ||
| 363 | ;; Setup hook to handle future mode changes and new buffers. | 365 | ;; Setup hook to handle future mode changes and new buffers. |
diff --git a/lisp/emacs-lock.el b/lisp/emacs-lock.el index 18411f7d2ef..f2c93473015 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)." | |||
| 176 | 176 | ||
| 177 | ;;;###autoload | 177 | ;;;###autoload |
| 178 | (define-minor-mode emacs-lock-mode | 178 | (define-minor-mode emacs-lock-mode |
| 179 | "Toggle Emacs Lock mode in the current buffer. | 179 | "Toggle Emacs Lock mode in the current buffer. |
| 180 | 180 | If called with a plain prefix argument, ask for the locking mode | |
| 181 | With \\[universal-argument], ask for the locking mode to be used. | 181 | to be used. With any other prefix ARG, turn mode on if ARG is |
| 182 | With other prefix ARG, turn mode on if ARG is positive, off otherwise. | 182 | positive, off otherwise. If called from Lisp, enable the mode if |
| 183 | 183 | ARG is omitted or nil. | |
| 184 | Initially, if the user does not pass an explicit locking mode, it defaults | 184 | |
| 185 | to `emacs-lock-default-locking-mode' (which see); afterwards, the locking | 185 | Initially, if the user does not pass an explicit locking mode, it |
| 186 | mode most recently set on the buffer is used instead. | 186 | defaults to `emacs-lock-default-locking-mode' (which see); |
| 187 | afterwards, the locking mode most recently set on the buffer is | ||
| 188 | used instead. | ||
| 187 | 189 | ||
| 188 | When called from Elisp code, ARG can be any locking mode: | 190 | When called from Elisp code, ARG can be any locking mode: |
| 189 | 191 | ||
diff --git a/lisp/epa-hook.el b/lisp/epa-hook.el index 652ab19ba65..ea036e836e4 100644 --- a/lisp/epa-hook.el +++ b/lisp/epa-hook.el | |||
| @@ -49,7 +49,7 @@ does that automatically." | |||
| 49 | :group 'epa-file) | 49 | :group 'epa-file) |
| 50 | 50 | ||
| 51 | (defvar epa-file-encrypt-to nil | 51 | (defvar epa-file-encrypt-to nil |
| 52 | "*Recipient(s) used for encrypting files. | 52 | "Recipient(s) used for encrypting files. |
| 53 | May either be a string or a list of strings.") | 53 | May either be a string or a list of strings.") |
| 54 | 54 | ||
| 55 | (put 'epa-file-encrypt-to 'safe-local-variable | 55 | (put 'epa-file-encrypt-to 'safe-local-variable |
| @@ -83,9 +83,10 @@ May either be a string or a list of strings.") | |||
| 83 | (auto-save-mode 0))) | 83 | (auto-save-mode 0))) |
| 84 | 84 | ||
| 85 | (define-minor-mode auto-encryption-mode | 85 | (define-minor-mode auto-encryption-mode |
| 86 | "Toggle automatic file encryption and decryption. | 86 | "Toggle automatic file encryption/decryption (Auto Encryption mode). |
| 87 | With prefix argument ARG, turn auto encryption on if positive, else off. | 87 | With a prefix argument ARG, enable Auto Encryption mode if ARG is |
| 88 | Return the new status of auto encryption (non-nil means on)." | 88 | positive, and disable it otherwise. If called from Lisp, enable |
| 89 | the mode if ARG is omitted or nil." | ||
| 89 | :global t :init-value t :group 'epa-file :version "23.1" | 90 | :global t :init-value t :group 'epa-file :version "23.1" |
| 90 | ;; We'd like to use custom-initialize-set here so the setup is done | 91 | ;; We'd like to use custom-initialize-set here so the setup is done |
| 91 | ;; before dumping, but at the point where the defcustom is evaluated, | 92 | ;; before dumping, but at the point where the defcustom is evaluated, |
diff --git a/lisp/face-remap.el b/lisp/face-remap.el index 9e5ab58636b..bfd973a299f 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." | |||
| 204 | (make-variable-buffer-local 'text-scale-mode-amount) | 204 | (make-variable-buffer-local 'text-scale-mode-amount) |
| 205 | 205 | ||
| 206 | (define-minor-mode text-scale-mode | 206 | (define-minor-mode text-scale-mode |
| 207 | "Minor mode for displaying buffer text in a larger/smaller font than usual. | 207 | "Minor mode for displaying buffer text in a larger/smaller font. |
| 208 | 208 | ||
| 209 | The amount of scaling is determined by the variable | 209 | The amount of scaling is determined by the variable |
| 210 | `text-scale-mode-amount': one step scales the global default | 210 | `text-scale-mode-amount': one step scales the global default |
diff --git a/lisp/follow.el b/lisp/follow.el index 94a542f1016..37295cc533b 100644 --- a/lisp/follow.el +++ b/lisp/follow.el | |||
| @@ -484,10 +484,13 @@ Used by `follow-window-size-change'.") | |||
| 484 | (put 'follow-mode 'permanent-local t) | 484 | (put 'follow-mode 'permanent-local t) |
| 485 | ;;;###autoload | 485 | ;;;###autoload |
| 486 | (define-minor-mode follow-mode | 486 | (define-minor-mode follow-mode |
| 487 | "Minor mode that combines windows into one tall virtual window. | 487 | "Toggle Follow mode. |
| 488 | With a prefix argument ARG, enable Follow mode if ARG is | ||
| 489 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 490 | the mode if ARG is omitted or nil. | ||
| 488 | 491 | ||
| 489 | The feeling of a \"virtual window\" has been accomplished by the use | 492 | Follow mode is a minor mode that combines windows into one tall |
| 490 | of two major techniques: | 493 | virtual window. This is accomplished by two main techniques: |
| 491 | 494 | ||
| 492 | * The windows always displays adjacent sections of the buffer. | 495 | * The windows always displays adjacent sections of the buffer. |
| 493 | This means that whenever one window is moved, all the | 496 | This means that whenever one window is moved, all the |
diff --git a/lisp/font-core.el b/lisp/font-core.el index fcaaf33b718..0db17efd7b7 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 | |||
| 86 | 86 | ||
| 87 | ;; The mode for which font-lock was initialized, or nil if none. | 87 | ;; The mode for which font-lock was initialized, or nil if none. |
| 88 | (defvar font-lock-major-mode) | 88 | (defvar font-lock-major-mode) |
| 89 | |||
| 89 | (define-minor-mode font-lock-mode | 90 | (define-minor-mode font-lock-mode |
| 90 | "Toggle Font Lock mode. | 91 | "Toggle syntax highlighting in this buffer (Font Lock mode). |
| 91 | With arg, turn Font Lock mode off if and only if arg is a non-positive | 92 | With a prefix argument ARG, enable Font Lock mode if ARG is |
| 92 | number; if arg is nil, toggle Font Lock mode; anything else turns Font | 93 | positive, and disable it otherwise. If called from Lisp, enable |
| 93 | Lock on. | 94 | the mode if ARG is omitted or nil. |
| 94 | \(Font Lock is also known as \"syntax highlighting\".) | ||
| 95 | 95 | ||
| 96 | When Font Lock mode is enabled, text is fontified as you type it: | 96 | When Font Lock mode is enabled, text is fontified as you type it: |
| 97 | 97 | ||
diff --git a/lisp/frame.el b/lisp/frame.el index ab9b085f1d9..8359fed14a4 100644 --- a/lisp/frame.el +++ b/lisp/frame.el | |||
| @@ -1134,7 +1134,10 @@ To get the frame's current border color, use `frame-parameters'." | |||
| 1134 | 1134 | ||
| 1135 | (define-minor-mode auto-raise-mode | 1135 | (define-minor-mode auto-raise-mode |
| 1136 | "Toggle whether or not the selected frame should auto-raise. | 1136 | "Toggle whether or not the selected frame should auto-raise. |
| 1137 | With ARG, turn auto-raise mode on if and only if ARG is positive. | 1137 | With a prefix argument ARG, enable Auto Raise mode if ARG is |
| 1138 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 1139 | the mode if ARG is omitted or nil. | ||
| 1140 | |||
| 1138 | Note that this controls Emacs's own auto-raise feature. | 1141 | Note that this controls Emacs's own auto-raise feature. |
| 1139 | Some window managers allow you to enable auto-raise for certain windows. | 1142 | Some window managers allow you to enable auto-raise for certain windows. |
| 1140 | You can use that for Emacs windows if you wish, but if you do, | 1143 | 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." | |||
| 1145 | 1148 | ||
| 1146 | (define-minor-mode auto-lower-mode | 1149 | (define-minor-mode auto-lower-mode |
| 1147 | "Toggle whether or not the selected frame should auto-lower. | 1150 | "Toggle whether or not the selected frame should auto-lower. |
| 1148 | With ARG, turn auto-lower mode on if and only if ARG is positive. | 1151 | With a prefix argument ARG, enable Auto Lower mode if ARG is |
| 1152 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 1153 | the mode if ARG is omitted or nil. | ||
| 1154 | |||
| 1149 | Note that this controls Emacs's own auto-lower feature. | 1155 | Note that this controls Emacs's own auto-lower feature. |
| 1150 | Some window managers allow you to enable auto-lower for certain windows. | 1156 | Some window managers allow you to enable auto-lower for certain windows. |
| 1151 | You can use that for Emacs windows if you wish, but if you do, | 1157 | You can use that for Emacs windows if you wish, but if you do, |
| @@ -1556,14 +1562,13 @@ itself as a pre-command hook." | |||
| 1556 | (setq blink-cursor-timer nil))) | 1562 | (setq blink-cursor-timer nil))) |
| 1557 | 1563 | ||
| 1558 | (define-minor-mode blink-cursor-mode | 1564 | (define-minor-mode blink-cursor-mode |
| 1559 | "Toggle blinking cursor mode. | 1565 | "Toggle cursor blinking (Blink Cursor mode). |
| 1560 | With a numeric argument, turn blinking cursor mode on if ARG is positive, | 1566 | With a prefix argument ARG, enable Blink Cursor mode if ARG is |
| 1561 | otherwise turn it off. When blinking cursor mode is enabled, the | 1567 | positive, and disable it otherwise. If called from Lisp, enable |
| 1562 | cursor of the selected window blinks. | 1568 | the mode if ARG is omitted or nil. |
| 1563 | 1569 | ||
| 1564 | Note that this command is effective only when Emacs | 1570 | This command is effective only on graphical frames. On text-only |
| 1565 | displays through a window system, because then Emacs does its own | 1571 | terminals, cursor blinking is controlled by the terminal." |
| 1566 | cursor display. On a text-only terminal, this is not implemented." | ||
| 1567 | :init-value (not (or noninteractive | 1572 | :init-value (not (or noninteractive |
| 1568 | no-blinking-cursor | 1573 | no-blinking-cursor |
| 1569 | (eq system-type 'ms-dos) | 1574 | (eq system-type 'ms-dos) |
diff --git a/lisp/help.el b/lisp/help.el index e2af0759a65..508a4e3262c 100644 --- a/lisp/help.el +++ b/lisp/help.el | |||
| @@ -977,13 +977,15 @@ function is called, the window to be resized is selected." | |||
| 977 | :version "20.4") | 977 | :version "20.4") |
| 978 | 978 | ||
| 979 | (define-minor-mode temp-buffer-resize-mode | 979 | (define-minor-mode temp-buffer-resize-mode |
| 980 | "Toggle mode which makes windows smaller for temporary buffers. | 980 | "Toggle auto-shrinking temp buffer windows (Temp Buffer Resize mode). |
| 981 | With prefix argument ARG, turn the resizing of windows displaying | 981 | With a prefix argument ARG, enable Temp Buffer Resize mode if ARG |
| 982 | temporary buffers on if ARG is positive or off otherwise. | 982 | is positive, and disable it otherwise. If called from Lisp, |
| 983 | 983 | enable the mode if ARG is omitted or nil. | |
| 984 | This mode makes a window the right height for its contents, but | 984 | |
| 985 | never more than `temp-buffer-max-height' nor less than | 985 | When Temp Buffer Resize mode is enabled, the windows in which we |
| 986 | `window-min-height'. | 986 | show a temporary buffer are automatically reduced in height to |
| 987 | fit the buffer's contents, but never more than | ||
| 988 | `temp-buffer-max-height' nor less than `window-min-height'. | ||
| 987 | 989 | ||
| 988 | This mode is used by `help', `apropos' and `completion' buffers, | 990 | This mode is used by `help', `apropos' and `completion' buffers, |
| 989 | and some others." | 991 | and some others." |
diff --git a/lisp/hi-lock.el b/lisp/hi-lock.el index a254abe33ac..f659a7e8eef 100644 --- a/lisp/hi-lock.el +++ b/lisp/hi-lock.el | |||
| @@ -283,14 +283,17 @@ a library is being loaded.") | |||
| 283 | 283 | ||
| 284 | ;;;###autoload | 284 | ;;;###autoload |
| 285 | (define-minor-mode hi-lock-mode | 285 | (define-minor-mode hi-lock-mode |
| 286 | "Toggle minor mode for interactively adding font-lock highlighting patterns. | 286 | "Toggle selective highlighting of patterns (Hi Lock mode). |
| 287 | 287 | With a prefix argument ARG, enable Hi Lock mode if ARG is | |
| 288 | If ARG positive, turn hi-lock on. Issuing a hi-lock command will also | 288 | positive, and disable it otherwise. If called from Lisp, enable |
| 289 | turn hi-lock on. To turn hi-lock on in all buffers use | 289 | the mode if ARG is omitted or nil. |
| 290 | `global-hi-lock-mode' or in your .emacs file (global-hi-lock-mode 1). | 290 | |
| 291 | When hi-lock is turned on, a \"Regexp Highlighting\" submenu is added | 291 | Issuing one the highlighting commands listed below will |
| 292 | to the \"Edit\" menu. The commands in the submenu, which can be | 292 | automatically enable Hi Lock mode. To enable Hi Lock mode in all |
| 293 | called interactively, are: | 293 | buffers, use `global-hi-lock-mode' or add (global-hi-lock-mode 1) |
| 294 | to your init file. When Hi Lock mode is enabled, a \"Regexp | ||
| 295 | Highlighting\" submenu is added to the \"Edit\" menu. The | ||
| 296 | commands in the submenu, which can be called interactively, are: | ||
| 294 | 297 | ||
| 295 | \\[highlight-regexp] REGEXP FACE | 298 | \\[highlight-regexp] REGEXP FACE |
| 296 | Highlight matches of pattern REGEXP in current buffer with FACE. | 299 | Highlight matches of pattern REGEXP in current buffer with FACE. |
diff --git a/lisp/hilit-chg.el b/lisp/hilit-chg.el index 041c1ee938b..46db4280688 100644 --- a/lisp/hilit-chg.el +++ b/lisp/hilit-chg.el | |||
| @@ -326,14 +326,15 @@ remove it from existing buffers." | |||
| 326 | 326 | ||
| 327 | ;;;###autoload | 327 | ;;;###autoload |
| 328 | (define-minor-mode highlight-changes-mode | 328 | (define-minor-mode highlight-changes-mode |
| 329 | "Toggle Highlight Changes mode. | 329 | "Toggle highlighting changes in this buffer (Highlight Changes mode). |
| 330 | With a prefix argument ARG, enable Highlight Changes mode if ARG | ||
| 331 | is positive, and disable it otherwise. If called from Lisp, | ||
| 332 | enable the mode if ARG is omitted or nil. | ||
| 330 | 333 | ||
| 331 | With ARG, turn Highlight Changes mode on if and only if arg is positive. | 334 | When Highlight Changes is enabled, changes are marked with a text |
| 332 | 335 | property. Normally they are displayed in a distinctive face, but | |
| 333 | In Highlight Changes mode changes are recorded with a text property. | 336 | command \\[highlight-changes-visible-mode] can be used to toggles |
| 334 | Normally they are displayed in a distinctive face, but command | 337 | this on and off. |
| 335 | \\[highlight-changes-visible-mode] can be used to toggles this | ||
| 336 | on and off. | ||
| 337 | 338 | ||
| 338 | Other functions for buffers in this mode include: | 339 | Other functions for buffers in this mode include: |
| 339 | \\[highlight-changes-next-change] - move point to beginning of next change | 340 | \\[highlight-changes-next-change] - move point to beginning of next change |
| @@ -366,14 +367,17 @@ buffer with the contents of a file | |||
| 366 | 367 | ||
| 367 | ;;;###autoload | 368 | ;;;###autoload |
| 368 | (define-minor-mode highlight-changes-visible-mode | 369 | (define-minor-mode highlight-changes-visible-mode |
| 369 | "Toggle visiblility of changes when buffer is in Highlight Changes mode. | 370 | "Toggle visiblility of highlighting due to Highlight Changes mode. |
| 371 | With a prefix argument ARG, enable Highlight Changes Visible mode | ||
| 372 | if ARG is positive, and disable it otherwise. If called from | ||
| 373 | Lisp, enable the mode if ARG is omitted or nil. | ||
| 370 | 374 | ||
| 371 | This mode only has an effect when Highlight Changes mode is on. | 375 | Highlight Changes Visible mode only has an effect when Highlight |
| 372 | It allows toggling between whether or not the changed text is displayed | 376 | Changes mode is on. When enabled, the changed text is displayed |
| 373 | in a distinctive face. | 377 | in a distinctive face. |
| 374 | 378 | ||
| 375 | The default value can be customized with variable | 379 | The default value can be customized with variable |
| 376 | `highlight-changes-visibility-initial-state' | 380 | `highlight-changes-visibility-initial-state'. |
| 377 | 381 | ||
| 378 | This command does not itself set highlight-changes mode." | 382 | This command does not itself set highlight-changes mode." |
| 379 | 383 | ||
diff --git a/lisp/hl-line.el b/lisp/hl-line.el index 846f5f95187..b535398f107 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.") | |||
| 124 | 124 | ||
| 125 | ;;;###autoload | 125 | ;;;###autoload |
| 126 | (define-minor-mode hl-line-mode | 126 | (define-minor-mode hl-line-mode |
| 127 | "Buffer-local minor mode to highlight the line about point. | 127 | "Toggle highlighting of the current line (Hl-Line mode). |
| 128 | With ARG, turn Hl-Line mode on if ARG is positive, off otherwise. | 128 | With a prefix argument ARG, enable Hl-Line mode if ARG is |
| 129 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 130 | the mode if ARG is omitted or nil. | ||
| 129 | 131 | ||
| 130 | If `hl-line-sticky-flag' is non-nil, Hl-Line mode highlights the | 132 | Hl-Line mode is a buffer-local minor mode. If |
| 133 | `hl-line-sticky-flag' is non-nil, Hl-Line mode highlights the | ||
| 131 | line about the buffer's point in all windows. Caveat: the | 134 | line about the buffer's point in all windows. Caveat: the |
| 132 | buffer's point might be different from the point of a | 135 | buffer's point might be different from the point of a |
| 133 | non-selected window. Hl-Line mode uses the function | 136 | non-selected window. Hl-Line mode uses the function |
| @@ -171,8 +174,10 @@ addition to `hl-line-highlight' on `post-command-hook'." | |||
| 171 | 174 | ||
| 172 | ;;;###autoload | 175 | ;;;###autoload |
| 173 | (define-minor-mode global-hl-line-mode | 176 | (define-minor-mode global-hl-line-mode |
| 174 | "Global minor mode to highlight the line about point in the current window. | 177 | "Toggle line highlighting in all buffers (Global Hl-Line mode). |
| 175 | With ARG, turn Global-Hl-Line mode on if ARG is positive, off otherwise. | 178 | With a prefix argument ARG, enable Global Hl-Line mode if ARG is |
| 179 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 180 | the mode if ARG is omitted or nil. | ||
| 176 | 181 | ||
| 177 | If `global-hl-line-sticky-flag' is non-nil, Global Hl-Line mode | 182 | If `global-hl-line-sticky-flag' is non-nil, Global Hl-Line mode |
| 178 | highlights the line about the current buffer's point in all | 183 | highlights the line about the current buffer's point in all |
diff --git a/lisp/ibuf-ext.el b/lisp/ibuf-ext.el index 073efaeee2a..6c8db872c0b 100644 --- a/lisp/ibuf-ext.el +++ b/lisp/ibuf-ext.el | |||
| @@ -217,8 +217,10 @@ Currently, this only applies to `ibuffer-saved-filters' and | |||
| 217 | 217 | ||
| 218 | ;;;###autoload | 218 | ;;;###autoload |
| 219 | (define-minor-mode ibuffer-auto-mode | 219 | (define-minor-mode ibuffer-auto-mode |
| 220 | "Toggle use of Ibuffer's auto-update facility. | 220 | "Toggle use of Ibuffer's auto-update facility (Ibuffer Auto mode). |
| 221 | With numeric ARG, enable auto-update if and only if ARG is positive." | 221 | With a prefix argument ARG, enable Ibuffer Auto mode if ARG is |
| 222 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 223 | the mode if ARG is omitted or nil." | ||
| 222 | nil nil nil | 224 | nil nil nil |
| 223 | (unless (derived-mode-p 'ibuffer-mode) | 225 | (unless (derived-mode-p 'ibuffer-mode) |
| 224 | (error "This buffer is not in Ibuffer mode")) | 226 | (error "This buffer is not in Ibuffer mode")) |
diff --git a/lisp/ibuffer.el b/lisp/ibuffer.el index 5a86508e144..17ddddbd17a 100644 --- a/lisp/ibuffer.el +++ b/lisp/ibuffer.el | |||
| @@ -2648,12 +2648,14 @@ will be inserted before the group at point." | |||
| 2648 | ;;;;;; ibuffer-backward-filter-group ibuffer-forward-filter-group | 2648 | ;;;;;; ibuffer-backward-filter-group ibuffer-forward-filter-group |
| 2649 | ;;;;;; ibuffer-toggle-filter-group ibuffer-mouse-toggle-filter-group | 2649 | ;;;;;; ibuffer-toggle-filter-group ibuffer-mouse-toggle-filter-group |
| 2650 | ;;;;;; ibuffer-interactive-filter-by-mode ibuffer-mouse-filter-by-mode | 2650 | ;;;;;; ibuffer-interactive-filter-by-mode ibuffer-mouse-filter-by-mode |
| 2651 | ;;;;;; ibuffer-auto-mode) "ibuf-ext" "ibuf-ext.el" "617b36fc8479547d679cf0103f82e3ff") | 2651 | ;;;;;; ibuffer-auto-mode) "ibuf-ext" "ibuf-ext.el" "25e69a1e030791b3a3e7d91d4377173a") |
| 2652 | ;;; Generated autoloads from ibuf-ext.el | 2652 | ;;; Generated autoloads from ibuf-ext.el |
| 2653 | 2653 | ||
| 2654 | (autoload 'ibuffer-auto-mode "ibuf-ext" "\ | 2654 | (autoload 'ibuffer-auto-mode "ibuf-ext" "\ |
| 2655 | Toggle use of Ibuffer's auto-update facility. | 2655 | Toggle use of Ibuffer's auto-update facility (Ibuffer Auto mode). |
| 2656 | With numeric ARG, enable auto-update if and only if ARG is positive. | 2656 | With a prefix argument ARG, enable Ibuffer Auto mode if ARG is |
| 2657 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 2658 | the mode if ARG is omitted or nil. | ||
| 2657 | 2659 | ||
| 2658 | \(fn &optional ARG)" t nil) | 2660 | \(fn &optional ARG)" t nil) |
| 2659 | 2661 | ||
diff --git a/lisp/icomplete.el b/lisp/icomplete.el index bdd19194c22..53876f48a06 100644 --- a/lisp/icomplete.el +++ b/lisp/icomplete.el | |||
| @@ -172,9 +172,10 @@ except those on this list.") | |||
| 172 | ;;;_ > icomplete-mode (&optional prefix) | 172 | ;;;_ > icomplete-mode (&optional prefix) |
| 173 | ;;;###autoload | 173 | ;;;###autoload |
| 174 | (define-minor-mode icomplete-mode | 174 | (define-minor-mode icomplete-mode |
| 175 | "Toggle incremental minibuffer completion for this Emacs session. | 175 | "Toggle incremental minibuffer completion (Icomplete mode). |
| 176 | With a numeric argument, turn Icomplete mode on if ARG is positive, | 176 | With a prefix argument ARG, enable Icomplete mode if ARG is |
| 177 | otherwise turn it off." | 177 | positive, and disable it otherwise. If called from Lisp, enable |
| 178 | the mode if ARG is omitted or nil." | ||
| 178 | :global t :group 'icomplete | 179 | :global t :group 'icomplete |
| 179 | (if icomplete-mode | 180 | (if icomplete-mode |
| 180 | ;; The following is not really necessary after first time - | 181 | ;; The following is not really necessary after first time - |
diff --git a/lisp/ido.el b/lisp/ido.el index 0844c2c50c6..88599013ce6 100644 --- a/lisp/ido.el +++ b/lisp/ido.el | |||
| @@ -1469,8 +1469,10 @@ Removes badly formatted data and ignored directories." | |||
| 1469 | (add-hook 'choose-completion-string-functions 'ido-choose-completion-string)) | 1469 | (add-hook 'choose-completion-string-functions 'ido-choose-completion-string)) |
| 1470 | 1470 | ||
| 1471 | (define-minor-mode ido-everywhere | 1471 | (define-minor-mode ido-everywhere |
| 1472 | "Toggle using ido-mode everywhere file and directory names are read. | 1472 | "Toggle use of Ido for all buffer/file reading. |
| 1473 | With ARG, turn ido-mode on if arg is positive, off otherwise." | 1473 | With a prefix argument ARG, enable this feature if ARG is |
| 1474 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 1475 | the mode if ARG is omitted or nil." | ||
| 1474 | :global t | 1476 | :global t |
| 1475 | :group 'ido | 1477 | :group 'ido |
| 1476 | (when (get 'ido-everywhere 'file) | 1478 | (when (get 'ido-everywhere 'file) |
diff --git a/lisp/image-file.el b/lisp/image-file.el index bd1c101d529..52012b12a56 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." | |||
| 178 | 178 | ||
| 179 | ;;;###autoload | 179 | ;;;###autoload |
| 180 | (define-minor-mode auto-image-file-mode | 180 | (define-minor-mode auto-image-file-mode |
| 181 | "Toggle visiting of image files as images. | 181 | "Toggle visiting of image files as images (Auto Image File mode). |
| 182 | With prefix argument ARG, turn on if positive, otherwise off. | 182 | With a prefix argument ARG, enable Auto Image File mode if ARG is |
| 183 | Returns non-nil if the new state is enabled. | 183 | positive, and disable it otherwise. If called from Lisp, enable |
| 184 | the mode if ARG is omitted or nil. | ||
| 184 | 185 | ||
| 185 | Image files are those whose name has an extension in | 186 | An image file is one whose name has an extension in |
| 186 | `image-file-name-extensions', or matches a regexp in | 187 | `image-file-name-extensions', or matches a regexp in |
| 187 | `image-file-name-regexps'." | 188 | `image-file-name-regexps'." |
| 188 | :global t | 189 | :global t |
diff --git a/lisp/image-mode.el b/lisp/image-mode.el index 0995048fce5..30223e69ae0 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." | |||
| 396 | 396 | ||
| 397 | ;;;###autoload | 397 | ;;;###autoload |
| 398 | (define-minor-mode image-minor-mode | 398 | (define-minor-mode image-minor-mode |
| 399 | "Toggle Image minor mode. | 399 | "Toggle Image minor mode in this buffer. |
| 400 | With arg, turn Image minor mode on if arg is positive, off otherwise. | 400 | With a prefix argument ARG, enable Image minor mode if ARG is |
| 401 | It provides the key \\<image-mode-map>\\[image-toggle-display] \ | 401 | positive, and disable it otherwise. If called from Lisp, enable |
| 402 | to switch back to `image-mode' | 402 | the mode if ARG is omitted or nil. |
| 403 | to display an image file as the actual image." | 403 | |
| 404 | Image minor mode provides the key \\<image-mode-map>\\[image-toggle-display], | ||
| 405 | to switch back to `image-mode' and display an image file as the | ||
| 406 | actual image." | ||
| 404 | nil (:eval (if image-type (format " Image[%s]" image-type) " Image")) | 407 | nil (:eval (if image-type (format " Image[%s]" image-type) " Image")) |
| 405 | image-minor-mode-map | 408 | image-minor-mode-map |
| 406 | :group 'image | 409 | :group 'image |
diff --git a/lisp/iswitchb.el b/lisp/iswitchb.el index 70dda5442d5..a7d3328526a 100644 --- a/lisp/iswitchb.el +++ b/lisp/iswitchb.el | |||
| @@ -1424,10 +1424,13 @@ See the variable `iswitchb-case' for details." | |||
| 1424 | 1424 | ||
| 1425 | ;;;###autoload | 1425 | ;;;###autoload |
| 1426 | (define-minor-mode iswitchb-mode | 1426 | (define-minor-mode iswitchb-mode |
| 1427 | "Toggle Iswitchb global minor mode. | 1427 | "Toggle Iswitchb mode. |
| 1428 | With arg, turn Iswitchb mode on if ARG is positive, otherwise turn it off. | 1428 | With a prefix argument ARG, enable Iswitchb mode if ARG is |
| 1429 | This mode enables switching between buffers using substrings. See | 1429 | positive, and disable it otherwise. If called from Lisp, enable |
| 1430 | `iswitchb' for details." | 1430 | the mode if ARG is omitted or nil. |
| 1431 | |||
| 1432 | Iswitchb mode is a global minor mode that enables switching | ||
| 1433 | between buffers using substrings. See `iswitchb' for details." | ||
| 1431 | nil nil iswitchb-global-map :global t :group 'iswitchb | 1434 | nil nil iswitchb-global-map :global t :group 'iswitchb |
| 1432 | (if iswitchb-mode | 1435 | (if iswitchb-mode |
| 1433 | (add-hook 'minibuffer-setup-hook 'iswitchb-minibuffer-setup) | 1436 | (add-hook 'minibuffer-setup-hook 'iswitchb-minibuffer-setup) |
diff --git a/lisp/jka-cmpr-hook.el b/lisp/jka-cmpr-hook.el index d28fde0b214..bf312445f17 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." | |||
| 333 | :group 'jka-compr) | 333 | :group 'jka-compr) |
| 334 | 334 | ||
| 335 | (define-minor-mode auto-compression-mode | 335 | (define-minor-mode auto-compression-mode |
| 336 | "Toggle automatic file compression and uncompression. | 336 | "Toggle Auto Compression mode. |
| 337 | With prefix argument ARG, turn auto compression on if positive, else off. | 337 | With a prefix argument ARG, enable Auto Compression mode if ARG |
| 338 | Return the new status of auto compression (non-nil means on)." | 338 | is positive, and disable it otherwise. If called from Lisp, |
| 339 | enable the mode if ARG is omitted or nil. | ||
| 340 | |||
| 341 | Auto Compression mode is a global minor mode. When enabled, | ||
| 342 | compressed files are automatically uncompressed for reading, and | ||
| 343 | compressed when writing." | ||
| 339 | :global t :init-value t :group 'jka-compr :version "22.1" | 344 | :global t :init-value t :group 'jka-compr :version "22.1" |
| 340 | (let* ((installed (jka-compr-installed-p)) | 345 | (let* ((installed (jka-compr-installed-p)) |
| 341 | (flag auto-compression-mode)) | 346 | (flag auto-compression-mode)) |
diff --git a/lisp/linum.el b/lisp/linum.el index db6e4c49977..4e58a1b7118 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." | |||
| 73 | 73 | ||
| 74 | ;;;###autoload | 74 | ;;;###autoload |
| 75 | (define-minor-mode linum-mode | 75 | (define-minor-mode linum-mode |
| 76 | "Toggle display of line numbers in the left margin." | 76 | "Toggle display of line numbers in the left margin (Linum mode). |
| 77 | With a prefix argument ARG, enable Linum mode if ARG is positive, | ||
| 78 | and disable it otherwise. If called from Lisp, enable the mode | ||
| 79 | if ARG is omitted or nil. | ||
| 80 | |||
| 81 | Linum mode is a buffer-local minor mode." | ||
| 77 | :lighter "" ; for desktop.el | 82 | :lighter "" ; for desktop.el |
| 78 | (if linum-mode | 83 | (if linum-mode |
| 79 | (progn | 84 | (progn |
diff --git a/lisp/longlines.el b/lisp/longlines.el index f625d8fcac7..b4d15da78a7 100644 --- a/lisp/longlines.el +++ b/lisp/longlines.el | |||
| @@ -95,21 +95,22 @@ This is used when `longlines-show-hard-newlines' is on." | |||
| 95 | 95 | ||
| 96 | ;;;###autoload | 96 | ;;;###autoload |
| 97 | (define-minor-mode longlines-mode | 97 | (define-minor-mode longlines-mode |
| 98 | "Minor mode to wrap long lines. | 98 | "Toggle Long Lines mode in this buffer. |
| 99 | In Long Lines mode, long lines are wrapped if they extend beyond | 99 | With a prefix argument ARG, enable Long Lines mode if ARG is |
| 100 | `fill-column'. The soft newlines used for line wrapping will not | 100 | positive, and disable it otherwise. If called from Lisp, enable |
| 101 | show up when the text is yanked or saved to disk. | 101 | the mode if ARG is omitted or nil. |
| 102 | 102 | ||
| 103 | With no argument, this command toggles Long Lines mode. | 103 | When Long Lines mode is enabled, long lines are wrapped if they |
| 104 | With a prefix argument ARG, turn Long Lines minor mode on if ARG is positive, | 104 | extend beyond `fill-column'. The soft newlines used for line |
| 105 | otherwise turn it off. | 105 | wrapping will not show up when the text is yanked or saved to |
| 106 | 106 | disk. | |
| 107 | If the variable `longlines-auto-wrap' is non-nil, lines are automatically | 107 | |
| 108 | wrapped whenever the buffer is changed. You can always call | 108 | If the variable `longlines-auto-wrap' is non-nil, lines are |
| 109 | `fill-paragraph' to fill individual paragraphs. | 109 | automatically wrapped whenever the buffer is changed. You can |
| 110 | 110 | always call `fill-paragraph' to fill individual paragraphs. | |
| 111 | If the variable `longlines-show-hard-newlines' is non-nil, hard newlines | 111 | |
| 112 | are indicated with a symbol." | 112 | If the variable `longlines-show-hard-newlines' is non-nil, hard |
| 113 | newlines are indicated with a symbol." | ||
| 113 | :group 'longlines :lighter " ll" | 114 | :group 'longlines :lighter " ll" |
| 114 | (if longlines-mode | 115 | (if longlines-mode |
| 115 | ;; Turn on longlines mode | 116 | ;; Turn on longlines mode |
diff --git a/lisp/master.el b/lisp/master.el index 1ea0a24ca94..c3e9004ca0b 100644 --- a/lisp/master.el +++ b/lisp/master.el | |||
| @@ -72,12 +72,12 @@ You can set this variable using `master-set-slave'.") | |||
| 72 | ;;;###autoload | 72 | ;;;###autoload |
| 73 | (define-minor-mode master-mode | 73 | (define-minor-mode master-mode |
| 74 | "Toggle Master mode. | 74 | "Toggle Master mode. |
| 75 | With no argument, this command toggles the mode. | 75 | With a prefix argument ARG, enable Master mode if ARG is |
| 76 | Non-null prefix argument turns on the mode. | 76 | positive, and disable it otherwise. If called from Lisp, enable |
| 77 | Null prefix argument turns off the mode. | 77 | the mode if ARG is omitted or nil. |
| 78 | 78 | ||
| 79 | When Master mode is enabled, you can scroll the slave buffer using the | 79 | When Master mode is enabled, you can scroll the slave buffer |
| 80 | following commands: | 80 | using the following commands: |
| 81 | 81 | ||
| 82 | \\{master-mode-map} | 82 | \\{master-mode-map} |
| 83 | 83 | ||
diff --git a/lisp/mb-depth.el b/lisp/mb-depth.el index 2ed692c1b84..22fd84a67aa 100644 --- a/lisp/mb-depth.el +++ b/lisp/mb-depth.el | |||
| @@ -56,12 +56,14 @@ The prompt should already have been inserted." | |||
| 56 | ;;;###autoload | 56 | ;;;###autoload |
| 57 | (define-minor-mode minibuffer-depth-indicate-mode | 57 | (define-minor-mode minibuffer-depth-indicate-mode |
| 58 | "Toggle Minibuffer Depth Indication mode. | 58 | "Toggle Minibuffer Depth Indication mode. |
| 59 | When active, any recursive use of the minibuffer will show | 59 | With a prefix argument ARG, enable Minibuffer Depth Indication |
| 60 | the recursion depth in the minibuffer prompt. This is only | 60 | mode if ARG is positive, and disable it otherwise. If called |
| 61 | useful if `enable-recursive-minibuffers' is non-nil. | 61 | from Lisp, enable the mode if ARG is omitted or nil. |
| 62 | 62 | ||
| 63 | With prefix argument ARG, turn on if positive, otherwise off. | 63 | Minibuffer Depth Indication mode is a global minor mode. When |
| 64 | Returns non-nil if the new state is enabled." | 64 | enabled, any recursive use of the minibuffer will show the |
| 65 | recursion depth in the minibuffer prompt. This is only useful if | ||
| 66 | `enable-recursive-minibuffers' is non-nil." | ||
| 65 | :global t | 67 | :global t |
| 66 | :group 'minibuffer | 68 | :group 'minibuffer |
| 67 | (if minibuffer-depth-indicate-mode | 69 | (if minibuffer-depth-indicate-mode |
diff --git a/lisp/menu-bar.el b/lisp/menu-bar.el index d75a768e2d4..75a2d70da5e 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.") | |||
| 2169 | :help ,(purecopy "Put previous minibuffer history element in the minibuffer")))) | 2169 | :help ,(purecopy "Put previous minibuffer history element in the minibuffer")))) |
| 2170 | 2170 | ||
| 2171 | (define-minor-mode menu-bar-mode | 2171 | (define-minor-mode menu-bar-mode |
| 2172 | "Toggle display of a menu bar on each frame. | 2172 | "Toggle display of a menu bar on each frame (Menu Bar mode). |
| 2173 | With a prefix argument ARG, enable Menu Bar mode if ARG is | ||
| 2174 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 2175 | Menu Bar mode if ARG is omitted or nil. | ||
| 2176 | |||
| 2173 | This command applies to all frames that exist and frames to be | 2177 | This command applies to all frames that exist and frames to be |
| 2174 | created in the future. | 2178 | created in the future." |
| 2175 | With a numeric argument, if the argument is positive, | ||
| 2176 | turn on menu bars; otherwise, turn off menu bars." | ||
| 2177 | :init-value t | 2179 | :init-value t |
| 2178 | :global t | 2180 | :global t |
| 2179 | ;; It's defined in C/cus-start, this stops the d-m-m macro defining it again. | 2181 | ;; 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 e6ebe3c53f1..405721f97ee 100644 --- a/lisp/minibuf-eldef.el +++ b/lisp/minibuf-eldef.el | |||
| @@ -131,14 +131,16 @@ been set up by `minibuf-eldef-setup-minibuffer'." | |||
| 131 | ;;;###autoload | 131 | ;;;###autoload |
| 132 | (define-minor-mode minibuffer-electric-default-mode | 132 | (define-minor-mode minibuffer-electric-default-mode |
| 133 | "Toggle Minibuffer Electric Default mode. | 133 | "Toggle Minibuffer Electric Default mode. |
| 134 | When active, minibuffer prompts that show a default value only show the | 134 | With a prefix argument ARG, enable Minibuffer Electric Default |
| 135 | default when it's applicable -- that is, when hitting RET would yield | 135 | mode if ARG is positive, and disable it otherwise. If called |
| 136 | the default value. If the user modifies the input such that hitting RET | 136 | from Lisp, enable the mode if ARG is omitted or nil. |
| 137 | would enter a non-default value, the prompt is modified to remove the | 137 | |
| 138 | default indication. | 138 | Minibuffer Electric Default mode is a global minor mode. When |
| 139 | 139 | enabled, minibuffer prompts that show a default value only show | |
| 140 | With prefix argument ARG, turn on if positive, otherwise off. | 140 | the default when it's applicable -- that is, when hitting RET |
| 141 | Returns non-nil if the new state is enabled." | 141 | would yield the default value. If the user modifies the input |
| 142 | such that hitting RET would enter a non-default value, the prompt | ||
| 143 | is modified to remove the default indication." | ||
| 142 | :global t | 144 | :global t |
| 143 | :group 'minibuffer | 145 | :group 'minibuffer |
| 144 | (if minibuffer-electric-default-mode | 146 | (if minibuffer-electric-default-mode |
diff --git a/lisp/mouse-sel.el b/lisp/mouse-sel.el index 50d221b6fa0..bcf1749e13f 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." | |||
| 199 | ;;;###autoload | 199 | ;;;###autoload |
| 200 | (define-minor-mode mouse-sel-mode | 200 | (define-minor-mode mouse-sel-mode |
| 201 | "Toggle Mouse Sel mode. | 201 | "Toggle Mouse Sel mode. |
| 202 | With prefix ARG, turn Mouse Sel mode on if and only if ARG is positive. | 202 | With a prefix argument ARG, enable Mouse Sel mode if ARG is |
| 203 | Returns the new status of Mouse Sel mode (non-nil means on). | 203 | positive, and disable it otherwise. If called from Lisp, enable |
| 204 | the mode if ARG is omitted or nil. | ||
| 204 | 205 | ||
| 205 | When Mouse Sel mode is enabled, mouse selection is enhanced in | 206 | Mouse Sel mode is a global minor mode. When enabled, mouse |
| 206 | various ways: | 207 | selection is enhanced in various ways: |
| 207 | 208 | ||
| 208 | - Double-clicking on symbol constituents selects symbols. | 209 | - Double-clicking on symbol constituents selects symbols. |
| 209 | Double-clicking on quotes or parentheses selects sexps. | 210 | Double-clicking on quotes or parentheses selects sexps. |
diff --git a/lisp/msb.el b/lisp/msb.el index 12e5a0192fe..74ceff1a9cd 100644 --- a/lisp/msb.el +++ b/lisp/msb.el | |||
| @@ -1133,7 +1133,10 @@ variable `msb-menu-cond'." | |||
| 1133 | ;;;###autoload | 1133 | ;;;###autoload |
| 1134 | (define-minor-mode msb-mode | 1134 | (define-minor-mode msb-mode |
| 1135 | "Toggle Msb mode. | 1135 | "Toggle Msb mode. |
| 1136 | With arg, turn Msb mode on if and only if arg is positive. | 1136 | With a prefix argument ARG, enable Msb mode if ARG is positive, |
| 1137 | and disable it otherwise. If called from Lisp, enable the mode | ||
| 1138 | if ARG is omitted or nil. | ||
| 1139 | |||
| 1137 | This mode overrides the binding(s) of `mouse-buffer-menu' to provide a | 1140 | This mode overrides the binding(s) of `mouse-buffer-menu' to provide a |
| 1138 | different buffer menu using the function `msb'." | 1141 | different buffer menu using the function `msb'." |
| 1139 | :global t :group 'msb | 1142 | :global t :group 'msb |
diff --git a/lisp/mwheel.el b/lisp/mwheel.el index 4ead168b188..05aeb12acf4 100644 --- a/lisp/mwheel.el +++ b/lisp/mwheel.el | |||
| @@ -250,11 +250,11 @@ This should only be bound to mouse buttons 4 and 5." | |||
| 250 | 250 | ||
| 251 | (defvar mwheel-installed-bindings nil) | 251 | (defvar mwheel-installed-bindings nil) |
| 252 | 252 | ||
| 253 | ;; preloaded ;;;###autoload | ||
| 254 | (define-minor-mode mouse-wheel-mode | 253 | (define-minor-mode mouse-wheel-mode |
| 255 | "Toggle mouse wheel support. | 254 | "Toggle mouse wheel support (Mouse Wheel mode). |
| 256 | With prefix argument ARG, turn on if positive, otherwise off. | 255 | With a prefix argument ARG, enable Mouse Wheel mode if ARG is |
| 257 | Return non-nil if the new state is enabled." | 256 | positive, and disable it otherwise. If called from Lisp, enable |
| 257 | the mode if ARG is omitted or nil." | ||
| 258 | :init-value t | 258 | :init-value t |
| 259 | ;; We'd like to use custom-initialize-set here so the setup is done | 259 | ;; We'd like to use custom-initialize-set here so the setup is done |
| 260 | ;; before dumping, but at the point where the defcustom is evaluated, | 260 | ;; before dumping, but at the point where the defcustom is evaluated, |
diff --git a/lisp/outline.el b/lisp/outline.el index f864058c6fc..34d30fc4591 100644 --- a/lisp/outline.el +++ b/lisp/outline.el | |||
| @@ -356,7 +356,10 @@ After that, changing the prefix key requires manipulating keymaps." | |||
| 356 | ;;;###autoload | 356 | ;;;###autoload |
| 357 | (define-minor-mode outline-minor-mode | 357 | (define-minor-mode outline-minor-mode |
| 358 | "Toggle Outline minor mode. | 358 | "Toggle Outline minor mode. |
| 359 | With arg, turn Outline minor mode on if arg is positive, off otherwise. | 359 | With a prefix argument ARG, enable Outline minor mode if ARG is |
| 360 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 361 | the mode if ARG is omitted or nil. | ||
| 362 | |||
| 360 | See the command `outline-mode' for more information on this mode." | 363 | See the command `outline-mode' for more information on this mode." |
| 361 | nil " Outl" (list (cons [menu-bar] outline-minor-mode-menu-bar-map) | 364 | nil " Outl" (list (cons [menu-bar] outline-minor-mode-menu-bar-map) |
| 362 | (cons outline-minor-mode-prefix outline-mode-prefix-map)) | 365 | (cons outline-minor-mode-prefix outline-mode-prefix-map)) |
diff --git a/lisp/paren.el b/lisp/paren.el index fb5c0bf36e9..ee550228d48 100644 --- a/lisp/paren.el +++ b/lisp/paren.el | |||
| @@ -102,12 +102,14 @@ otherwise)." | |||
| 102 | 102 | ||
| 103 | ;;;###autoload | 103 | ;;;###autoload |
| 104 | (define-minor-mode show-paren-mode | 104 | (define-minor-mode show-paren-mode |
| 105 | "Toggle Show Paren mode. | 105 | "Toggle visualization of matching parens (Show Paren mode). |
| 106 | With prefix ARG, turn Show Paren mode on if and only if ARG is positive. | 106 | With a prefix argument ARG, enable Show Paren mode if ARG is |
| 107 | Returns the new status of Show Paren mode (non-nil means on). | 107 | positive, and disable it otherwise. If called from Lisp, enable |
| 108 | the mode if ARG is omitted or nil. | ||
| 108 | 109 | ||
| 109 | When Show Paren mode is enabled, any matching parenthesis is highlighted | 110 | Show Paren mode is a global minor mode. When enabled, any |
| 110 | in `show-paren-style' after `show-paren-delay' seconds of Emacs idle time." | 111 | matching parenthesis is highlighted in `show-paren-style' after |
| 112 | `show-paren-delay' seconds of Emacs idle time." | ||
| 111 | :global t :group 'paren-showing | 113 | :global t :group 'paren-showing |
| 112 | ;; Enable or disable the mechanism. | 114 | ;; Enable or disable the mechanism. |
| 113 | ;; First get rid of the old idle timer. | 115 | ;; First get rid of the old idle timer. |
diff --git a/lisp/recentf.el b/lisp/recentf.el index fc9b7881733..79f4eb437d9 100644 --- a/lisp/recentf.el +++ b/lisp/recentf.el | |||
| @@ -1336,12 +1336,14 @@ That is, remove duplicates, non-kept, and excluded files." | |||
| 1336 | 1336 | ||
| 1337 | ;;;###autoload | 1337 | ;;;###autoload |
| 1338 | (define-minor-mode recentf-mode | 1338 | (define-minor-mode recentf-mode |
| 1339 | "Toggle recentf mode. | 1339 | "Toggle \"Open Recent\" menu (Recentf mode). |
| 1340 | With prefix argument ARG, turn on if positive, otherwise off. | 1340 | With a prefix argument ARG, enable Recentf mode if ARG is |
| 1341 | Returns non-nil if the new state is enabled. | 1341 | positive, and disable it otherwise. If called from Lisp, enable |
| 1342 | 1342 | Recentf mode if ARG is omitted or nil. | |
| 1343 | When recentf mode is enabled, it maintains a menu for visiting files | 1343 | |
| 1344 | that were operated on recently." | 1344 | When Recentf mode is enabled, a \"Open Recent\" submenu is |
| 1345 | displayed in the \"File\" menu, containing a list of files that | ||
| 1346 | were operated on recently." | ||
| 1345 | :global t | 1347 | :global t |
| 1346 | :group 'recentf | 1348 | :group 'recentf |
| 1347 | :keymap recentf-mode-map | 1349 | :keymap recentf-mode-map |
diff --git a/lisp/reveal.el b/lisp/reveal.el index bf18602379c..ea46cfd1dd3 100644 --- a/lisp/reveal.el +++ b/lisp/reveal.el | |||
| @@ -189,12 +189,13 @@ Each element has the form (WINDOW . OVERLAY).") | |||
| 189 | 189 | ||
| 190 | ;;;###autoload | 190 | ;;;###autoload |
| 191 | (define-minor-mode reveal-mode | 191 | (define-minor-mode reveal-mode |
| 192 | "Toggle Reveal mode on or off. | 192 | "Toggle decloaking of invisible text near point (Reveal mode). |
| 193 | Reveal mode renders invisible text around point visible again. | 193 | With a prefix argument ARG, enable Reveal mode if ARG is |
| 194 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 195 | Reveal mode if ARG is omitted or nil. | ||
| 194 | 196 | ||
| 195 | Interactively, with no prefix argument, toggle the mode. | 197 | Reveral mode is a buffer-local minor mode. When enabled, it |
| 196 | With universal prefix ARG (or if ARG is nil) turn mode on. | 198 | reveals invisible text around point." |
| 197 | With zero or negative ARG turn mode off." | ||
| 198 | :group 'reveal | 199 | :group 'reveal |
| 199 | :lighter (global-reveal-mode nil " Reveal") | 200 | :lighter (global-reveal-mode nil " Reveal") |
| 200 | :keymap reveal-mode-map | 201 | :keymap reveal-mode-map |
| @@ -207,12 +208,12 @@ With zero or negative ARG turn mode off." | |||
| 207 | 208 | ||
| 208 | ;;;###autoload | 209 | ;;;###autoload |
| 209 | (define-minor-mode global-reveal-mode | 210 | (define-minor-mode global-reveal-mode |
| 210 | "Toggle Reveal mode in all buffers on or off. | 211 | "Toggle Reveal mode in all buffers (Global Reveal mode). |
| 211 | Reveal mode renders invisible text around point visible again. | 212 | Reveal mode renders invisible text around point visible again. |
| 212 | 213 | ||
| 213 | Interactively, with no prefix argument, toggle the mode. | 214 | With a prefix argument ARG, enable Global Reveal mode if ARG is |
| 214 | With universal prefix ARG (or if ARG is nil) turn mode on. | 215 | positive, and disable it otherwise. If called from Lisp, enable |
| 215 | With zero or negative ARG turn mode off." | 216 | the mode if ARG is omitted or nil." |
| 216 | :global t :group 'reveal | 217 | :global t :group 'reveal |
| 217 | (setq-default reveal-mode global-reveal-mode) | 218 | (setq-default reveal-mode global-reveal-mode) |
| 218 | (if global-reveal-mode | 219 | (if global-reveal-mode |
diff --git a/lisp/rfn-eshadow.el b/lisp/rfn-eshadow.el index 9eb2d2abdee..2d8c6e0964d 100644 --- a/lisp/rfn-eshadow.el +++ b/lisp/rfn-eshadow.el | |||
| @@ -207,15 +207,17 @@ been set up by `rfn-eshadow-setup-minibuffer'." | |||
| 207 | (error nil))) | 207 | (error nil))) |
| 208 | 208 | ||
| 209 | (define-minor-mode file-name-shadow-mode | 209 | (define-minor-mode file-name-shadow-mode |
| 210 | "Toggle File-Name Shadow mode. | 210 | "Toggle file-name shadowing in minibuffers (File-Name Shadow mode). |
| 211 | When active, any part of a filename being read in the minibuffer | 211 | With a prefix argument ARG, enable File-Name Shadow mode if ARG |
| 212 | that would be ignored (because the result is passed through | 212 | is positive, and disable it otherwise. If called from Lisp, |
| 213 | enable the mode if ARG is omitted or nil. | ||
| 214 | |||
| 215 | File-Name Shadow mode is a global minor mode. When enabled, any | ||
| 216 | part of a filename being read in the minibuffer that would be | ||
| 217 | ignored (because the result is passed through | ||
| 213 | `substitute-in-file-name') is given the properties in | 218 | `substitute-in-file-name') is given the properties in |
| 214 | `file-name-shadow-properties', which can be used to make | 219 | `file-name-shadow-properties', which can be used to make that |
| 215 | that portion dim, invisible, or otherwise less visually noticeable. | 220 | portion dim, invisible, or otherwise less visually noticeable." |
| 216 | |||
| 217 | With prefix argument ARG, turn on if positive, otherwise off. | ||
| 218 | Returns non-nil if the new state is enabled." | ||
| 219 | :global t | 221 | :global t |
| 220 | ;; We'd like to use custom-initialize-set here so the setup is done | 222 | ;; We'd like to use custom-initialize-set here so the setup is done |
| 221 | ;; before dumping, but at the point where the defcustom is evaluated, | 223 | ;; before dumping, but at the point where the defcustom is evaluated, |
diff --git a/lisp/ruler-mode.el b/lisp/ruler-mode.el index fc62bf6b633..046c29471ac 100644 --- a/lisp/ruler-mode.el +++ b/lisp/ruler-mode.el | |||
| @@ -567,8 +567,10 @@ format first." | |||
| 567 | 567 | ||
| 568 | ;;;###autoload | 568 | ;;;###autoload |
| 569 | (define-minor-mode ruler-mode | 569 | (define-minor-mode ruler-mode |
| 570 | "Toggle Ruler mode. | 570 | "Toggle display of ruler in header line (Ruler mode). |
| 571 | In Ruler mode, Emacs displays a ruler in the header line." | 571 | With a prefix argument ARG, enable Ruler mode if ARG is positive, |
| 572 | and disable it otherwise. If called from Lisp, enable the mode | ||
| 573 | if ARG is omitted or nil." | ||
| 572 | nil nil | 574 | nil nil |
| 573 | ruler-mode-map | 575 | ruler-mode-map |
| 574 | :group 'ruler-mode | 576 | :group 'ruler-mode |
diff --git a/lisp/savehist.el b/lisp/savehist.el index 653d0312a19..faeab324e5a 100644 --- a/lisp/savehist.el +++ b/lisp/savehist.el | |||
| @@ -170,15 +170,19 @@ minibuffer history.") | |||
| 170 | 170 | ||
| 171 | ;;;###autoload | 171 | ;;;###autoload |
| 172 | (define-minor-mode savehist-mode | 172 | (define-minor-mode savehist-mode |
| 173 | "Toggle savehist-mode. | 173 | "Toggle saving of minibuffer history (Savehist mode). |
| 174 | Positive ARG turns on `savehist-mode'. When on, savehist-mode causes | 174 | With a prefix argument ARG, enable Savehist mode if ARG is |
| 175 | minibuffer history to be saved periodically and when exiting Emacs. | 175 | positive, and disable it otherwise. If called from Lisp, enable |
| 176 | When turned on for the first time in an Emacs session, it causes the | 176 | the mode if ARG is omitted or nil. |
| 177 | previous minibuffer history to be loaded from `savehist-file'. | 177 | |
| 178 | When Savehist mode is enabled, minibuffer history is saved | ||
| 179 | periodically and when exiting Emacs. When Savehist mode is | ||
| 180 | enabled for the first time in an Emacs session, it loads the | ||
| 181 | previous minibuffer history from `savehist-file'. | ||
| 178 | 182 | ||
| 179 | This mode should normally be turned on from your Emacs init file. | 183 | This mode should normally be turned on from your Emacs init file. |
| 180 | Calling it at any other time replaces your current minibuffer histories, | 184 | Calling it at any other time replaces your current minibuffer |
| 181 | which is probably undesirable." | 185 | histories, which is probably undesirable." |
| 182 | :global t | 186 | :global t |
| 183 | (if (not savehist-mode) | 187 | (if (not savehist-mode) |
| 184 | (savehist-uninstall) | 188 | (savehist-uninstall) |
diff --git a/lisp/scroll-all.el b/lisp/scroll-all.el index 6dbdc9ab90d..81a4d2c86e1 100644 --- a/lisp/scroll-all.el +++ b/lisp/scroll-all.el | |||
| @@ -101,10 +101,13 @@ | |||
| 101 | 101 | ||
| 102 | ;;;###autoload | 102 | ;;;###autoload |
| 103 | (define-minor-mode scroll-all-mode | 103 | (define-minor-mode scroll-all-mode |
| 104 | "Toggle Scroll-All minor mode. | 104 | "Toggle shared scrolling in same-frame windows (Scroll-All mode). |
| 105 | With ARG, turn Scroll-All minor mode on if ARG is positive, off otherwise. | 105 | With a prefix argument ARG, enable Scroll-All mode if ARG is |
| 106 | When Scroll-All mode is on, scrolling commands entered in one window | 106 | positive, and disable it otherwise. If called from Lisp, enable |
| 107 | apply to all visible windows in the same frame." | 107 | the mode if ARG is omitted or nil. |
| 108 | |||
| 109 | When Scroll-All mode is enabled, scrolling commands invoked in | ||
| 110 | one window apply to all visible windows in the same frame." | ||
| 108 | nil " *SL*" nil | 111 | nil " *SL*" nil |
| 109 | :global t | 112 | :global t |
| 110 | :group 'windows | 113 | :group 'windows |
diff --git a/lisp/scroll-bar.el b/lisp/scroll-bar.el index 0c68bca4d2e..37a31460cdb 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." | |||
| 114 | 114 | ||
| 115 | (defun get-scroll-bar-mode () scroll-bar-mode) | 115 | (defun get-scroll-bar-mode () scroll-bar-mode) |
| 116 | (defsetf get-scroll-bar-mode set-scroll-bar-mode) | 116 | (defsetf get-scroll-bar-mode set-scroll-bar-mode) |
| 117 | |||
| 117 | (define-minor-mode scroll-bar-mode | 118 | (define-minor-mode scroll-bar-mode |
| 118 | "Toggle display of vertical scroll bars on all frames. | 119 | "Toggle vertical scroll bars on all frames (Scroll Bar mode). |
| 120 | With a prefix argument ARG, enable Scroll Bar mode if ARG is | ||
| 121 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 122 | the mode if ARG is omitted or nil. | ||
| 123 | |||
| 119 | This command applies to all frames that exist and frames to be | 124 | This command applies to all frames that exist and frames to be |
| 120 | created in the future. | 125 | created in the future." |
| 121 | With a numeric argument, if the argument is positive | ||
| 122 | turn on scroll bars; otherwise turn off scroll bars." | ||
| 123 | :variable (eq (get-scroll-bar-mode) | 126 | :variable (eq (get-scroll-bar-mode) |
| 124 | (or previous-scroll-bar-mode | 127 | (or previous-scroll-bar-mode |
| 125 | default-frame-scroll-bars))) | 128 | default-frame-scroll-bars))) |
diff --git a/lisp/server.el b/lisp/server.el index 63d46a365c9..bc989c55ed1 100644 --- a/lisp/server.el +++ b/lisp/server.el | |||
| @@ -669,9 +669,13 @@ Return values: | |||
| 669 | ;;;###autoload | 669 | ;;;###autoload |
| 670 | (define-minor-mode server-mode | 670 | (define-minor-mode server-mode |
| 671 | "Toggle Server mode. | 671 | "Toggle Server mode. |
| 672 | With ARG, turn Server mode on if ARG is positive, off otherwise. | 672 | With a prefix argument ARG, enable Server mode if ARG is |
| 673 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 674 | Server mode if ARG is omitted or nil. | ||
| 675 | |||
| 673 | Server mode runs a process that accepts commands from the | 676 | Server mode runs a process that accepts commands from the |
| 674 | `emacsclient' program. See `server-start' and Info node `Emacs server'." | 677 | `emacsclient' program. See Info node `Emacs server' and |
| 678 | `server-start' for details." | ||
| 675 | :global t | 679 | :global t |
| 676 | :group 'server | 680 | :group 'server |
| 677 | :version "22.1" | 681 | :version "22.1" |
diff --git a/lisp/shell.el b/lisp/shell.el index cefe42bb3ec..c75594ddbe4 100644 --- a/lisp/shell.el +++ b/lisp/shell.el | |||
| @@ -890,9 +890,13 @@ Environment variables are expanded, see function `substitute-in-file-name'." | |||
| 890 | 890 | ||
| 891 | (defvaralias 'shell-dirtrack-mode 'shell-dirtrackp) | 891 | (defvaralias 'shell-dirtrack-mode 'shell-dirtrackp) |
| 892 | (define-minor-mode shell-dirtrack-mode | 892 | (define-minor-mode shell-dirtrack-mode |
| 893 | "Turn directory tracking on and off in a shell buffer. | 893 | "Toggle directory tracking in this shell buffer (Shell Dirtrack mode). |
| 894 | The `dirtrack' package provides an alternative implementation of this | 894 | With a prefix argument ARG, enable Shell Dirtrack mode if ARG is |
| 895 | feature - see the function `dirtrack-mode'." | 895 | positive, and disable it otherwise. If called from Lisp, enable |
| 896 | the mode if ARG is omitted or nil. | ||
| 897 | |||
| 898 | The `dirtrack' package provides an alternative implementation of | ||
| 899 | this feature; see the function `dirtrack-mode'." | ||
| 896 | nil nil nil | 900 | nil nil nil |
| 897 | (setq list-buffers-directory (if shell-dirtrack-mode default-directory)) | 901 | (setq list-buffers-directory (if shell-dirtrack-mode default-directory)) |
| 898 | (if shell-dirtrack-mode | 902 | (if shell-dirtrack-mode |
diff --git a/lisp/simple.el b/lisp/simple.el index 6d0e7543549..79de6aea3dd 100644 --- a/lisp/simple.el +++ b/lisp/simple.el | |||
| @@ -4086,13 +4086,15 @@ its earlier value." | |||
| 4086 | 4086 | ||
| 4087 | (define-minor-mode transient-mark-mode | 4087 | (define-minor-mode transient-mark-mode |
| 4088 | "Toggle Transient Mark mode. | 4088 | "Toggle Transient Mark mode. |
| 4089 | With ARG, turn Transient Mark mode on if ARG is positive, off otherwise. | 4089 | With a prefix argument ARG, enable Transient Mark mode if ARG is |
| 4090 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 4091 | Transient Mark mode if ARG is omitted or nil. | ||
| 4090 | 4092 | ||
| 4091 | In Transient Mark mode, when the mark is active, the region is highlighted. | 4093 | Transient Mark mode is a global minor mode. When enabled, the |
| 4092 | Changing the buffer \"deactivates\" the mark. | 4094 | region is highlighted whenever the mark is active. The mark is |
| 4093 | So do certain other operations that set the mark | 4095 | \"deactivated\" by changing the buffer, and after certain other |
| 4094 | but whose main purpose is something else--for example, | 4096 | operations that set the mark but whose main purpose is something |
| 4095 | incremental search, \\[beginning-of-buffer], and \\[end-of-buffer]. | 4097 | else--for example, incremental search, \\[beginning-of-buffer], and \\[end-of-buffer]. |
| 4096 | 4098 | ||
| 4097 | You can also deactivate the mark by typing \\[keyboard-quit] or | 4099 | You can also deactivate the mark by typing \\[keyboard-quit] or |
| 4098 | \\[keyboard-escape-quit]. | 4100 | \\[keyboard-escape-quit]. |
| @@ -4906,8 +4908,15 @@ other purposes." | |||
| 4906 | (defvar visual-line--saved-state nil) | 4908 | (defvar visual-line--saved-state nil) |
| 4907 | 4909 | ||
| 4908 | (define-minor-mode visual-line-mode | 4910 | (define-minor-mode visual-line-mode |
| 4909 | "Redefine simple editing commands to act on visual lines, not logical lines. | 4911 | "Toggle visual line based editing (Visual Line mode). |
| 4910 | This also turns on `word-wrap' in the buffer." | 4912 | With a prefix argument ARG, enable Visual Line mode if ARG is |
| 4913 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 4914 | the mode if ARG is omitted or nil. | ||
| 4915 | |||
| 4916 | When Visual Line mode is enabled, `word-wrap' is turned on in | ||
| 4917 | this buffer, and simple editing commands are redefined to act on | ||
| 4918 | visual lines, not logical lines. See Info node `Visual Line | ||
| 4919 | Mode' for details." | ||
| 4911 | :keymap visual-line-mode-map | 4920 | :keymap visual-line-mode-map |
| 4912 | :group 'visual-line | 4921 | :group 'visual-line |
| 4913 | :lighter " Wrap" | 4922 | :lighter " Wrap" |
| @@ -5301,10 +5310,14 @@ Some major modes set this.") | |||
| 5301 | (put 'auto-fill-function 'safe-local-variable 'null) | 5310 | (put 'auto-fill-function 'safe-local-variable 'null) |
| 5302 | 5311 | ||
| 5303 | (define-minor-mode auto-fill-mode | 5312 | (define-minor-mode auto-fill-mode |
| 5304 | "Toggle Auto Fill mode. | 5313 | "Toggle automatic line breaking (Auto Fill mode). |
| 5305 | With ARG, turn Auto Fill mode on if and only if ARG is positive. | 5314 | With a prefix argument ARG, enable Auto Fill mode if ARG is |
| 5306 | In Auto Fill mode, inserting a space at a column beyond `current-fill-column' | 5315 | positive, and disable it otherwise. If called from Lisp, enable |
| 5307 | automatically breaks the line at a previous space. | 5316 | the mode if ARG is omitted or nil. |
| 5317 | |||
| 5318 | When Auto Fill mode is enabled, inserting a space at a column | ||
| 5319 | beyond `current-fill-column' automatically breaks the line at a | ||
| 5320 | previous space. | ||
| 5308 | 5321 | ||
| 5309 | When `auto-fill-mode' is on, the `auto-fill-function' variable is | 5322 | When `auto-fill-mode' is on, the `auto-fill-function' variable is |
| 5310 | non-`nil'. | 5323 | non-`nil'. |
| @@ -5412,36 +5425,44 @@ if long lines are truncated." | |||
| 5412 | "The string displayed in the mode line when in binary overwrite mode.") | 5425 | "The string displayed in the mode line when in binary overwrite mode.") |
| 5413 | 5426 | ||
| 5414 | (define-minor-mode overwrite-mode | 5427 | (define-minor-mode overwrite-mode |
| 5415 | "Toggle overwrite mode. | 5428 | "Toggle Overwrite mode. |
| 5416 | With prefix argument ARG, turn overwrite mode on if ARG is positive, | 5429 | With a prefix argument ARG, enable Overwrite mode if ARG is |
| 5417 | otherwise turn it off. In overwrite mode, printing characters typed | 5430 | positive, and disable it otherwise. If called from Lisp, enable |
| 5418 | in replace existing text on a one-for-one basis, rather than pushing | 5431 | the mode if ARG is omitted or nil. |
| 5419 | it to the right. At the end of a line, such characters extend the line. | 5432 | |
| 5420 | Before a tab, such characters insert until the tab is filled in. | 5433 | When Overwrite mode is enabled, printing characters typed in |
| 5421 | \\[quoted-insert] still inserts characters in overwrite mode; this | 5434 | replace existing text on a one-for-one basis, rather than pushing |
| 5422 | is supposed to make it easier to insert characters when necessary." | 5435 | it to the right. At the end of a line, such characters extend |
| 5436 | the line. Before a tab, such characters insert until the tab is | ||
| 5437 | filled in. \\[quoted-insert] still inserts characters in | ||
| 5438 | overwrite mode; this is supposed to make it easier to insert | ||
| 5439 | characters when necessary." | ||
| 5423 | :variable (eq overwrite-mode 'overwrite-mode-textual)) | 5440 | :variable (eq overwrite-mode 'overwrite-mode-textual)) |
| 5424 | 5441 | ||
| 5425 | (define-minor-mode binary-overwrite-mode | 5442 | (define-minor-mode binary-overwrite-mode |
| 5426 | "Toggle binary overwrite mode. | 5443 | "Toggle Binary Overwrite mode. |
| 5427 | With prefix argument ARG, turn binary overwrite mode on if ARG is | 5444 | With a prefix argument ARG, enable Binary Overwrite mode if ARG |
| 5428 | positive, otherwise turn it off. In binary overwrite mode, printing | 5445 | is positive, and disable it otherwise. If called from Lisp, |
| 5429 | characters typed in replace existing text. Newlines are not treated | 5446 | enable the mode if ARG is omitted or nil. |
| 5430 | specially, so typing at the end of a line joins the line to the next, | 5447 | |
| 5431 | with the typed character between them. Typing before a tab character | 5448 | When Binary Overwrite mode is enabled, printing characters typed |
| 5432 | simply replaces the tab with the character typed. \\[quoted-insert] | 5449 | in replace existing text. Newlines are not treated specially, so |
| 5433 | replaces the text at the cursor, just as ordinary typing characters do. | 5450 | typing at the end of a line joins the line to the next, with the |
| 5434 | 5451 | typed character between them. Typing before a tab character | |
| 5435 | Note that binary overwrite mode is not its own minor mode; it is a | 5452 | simply replaces the tab with the character typed. |
| 5436 | specialization of overwrite mode, entered by setting the | 5453 | \\[quoted-insert] replaces the text at the cursor, just as |
| 5454 | ordinary typing characters do. | ||
| 5455 | |||
| 5456 | Note that Binary Overwrite mode is not its own minor mode; it is | ||
| 5457 | a specialization of overwrite mode, entered by setting the | ||
| 5437 | `overwrite-mode' variable to `overwrite-mode-binary'." | 5458 | `overwrite-mode' variable to `overwrite-mode-binary'." |
| 5438 | :variable (eq overwrite-mode 'overwrite-mode-binary)) | 5459 | :variable (eq overwrite-mode 'overwrite-mode-binary)) |
| 5439 | 5460 | ||
| 5440 | (define-minor-mode line-number-mode | 5461 | (define-minor-mode line-number-mode |
| 5441 | "Toggle Line Number mode. | 5462 | "Toggle line number display in the mode line (Line Number mode). |
| 5442 | With ARG, turn Line Number mode on if ARG is positive, otherwise | 5463 | With a prefix argument ARG, enable Line Number mode if ARG is |
| 5443 | turn it off. When Line Number mode is enabled, the line number | 5464 | positive, and disable it otherwise. If called from Lisp, enable |
| 5444 | appears in the mode line. | 5465 | the mode if ARG is omitted or nil. |
| 5445 | 5466 | ||
| 5446 | Line numbers do not appear for very large buffers and buffers | 5467 | Line numbers do not appear for very large buffers and buffers |
| 5447 | with very long lines; see variables `line-number-display-limit' | 5468 | with very long lines; see variables `line-number-display-limit' |
| @@ -5449,22 +5470,27 @@ and `line-number-display-limit-width'." | |||
| 5449 | :init-value t :global t :group 'mode-line) | 5470 | :init-value t :global t :group 'mode-line) |
| 5450 | 5471 | ||
| 5451 | (define-minor-mode column-number-mode | 5472 | (define-minor-mode column-number-mode |
| 5452 | "Toggle Column Number mode. | 5473 | "Toggle column number display in the mode line (Column Number mode). |
| 5453 | With ARG, turn Column Number mode on if ARG is positive, | 5474 | With a prefix argument ARG, enable Column Number mode if ARG is |
| 5454 | otherwise turn it off. When Column Number mode is enabled, the | 5475 | positive, and disable it otherwise. |
| 5455 | column number appears in the mode line." | 5476 | |
| 5477 | If called from Lisp, enable the mode if ARG is omitted or nil." | ||
| 5456 | :global t :group 'mode-line) | 5478 | :global t :group 'mode-line) |
| 5457 | 5479 | ||
| 5458 | (define-minor-mode size-indication-mode | 5480 | (define-minor-mode size-indication-mode |
| 5459 | "Toggle Size Indication mode. | 5481 | "Toggle buffer size display in the mode line (Size Indication mode). |
| 5460 | With ARG, turn Size Indication mode on if ARG is positive, | 5482 | With a prefix argument ARG, enable Size Indication mode if ARG is |
| 5461 | otherwise turn it off. When Size Indication mode is enabled, the | 5483 | positive, and disable it otherwise. |
| 5462 | size of the accessible part of the buffer appears in the mode line." | 5484 | |
| 5485 | If called from Lisp, enable the mode if ARG is omitted or nil." | ||
| 5463 | :global t :group 'mode-line) | 5486 | :global t :group 'mode-line) |
| 5464 | 5487 | ||
| 5465 | (define-minor-mode auto-save-mode | 5488 | (define-minor-mode auto-save-mode |
| 5466 | "Toggle auto-saving of contents of current buffer. | 5489 | "Toggle auto-saving in the current buffer (Auto Save mode). |
| 5467 | With prefix argument ARG, turn auto-saving on if positive, else off." | 5490 | With a prefix argument ARG, enable Auto Save mode if ARG is |
| 5491 | positive, and disable it otherwise. | ||
| 5492 | |||
| 5493 | If called from Lisp, enable the mode if ARG is omitted or nil." | ||
| 5468 | :variable ((and buffer-auto-save-file-name | 5494 | :variable ((and buffer-auto-save-file-name |
| 5469 | ;; If auto-save is off because buffer has shrunk, | 5495 | ;; If auto-save is off because buffer has shrunk, |
| 5470 | ;; then toggling should turn it on. | 5496 | ;; then toggling should turn it on. |
| @@ -6634,8 +6660,9 @@ call `normal-erase-is-backspace-mode' (which see) instead." | |||
| 6634 | 6660 | ||
| 6635 | (define-minor-mode normal-erase-is-backspace-mode | 6661 | (define-minor-mode normal-erase-is-backspace-mode |
| 6636 | "Toggle the Erase and Delete mode of the Backspace and Delete keys. | 6662 | "Toggle the Erase and Delete mode of the Backspace and Delete keys. |
| 6637 | 6663 | With a prefix argument ARG, enable this feature if ARG is | |
| 6638 | With numeric ARG, turn the mode on if and only if ARG is positive. | 6664 | positive, and disable it otherwise. If called from Lisp, enable |
| 6665 | the mode if ARG is omitted or nil. | ||
| 6639 | 6666 | ||
| 6640 | On window systems, when this mode is on, Delete is mapped to C-d | 6667 | On window systems, when this mode is on, Delete is mapped to C-d |
| 6641 | and Backspace is mapped to DEL; when this mode is off, both | 6668 | and Backspace is mapped to DEL; when this mode is off, both |
| @@ -6709,13 +6736,13 @@ See also `normal-erase-is-backspace'." | |||
| 6709 | "Saved value of `buffer-invisibility-spec' when Visible mode is on.") | 6736 | "Saved value of `buffer-invisibility-spec' when Visible mode is on.") |
| 6710 | 6737 | ||
| 6711 | (define-minor-mode visible-mode | 6738 | (define-minor-mode visible-mode |
| 6712 | "Toggle Visible mode. | 6739 | "Toggle making all invisible text temporarily visible (Visible mode). |
| 6713 | With argument ARG turn Visible mode on if ARG is positive, otherwise | 6740 | With a prefix argument ARG, enable Visible mode if ARG is |
| 6714 | turn it off. | 6741 | positive, and disable it otherwise. If called from Lisp, enable |
| 6742 | the mode if ARG is omitted or nil. | ||
| 6715 | 6743 | ||
| 6716 | Enabling Visible mode makes all invisible text temporarily visible. | 6744 | This mode works by saving the value of `buffer-invisibility-spec' |
| 6717 | Disabling Visible mode turns off that effect. Visible mode works by | 6745 | and setting it to nil." |
| 6718 | saving the value of `buffer-invisibility-spec' and setting it to nil." | ||
| 6719 | :lighter " Vis" | 6746 | :lighter " Vis" |
| 6720 | :group 'editing-basics | 6747 | :group 'editing-basics |
| 6721 | (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec) | 6748 | (when (local-variable-p 'vis-mode-saved-buffer-invisibility-spec) |
diff --git a/lisp/strokes.el b/lisp/strokes.el index ca0086b3b97..5ff94bb22c6 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." | |||
| 1386 | 1386 | ||
| 1387 | ;;;###autoload | 1387 | ;;;###autoload |
| 1388 | (define-minor-mode strokes-mode | 1388 | (define-minor-mode strokes-mode |
| 1389 | "Toggle Strokes global minor mode.\\<strokes-mode-map> | 1389 | "Toggle Strokes mode, a global minor mode. |
| 1390 | With ARG, turn strokes on if and only if ARG is positive. | 1390 | With a prefix argument ARG, enable Strokes mode if ARG is |
| 1391 | positive, and disable it otherwise. If called from Lisp, enable | ||
| 1392 | the mode if ARG is omitted or nil. | ||
| 1393 | |||
| 1394 | \\<strokes-mode-map> | ||
| 1391 | Strokes are pictographic mouse gestures which invoke commands. | 1395 | Strokes are pictographic mouse gestures which invoke commands. |
| 1392 | Strokes are invoked with \\[strokes-do-stroke]. You can define | 1396 | Strokes are invoked with \\[strokes-do-stroke]. You can define |
| 1393 | new strokes with \\[strokes-global-set-stroke]. See also | 1397 | new strokes with \\[strokes-global-set-stroke]. See also |
diff --git a/lisp/t-mouse.el b/lisp/t-mouse.el index 059024c4bce..78857b04143 100644 --- a/lisp/t-mouse.el +++ b/lisp/t-mouse.el | |||
| @@ -33,7 +33,7 @@ | |||
| 33 | ;; mev. Now the interface with gpm is directly through a Unix socket, so this | 33 | ;; mev. Now the interface with gpm is directly through a Unix socket, so this |
| 34 | ;; file is reduced to a single minor mode macro call. | 34 | ;; file is reduced to a single minor mode macro call. |
| 35 | 35 | ||
| 36 | ;; | 36 | ;; |
| 37 | 37 | ||
| 38 | ;;; Code: | 38 | ;;; Code: |
| 39 | 39 | ||
| @@ -65,9 +65,10 @@ | |||
| 65 | (define-obsolete-function-alias 't-mouse-mode 'gpm-mouse-mode "23.1") | 65 | (define-obsolete-function-alias 't-mouse-mode 'gpm-mouse-mode "23.1") |
| 66 | ;;;###autoload | 66 | ;;;###autoload |
| 67 | (define-minor-mode gpm-mouse-mode | 67 | (define-minor-mode gpm-mouse-mode |
| 68 | "Toggle gpm-mouse mode to use the mouse in GNU/Linux consoles. | 68 | "Toggle mouse support in GNU/Linux consoles (GPM Mouse mode). |
| 69 | With prefix arg, turn gpm-mouse mode on if arg is positive, | 69 | With a prefix argument ARG, enable GPM Mouse mode if ARG is |
| 70 | otherwise turn it off. | 70 | positive, and disable it otherwise. If called from Lisp, enable |
| 71 | the mode if ARG is omitted or nil. | ||
| 71 | 72 | ||
| 72 | This allows the use of the mouse when operating on a GNU/Linux console, | 73 | This allows the use of the mouse when operating on a GNU/Linux console, |
| 73 | in the same way as you can use the mouse under X11. | 74 | in the same way as you can use the mouse under X11. |
diff --git a/lisp/time.el b/lisp/time.el index f8fea0c64a2..ac4a011bdf8 100644 --- a/lisp/time.el +++ b/lisp/time.el | |||
| @@ -484,14 +484,15 @@ update which can wait for the next redisplay." | |||
| 484 | ;;;###autoload | 484 | ;;;###autoload |
| 485 | (define-minor-mode display-time-mode | 485 | (define-minor-mode display-time-mode |
| 486 | "Toggle display of time, load level, and mail flag in mode lines. | 486 | "Toggle display of time, load level, and mail flag in mode lines. |
| 487 | With a numeric arg, enable this display if arg is positive. | 487 | With a prefix argument ARG, enable Display Time mode if ARG is |
| 488 | 488 | positive, and disable it otherwise. If called from Lisp, enable | |
| 489 | When this display is enabled, it updates automatically every minute | 489 | it if ARG is omitted or nil. |
| 490 | \(you can control the number of seconds between updates by | 490 | |
| 491 | customizing `display-time-interval'). | 491 | When Display Time mode is enabled, it updates every minute (you |
| 492 | If `display-time-day-and-date' is non-nil, the current day and date | 492 | can control the number of seconds between updates by customizing |
| 493 | are displayed as well. | 493 | `display-time-interval'). If `display-time-day-and-date' is |
| 494 | This runs the normal hook `display-time-hook' after each update." | 494 | non-nil, the current day and date are displayed as well. This |
| 495 | runs the normal hook `display-time-hook' after each update." | ||
| 495 | :global t :group 'display-time | 496 | :global t :group 'display-time |
| 496 | (and display-time-timer (cancel-timer display-time-timer)) | 497 | (and display-time-timer (cancel-timer display-time-timer)) |
| 497 | (setq display-time-timer nil) | 498 | (setq display-time-timer nil) |
diff --git a/lisp/tool-bar.el b/lisp/tool-bar.el index 05208abb720..8759e0f77fb 100644 --- a/lisp/tool-bar.el +++ b/lisp/tool-bar.el | |||
| @@ -43,9 +43,10 @@ | |||
| 43 | ;; Deleting it means invoking this command won't work | 43 | ;; Deleting it means invoking this command won't work |
| 44 | ;; when you are on a tty. I hope that won't cause too much trouble -- rms. | 44 | ;; when you are on a tty. I hope that won't cause too much trouble -- rms. |
| 45 | (define-minor-mode tool-bar-mode | 45 | (define-minor-mode tool-bar-mode |
| 46 | "Toggle use of the tool bar. | 46 | "Toggle the tool bar in all graphical frames (Tool Bar mode). |
| 47 | With a numeric argument, if the argument is positive, turn on the | 47 | With a prefix argument ARG, enable Tool Bar mode if ARG is |
| 48 | tool bar; otherwise, turn off the tool bar. | 48 | positive, and disable it otherwise. If called from Lisp, enable |
| 49 | Tool Bar mode if ARG is omitted or nil. | ||
| 49 | 50 | ||
| 50 | See `tool-bar-add-item' and `tool-bar-add-item-from-menu' for | 51 | See `tool-bar-add-item' and `tool-bar-add-item-from-menu' for |
| 51 | conveniently adding tool bar items." | 52 | conveniently adding tool bar items." |
diff --git a/lisp/tooltip.el b/lisp/tooltip.el index bfe53dc71b7..59115122c34 100644 --- a/lisp/tooltip.el +++ b/lisp/tooltip.el | |||
| @@ -39,11 +39,14 @@ | |||
| 39 | ;;; Switching tooltips on/off | 39 | ;;; Switching tooltips on/off |
| 40 | 40 | ||
| 41 | (define-minor-mode tooltip-mode | 41 | (define-minor-mode tooltip-mode |
| 42 | "Toggle Tooltip mode. | 42 | "Toggle use of graphical tooltips (Tooltip mode). |
| 43 | With ARG, turn Tooltip mode on if and only if ARG is positive. | 43 | With a prefix argument ARG, enable Tooltip mode if ARG is |
| 44 | When this minor mode is enabled, Emacs displays help text | 44 | positive, and disable it otherwise. If called from Lisp, enable |
| 45 | in a pop-up window for buttons and menu items that you put the mouse on. | 45 | it if ARG is omitted or nil. |
| 46 | \(However, if `tooltip-use-echo-area' is non-nil, this and | 46 | |
| 47 | When Tooltip mode is enabled, Emacs displays help text in a | ||
| 48 | pop-up window for buttons and menu items that you put the mouse | ||
| 49 | on. \(However, if `tooltip-use-echo-area' is non-nil, this and | ||
| 47 | all pop-up help appears in the echo area.) | 50 | all pop-up help appears in the echo area.) |
| 48 | 51 | ||
| 49 | When Tooltip mode is disabled, Emacs displays one line of | 52 | When Tooltip mode is disabled, Emacs displays one line of |
diff --git a/lisp/type-break.el b/lisp/type-break.el index d276e64f6db..da3129ec576 100644 --- a/lisp/type-break.el +++ b/lisp/type-break.el | |||
| @@ -431,13 +431,13 @@ problems." | |||
| 431 | type-break-mode) | 431 | type-break-mode) |
| 432 | 432 | ||
| 433 | (define-minor-mode type-break-mode-line-message-mode | 433 | (define-minor-mode type-break-mode-line-message-mode |
| 434 | "Enable or disable warnings in the mode line about typing breaks. | 434 | "Toggle warnings about typing breaks in the mode line. |
| 435 | With a prefix argument ARG, enable these warnings if ARG is | ||
| 436 | positive, and disable them otherwise. If called from Lisp, | ||
| 437 | enable them if ARG is omitted or nil. | ||
| 435 | 438 | ||
| 436 | A negative PREFIX argument disables this mode. | 439 | The user may also enable or disable this mode simply by setting |
| 437 | No argument or any non-negative argument enables it. | 440 | the variable of the same name. |
| 438 | |||
| 439 | The user may also enable or disable this mode simply by setting the | ||
| 440 | variable of the same name. | ||
| 441 | 441 | ||
| 442 | Variables controlling the display of messages in the mode line include: | 442 | Variables controlling the display of messages in the mode line include: |
| 443 | 443 | ||
| @@ -448,17 +448,13 @@ Variables controlling the display of messages in the mode line include: | |||
| 448 | :global t) | 448 | :global t) |
| 449 | 449 | ||
| 450 | (define-minor-mode type-break-query-mode | 450 | (define-minor-mode type-break-query-mode |
| 451 | "Enable or disable warnings in the mode line about typing breaks. | 451 | "Toggle typing break queries. |
| 452 | 452 | With a prefix argument ARG, enable these queries if ARG is | |
| 453 | When enabled, the user is periodically queried about whether to take a | 453 | positive, and disable them otherwise. If called from Lisp, |
| 454 | typing break at that moment. The function which does this query is | 454 | enable them if ARG is omitted or nil. |
| 455 | specified by the variable `type-break-query-function'. | ||
| 456 | |||
| 457 | A negative PREFIX argument disables this mode. | ||
| 458 | No argument or any non-negative argument enables it. | ||
| 459 | 455 | ||
| 460 | The user may also enable or disable this mode simply by setting the | 456 | The user may also enable or disable this mode simply by setting |
| 461 | variable of the same name." | 457 | the variable of the same name." |
| 462 | :global t) | 458 | :global t) |
| 463 | 459 | ||
| 464 | 460 | ||
diff --git a/lisp/view.el b/lisp/view.el index 11cbc79449f..ef865007332 100644 --- a/lisp/view.el +++ b/lisp/view.el | |||
| @@ -369,19 +369,24 @@ this argument instead of explicitly setting `view-exit-action'." | |||
| 369 | ;; bindings instead of using the \\[] construction. The reason for this | 369 | ;; bindings instead of using the \\[] construction. The reason for this |
| 370 | ;; is that most commands have more than one key binding. | 370 | ;; is that most commands have more than one key binding. |
| 371 | "Toggle View mode, a minor mode for viewing text but not editing it. | 371 | "Toggle View mode, a minor mode for viewing text but not editing it. |
| 372 | With prefix argument ARG, turn View mode on if ARG is positive, otherwise | 372 | With a prefix argument ARG, enable View mode if ARG is positive, |
| 373 | turn it off. | 373 | and disable it otherwise. If called from Lisp, enable View mode |
| 374 | if ARG is omitted or nil. | ||
| 375 | |||
| 376 | When View mode is enabled, commands that do not change the buffer | ||
| 377 | contents are available as usual. Kill commands insert text in | ||
| 378 | kill buffers but do not delete. Most other commands beep and | ||
| 379 | tell the user that the buffer is read-only. | ||
| 374 | 380 | ||
| 375 | Emacs commands that do not change the buffer contents are available as usual. | ||
| 376 | Kill commands insert text in kill buffers but do not delete. Other commands | ||
| 377 | \(among them most letters and punctuation) beep and tell that the buffer is | ||
| 378 | read-only. | ||
| 379 | \\<view-mode-map> | 381 | \\<view-mode-map> |
| 380 | The following additional commands are provided. Most commands take prefix | 382 | |
| 381 | arguments. Page commands default to \"page size\" lines which is almost a whole | 383 | The following additional commands are provided. Most commands |
| 382 | 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 | 384 | take prefix arguments. Page commands default to \"page size\" |
| 383 | and set \"half page size\" lines which initially is half a window full. Search | 385 | lines which is almost a whole window, or number of lines set by |
| 384 | commands default to a repeat count of one. | 386 | \\[View-scroll-page-forward-set-page-size] or \\[View-scroll-page-backward-set-page-size]. |
| 387 | Half page commands default to and set \"half page size\" lines | ||
| 388 | which initially is half a window full. Search commands default | ||
| 389 | to a repeat count of one. | ||
| 385 | 390 | ||
| 386 | H, h, ? This message. | 391 | H, h, ? This message. |
| 387 | Digits provide prefix arguments. | 392 | Digits provide prefix arguments. |
diff --git a/lisp/whitespace.el b/lisp/whitespace.el index e0bc74343d2..8dc1996734d 100644 --- a/lisp/whitespace.el +++ b/lisp/whitespace.el | |||
| @@ -1064,11 +1064,10 @@ Any other value is treated as nil." | |||
| 1064 | 1064 | ||
| 1065 | ;;;###autoload | 1065 | ;;;###autoload |
| 1066 | (define-minor-mode whitespace-mode | 1066 | (define-minor-mode whitespace-mode |
| 1067 | "Toggle whitespace minor mode visualization (\"ws\" on modeline). | 1067 | "Toggle whitespace visualization (Whitespace mode). |
| 1068 | 1068 | With a prefix argument ARG, enable Whitespace mode if ARG is | |
| 1069 | If ARG is null, toggle whitespace visualization. | 1069 | positive, and disable it otherwise. If called from Lisp, enable |
| 1070 | If ARG is a number greater than zero, turn on visualization; | 1070 | the mode if ARG is omitted or nil. |
| 1071 | otherwise, turn off visualization. | ||
| 1072 | 1071 | ||
| 1073 | See also `whitespace-style', `whitespace-newline' and | 1072 | See also `whitespace-style', `whitespace-newline' and |
| 1074 | `whitespace-display-mappings'." | 1073 | `whitespace-display-mappings'." |
| @@ -1088,11 +1087,10 @@ See also `whitespace-style', `whitespace-newline' and | |||
| 1088 | 1087 | ||
| 1089 | ;;;###autoload | 1088 | ;;;###autoload |
| 1090 | (define-minor-mode whitespace-newline-mode | 1089 | (define-minor-mode whitespace-newline-mode |
| 1091 | "Toggle NEWLINE minor mode visualization (\"nl\" on modeline). | 1090 | "Toggle newline visualization (Whitespace Newline mode). |
| 1092 | 1091 | With a prefix argument ARG, enable Whitespace Newline mode if ARG | |
| 1093 | If ARG is null, toggle NEWLINE visualization. | 1092 | is positive, and disable it otherwise. If called from Lisp, |
| 1094 | If ARG is a number greater than zero, turn on visualization; | 1093 | enable the mode if ARG is omitted or nil. |
| 1095 | otherwise, turn off visualization. | ||
| 1096 | 1094 | ||
| 1097 | Use `whitespace-newline-mode' only for NEWLINE visualization | 1095 | Use `whitespace-newline-mode' only for NEWLINE visualization |
| 1098 | exclusively. For other visualizations, including NEWLINE | 1096 | exclusively. For other visualizations, including NEWLINE |
| @@ -1116,11 +1114,10 @@ See also `whitespace-newline' and `whitespace-display-mappings'." | |||
| 1116 | 1114 | ||
| 1117 | ;;;###autoload | 1115 | ;;;###autoload |
| 1118 | (define-minor-mode global-whitespace-mode | 1116 | (define-minor-mode global-whitespace-mode |
| 1119 | "Toggle whitespace global minor mode visualization (\"WS\" on modeline). | 1117 | "Toggle whitespace visualization globally (Global Whitespace mode). |
| 1120 | 1118 | With a prefix argument ARG, enable Global Whitespace mode if ARG | |
| 1121 | If ARG is null, toggle whitespace visualization. | 1119 | is positive, and disable it otherwise. If called from Lisp, |
| 1122 | If ARG is a number greater than zero, turn on visualization; | 1120 | enable it if ARG is omitted or nil. |
| 1123 | otherwise, turn off visualization. | ||
| 1124 | 1121 | ||
| 1125 | See also `whitespace-style', `whitespace-newline' and | 1122 | See also `whitespace-style', `whitespace-newline' and |
| 1126 | `whitespace-display-mappings'." | 1123 | `whitespace-display-mappings'." |
| @@ -1174,11 +1171,10 @@ See also `whitespace-style', `whitespace-newline' and | |||
| 1174 | 1171 | ||
| 1175 | ;;;###autoload | 1172 | ;;;###autoload |
| 1176 | (define-minor-mode global-whitespace-newline-mode | 1173 | (define-minor-mode global-whitespace-newline-mode |
| 1177 | "Toggle NEWLINE global minor mode visualization (\"NL\" on modeline). | 1174 | "Toggle global newline visualization (Global Whitespace Newline mode). |
| 1178 | 1175 | With a prefix argument ARG, enable Global Whitespace Newline mode | |
| 1179 | If ARG is null, toggle NEWLINE visualization. | 1176 | if ARG is positive, and disable it otherwise. If called from |
| 1180 | If ARG is a number greater than zero, turn on visualization; | 1177 | Lisp, enable it if ARG is omitted or nil. |
| 1181 | otherwise, turn off visualization. | ||
| 1182 | 1178 | ||
| 1183 | Use `global-whitespace-newline-mode' only for NEWLINE | 1179 | Use `global-whitespace-newline-mode' only for NEWLINE |
| 1184 | visualization exclusively. For other visualizations, including | 1180 | visualization exclusively. For other visualizations, including |
diff --git a/lisp/wid-browse.el b/lisp/wid-browse.el index b765e46b9c6..7ca13baeb53 100644 --- a/lisp/wid-browse.el +++ b/lisp/wid-browse.el | |||
| @@ -270,8 +270,7 @@ VALUE is assumed to be a list of widgets." | |||
| 270 | 270 | ||
| 271 | ;;;###autoload | 271 | ;;;###autoload |
| 272 | (define-minor-mode widget-minor-mode | 272 | (define-minor-mode widget-minor-mode |
| 273 | "Togle minor mode for traversing widgets. | 273 | "Minor mode for traversing widgets." |
| 274 | With arg, turn widget mode on if and only if arg is positive." | ||
| 275 | :lighter " Widget") | 274 | :lighter " Widget") |
| 276 | 275 | ||
| 277 | ;;; The End: | 276 | ;;; The End: |
diff --git a/lisp/xt-mouse.el b/lisp/xt-mouse.el index eca5f813ca2..09b2a7b88bd 100644 --- a/lisp/xt-mouse.el +++ b/lisp/xt-mouse.el | |||
| @@ -199,8 +199,9 @@ | |||
| 199 | ;;;###autoload | 199 | ;;;###autoload |
| 200 | (define-minor-mode xterm-mouse-mode | 200 | (define-minor-mode xterm-mouse-mode |
| 201 | "Toggle XTerm mouse mode. | 201 | "Toggle XTerm mouse mode. |
| 202 | With prefix arg, turn XTerm mouse mode on if arg is positive, otherwise turn | 202 | With a prefix argument ARG, enable XTerm mouse mode if ARG is |
| 203 | it off. | 203 | positive, and disable it otherwise. If called from Lisp, enable |
| 204 | the mode if ARG is omitted or nil. | ||
| 204 | 205 | ||
| 205 | Turn it on to use Emacs mouse commands, and off to use xterm mouse commands. | 206 | Turn it on to use Emacs mouse commands, and off to use xterm mouse commands. |
| 206 | This works in terminal emulators compatible with xterm. It only | 207 | This works in terminal emulators compatible with xterm. It only |