mirror of
git://git.sv.gnu.org/emacs.git
synced 2025-12-06 22:41:06 -08:00
Improve bind-keys* and override-global-mode docstrings
* lisp/use-package/bind-key.el (bind-keys*): Add docstring. (override-global-mode) Improve docstring.
This commit is contained in:
parent
537f11f8cd
commit
888558ec42
1 changed files with 17 additions and 1 deletions
|
|
@ -128,7 +128,18 @@
|
||||||
"Keymap for `override-global-mode'.")
|
"Keymap for `override-global-mode'.")
|
||||||
|
|
||||||
(define-minor-mode override-global-mode
|
(define-minor-mode override-global-mode
|
||||||
"A minor mode so that keymap settings override other modes."
|
"A minor mode for allowing keybindings to override other modes.
|
||||||
|
The main purpose of this mode is to simplify bindings keys in
|
||||||
|
such a way that they take precedence over other modes.
|
||||||
|
|
||||||
|
To achieve this, the keymap `override-global-map' is added to
|
||||||
|
`emulation-mode-map-alists', which makes it take precedence over
|
||||||
|
keymaps in `minor-mode-map-alist'. Thereby, key bindings get an
|
||||||
|
even higher precedence than global key bindings defined with
|
||||||
|
`keymap-global-set' (or, in Emacs 28 or older, `global-set-key').
|
||||||
|
|
||||||
|
The macro `bind-key*' (which see) provides a convenient way to
|
||||||
|
add keys to that keymap."
|
||||||
:init-value t
|
:init-value t
|
||||||
:lighter "")
|
:lighter "")
|
||||||
|
|
||||||
|
|
@ -425,6 +436,11 @@ function symbol (unquoted)."
|
||||||
|
|
||||||
;;;###autoload
|
;;;###autoload
|
||||||
(defmacro bind-keys* (&rest args)
|
(defmacro bind-keys* (&rest args)
|
||||||
|
"Bind multiple keys at once, in `override-global-map'.
|
||||||
|
Accepts the same keyword arguments as `bind-keys' (which see).
|
||||||
|
|
||||||
|
This binds keys in such a way that bindings are not overridden by
|
||||||
|
other modes. See `override-global-mode'."
|
||||||
(macroexp-progn (bind-keys-form args 'override-global-map)))
|
(macroexp-progn (bind-keys-form args 'override-global-map)))
|
||||||
|
|
||||||
(defun get-binding-description (elem)
|
(defun get-binding-description (elem)
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue