This module provides barebones support for using Doom with non-qwerty layouts.
- @gagbo (Author, Bépo)
+azertyRemaps keybinds to accommodate the Azerty keyboard layout.+bepoRemaps keybinds to accommodate the BÉPO keyboard layout (version 1.1, in particualr).
None
If you are using :editor evil, you should use (evil +everywhere), as the
module uses evil-collection utilities to do the remapping.
If you are not using :editor evil, then you have nothing to do.
Support for the bépo layout includes:
- Setting Avy keys to the correct home row keys
- Changing navigation keys to
ctsr- old
tis mapped toj - old
sis mapped tok(i.e. staging in the magit status buffer is done withk) - See Configuration to see where old
candrfunctions are remapped
- old
- Bind
<>functions to«»keys when possible - Bind
[]functions to()keys when possible (the “unimpaired-like” bindings) - Bind
ékey towfunctions when possible - Bind
èkey to useful functions when possible - Bind
`~functions to$#keys when possible
If you use evil-easymotion, then all the bindings that were on gs have been
moved to gé.
In short : g s j -> g é t (evilem-motion-next-line). And so on.
Exchanging hjkl to ctsr has the effect of destroying a few mnemonics: the
change operator becomes l for example, or the window split becomes SPC é k.
The module tries to limit those changes to the minimum, especially in special buffers. A concrete example is magit.
As the magit: project buffer (obtained with magit-status) does not need
left-right navigation, keys c, r, h, and l keep their “expected” bindings,
while t, s, j, and k are flipped:
- checking the log from a magit buffer is still on
l - staging a file/region has been moved to
k
A nice addition in the future might be to have all the normal mode bindings that
start with g start with , instead to avoid the curl on these common
bindings. This is not implemented for the time being.
The same thing could be done to z, potentially using à instead.
Also, implementing all those changes as a minor we could flip on and off would help with adoption
“inside word” and “around word” are iw and aw, which use the very poorly
rated w key in the bépo layout. Finding a way to use é or even è more for
these would be a welcome change
evil-org allows to define evil-org-movement-bindings to automatically map
movement bindings on non-hjkl keys. It maps automatically keys to C-c and
C-r in normal and insert states though, and it’s not really user friendly in
Emacs to remap those.
Therefore, in org-mode:
org-shiftrightis bound toC-»org-shiftleftis bound toC-«
+layout-bepo-cr-rotation-style controls whether:
qwerty-cfunctions are mapped onbépo-lkey, andqwerty-rfunctions onbépo-hkey ('ergodis), orqwerty-cfunctions are mapped onbépo-hkey, andqwerty-rfunctions onbépo-lkey ('strict)
'strict would be the logical choice but the c functions are used more often
than the r ones so Ergodis advises to actually put all the c functions on
the key that does not need a curl.
- in eshell, the key `c` is still bound to `evil-collection-eshell-evil-change` in normal mode
If a key is misbehaving, use describe-key (C-h k or SPC h k or F1 k) to
see the functions bound to the key, and more importantly in which map it is
bound.
You should ignore all evil-collection-...-backup-map keymaps, as they are
artifacts from evil-collection-translate-key and those maps are actually not
active.
Most likely the solution is to call one of the “key rotation” functions on the relevant keymaps.
If you are learning a new layout you might want to go back to tho old one to
“get work done”. Sadly the only way is to comment out the module, run doom
sync and restart emacs.
Restoring the session SPC q l by default helps to lower the impact of the
restart.