BigBagKbdTrixXKB

KO | EN

gitlite — search

#hacktoberfest #typescript #golang #go #machine-learning #deep-learning #nodejs #cli #kubernetes #vue #pytorch #ios #mcp #openai

BigBagKbdTrixXKB

(★ 234)

"DreymaR's Big Bag of Keyboard Tricks" for *nix with XKB

File Explorer

Download Latest Version (.zip)

- FUNDING.yml
- colemak.iso15.kmap
- Colemak_ConsoleMode.txt
- data_keymaps_i386_colemak_en-latin9.map
- - Cmk-eD-al-ksym_Xm.png
  - Cmk-eD-al-usym-aw_Xm.png
  - Cmk-eD-al-usym-aw_Xmc.png
  - Cmk-eD-at+de-ksym_Xm.png
  - Cmk-eD-at+de-usym-aw_Xm-old.png
  - Cmk-eD-at+de-usym-aw_Xm.png
  - Cmk-eD-at+de-usym-aw_Xmc.png
  - Cmk-eD-ba+hr+rs+si-usym-aw_Xm.png
  - Cmk-eD-ba+hr+rs+si-usym-aw_Xmc.png
  - Cmk-eD-ba+rs-ksym_Xm.png
  - Cmk-eD-be+ca+fr-usym-aw_Xm.png
  - Cmk-eD-be+ca+fr-usym-aw_Xmc.png
  - Cmk-eD-be-ksym_Xm.png
  - Cmk-eD-br+pt-usym-aw_Xm.png
  - Cmk-eD-br+pt-usym-aw_Xmc.png
  - Cmk-eD-br-ksym_Xm.png
  - Cmk-eD-ca-ksym_Xm.png
  - Cmk-eD-cz-ksym_Xm.png
  - Cmk-eD-cz-usym-aw_Xm.png
  - Cmk-eD-cz-usym-aw_Xmc.png
  - Cmk-eD-dk+no-usym-aw_Xm.png
  - Cmk-eD-dk+no-usym-aw_Xmc.png
  - Cmk-eD-dk-ksym_Xm.png
  - Cmk-eD-es+latam-usym-aw_Xm.png
  - Cmk-eD-es+latam-usym-aw_Xmc.png
  - Cmk-eD-es-ksym_Xm.png
  - Cmk-eD-fi+se-usym-aw_Xm.png
  - Cmk-eD-fi+se-usym-aw_Xmc.png
  - Cmk-eD-fi-ksym_Xm.png
  - Cmk-eD-fr-ksym_Xm.png
  - Cmk-eD-gb+us-usym-aw_Xm.png
  - Cmk-eD-gb+us-usym-aw_Xmc.png
  - Cmk-eD-gb-ksym_Xm.png
  - Cmk-eD-hr-ksym_Xm.png
  - Cmk-eD-hu-ksym_Xm.png
  - Cmk-eD-hu-usym-aw_Xm.png
  - Cmk-eD-hu-usym-aw_Xmc.png
  - Cmk-eD-is-ksym_Xm.png
  - Cmk-eD-is-usym-aw_Xm.png
  - Cmk-eD-is-usym-aw_Xmc.png
  - Cmk-eD-it-ksym_Xm.png
  - Cmk-eD-it-usym-aw_Xm.png
  - Cmk-eD-it-usym-aw_Xmc.png
  - Cmk-eD-latam-ksym_Xm.png
  - Cmk-eD-nl-ksym_Xm.png
  - Cmk-eD-nl-usym-aw_Xm.png
  - Cmk-eD-nl-usym-aw_Xmc.png
  - Cmk-eD-no-ksym_Xm.png
  - Cmk-eD-pl-ksym_Xm-old.png
  - Cmk-eD-pl-ksym_Xm.png
  - Cmk-eD-pl-usym-aw_Xm.png
  - Cmk-eD-pl-usym-aw_Xmc.png
  - Cmk-eD-pt-ksym_Xm.png
  - Cmk-eD-ro-ksym_Xm.png
  - Cmk-eD-ro-usym-aw_Xm.png
  - Cmk-eD-ro-usym-aw_Xmc.png
  - Cmk-eD-se-ksym_Xm.png
  - Cmk-eD-si-ksym_Xm.png
  - Cmk-eD-sym-wide_Xm.xcf
  - Cmk-eD-tr-ksym_Xm.png
  - Cmk-eD-tr-usym-aw_Xm.png
  - Cmk-eD-tr-usym-aw_Xmc.png
  - Cmk-eD-usym-aw_Xm.png
  - Cmk-eD-usym-aw_Xmc.png
  - Cmk-eD-usym_Xm.png
- - Cmk-X-phon-bg.png
  - Cmk-X-phon-bg_2015-02.png
  - Cmk-X-phon-gr-awide-sl_mask.png
  - Cmk-X-phon-il-awide-sl_mask.png
  - Cmk-X-phon-ru.png
  - Cmk-X-phon-ru_2015-02.png
- Extend-ISO-NoWi-Linux_90d.png
- gtk_edit_install.sh
- key-xev.sh
- README_gtk_edit.txt
- sample_etc-default-keyboard
- show-xkb.sh
- xkbmodel-awide-sl.sh
- xkbmodel-pc105.sh
- README.md
- xkb-data_2-35-1-1_xkb-symbols.zip
- README.md
.gitattributes
.gitignore
install-dreymar-xmod.sh
LICENSE.md
README.md
setkb.sh

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

DreymaR's Big Bag of Keyboard Tricks
====================================

### For Linux using XKB
This is my Linux/XKB implementation of my [Big Bag][BigBag] layout tools, including:
* Improved "Colemak[eD]" AltGr mappings (lv3-4), placing dead keys on AltGr+symbol keys
* Powerful Extend layers using Caps Lock as a lv5 modifier for navigation/editing from the home position and more!
* Comfy Angle/Wide ergo modifications to improve wrist angles(!), hand spacing and right pinky movement+load
* The Curl-DH ergo mod to allow a more natural finger curvature and avoid lateral stretches
 - The Colemak-DH layout on normal row-staggered keyboards, is a combination of the Curl-DH and Angle mods
* The Sym ergo mod to improve access to often-used symbol keys
* For several locales, a 'Unified Symbols' layout with only a few necessary changes from the standard Colemak[eD]
 - Also, a layout to 'Keep Local Symbols' like their default (QWERTY-type) counterparts for that locale
* Intuitive phonetic layouts for Cyrillic, Greek and Hebrew scripts
* Mirrored Colemak that allows one-handed typing with practically no re-learning (if I ever break an arm...)
* The 4 Tarmak transitional Colemak layouts for learning Colemak(-DH) in smaller steps if so desired

The main Big Bag pages are found at [https://dreymar.colemak.org/][BigBag].

To see XKB info boxes there, select the Tux platform icon.

Setup
-----
First, run the install script. This copies my modified files into the system X11 directory. Original files are backed up by default.

* You can now probably use the system's layout settings to choose a setup. 
* However, some layout settings won't let you set the model component that I use for some ergo mods.
* I've made a `setkb.sh` BASH script to activate my setups and to bring me back to defaults.
* Run the install and setkb scripts with -h (and/or look inside them) first, for more help and info.
* For more info on your choices, consult the [Big Bag][BigBag] pages. Select the Tux platform icon.

* The setkb script activates a (Big Bag) layout setup with model, layout and option components, using a `setxkbmap` command.
 - If your distro doesn't have an X server (e.g., Wayland), you can't use the setkb script directly. See below.
* The setkb script can write its command to a file that gets sourced at startup, like `~/.bashrc`; check your distro for which file(s) to use.
* Learn about `setkb.sh "model locale variant"` shortstring syntax in the [BigBag][BigBag4X].
 - The default is `"5caw us us"`: PC105(ISO) board with Curl(DH)AngleWide mods, US locale, Cmk-eD UniversalSymbols variant.
 - To switch to, say, an ANSI board without ergo mods, that's `4n` instead of `5caw`. Look in the scripts.
* NOTE: It may be necessary to select "Use system defaults" in the OS GUI layout settings if you have changed anything there.

Before trying out the BigBag, you may want to find out what your current XKB settings are. One way of seeing what you use is `setxkbmap -v 9`.
- To get the standard US default layout back, you can use `setkb 4n` for ANSI keyboards; `5n` for ISO. What you want depends on your locale.
- Generally, use `setkb 4n/5n [loc [var]]` to get back your locale layout/model. The `[var]` is for variant; omit it for the default/basic one.

Tips
----
* Due to complaints from new users that Extend on F# keys interferes with `Ctrl+Alt+F#` TTY shortcuts, FKey Extend is now disabled by default.
 - You can enable FKey Extend by activating the [include "extend(lv5_fk)"][BB-ExtFK] bit (delete the leading slashes) in the `symbols/extend` file.
 - If you had already installed the BigBag you must either edit the file in its target X11 directory, or edit and then reinstall the files.
 - In theory, we could make such shortcuts part of Extend so you can have both them and the Multimedia key shortcuts. I'll think about it.
* To just get Extend with the currently active layout, use `setxkbmap -v 9 -option "" -option "misc:extend,lv5:caps_switch_lock,compose:menu"`.
 - The first `-option ""` clears any existing option settings, while the one with non-empty arguments add to existing options.
* The 'Keep Symbols' layouts are intended for those who aren't ready to give up their symbol mappings. Not the best option, but "training wheels".
 - The Unified 'us' variants are usually much better. The 'ks' ones will miss out on some symbols and many dead keys.
* The `xkb-data` package is very consistent between distros. I've used [Debian xkb-data][XKB-DebS], sometimes with some Ubuntu updates.
* Any .deb package may be opened using `dpkg -x` or `ar -xv` (from `binutils`) on Linux
 - On Windows, you can use any decent zip manager such as PeaZip.
* To change your logon keyboard layout, use the `dpkg-reconfigure` command:
 - `sudo dpkg-reconfigure keyboard-configuration`
 - NOTE: Be sure you know how to type your password afterwards!

Wayland & Friends
-----------------
Wayland has a somewhat different tack: It uses xkb-data files, but not an X server. So the setkb script won't work there, but the BigBag as such will.

It depends on which Wayland Compositor you're using. Sorry, but I don't know them all. See its docs for more info?

For the popular Sway compositor, add a piece like this example to your `~/.config/sway/config` file:
```
input * {
  xkb_model     pc105awide
  xkb_layout    us
  xkb_variant   cmk_ed_us
  xkb_options   lv5:caps_switch_lock,misc:extend,compose:menu
}
```

And here's one for Hyprland's `~/.config/hypr/hyprland` file:
```
input {
    kb_rules=evdev
    kb_model=pc105awide
    kb_layout=us
    kb_variant=cmk_ed_dh
    kb_options=misc:extend,lv5:caps_switch_lock,compose:menu
    repeat_rate=40
    repeat_delay=200
}
``` 
The repeat settings are of course optional. Some like a higher repeat rate and a lower delay, and this is how to get that.

For GNOME, most of the settings should be available in GUI form in cases where the setxkbmap function is overridden or unavailable.
It's usually `Settings→Region & Language→Input Sources` or `System→Preferences→Keyboard→Layouts` you want, I think. 
However, the model component needed for "hard" ergo mods may not be available there, and you may need to set that dconf entry separately. 
The GNOME Tweak Tool can be useful. For a more manual approach, there's `dconf` and `gsettings` for editing the dconf settings database. 
E.g., `gsettings set org.gnome.desktop.input-sources xkb-model "'pc104awide'"` (for the AngleWide-ANSI model). 
This is considered an "old way" nowadays, if I'm correct, and with Wayland & Friends there are usually other, newer ways.

Here's a KDE Settings `~/.config/kxkbrc` file. It can be set via the Settings GUI, or edited directly:
```
[$Version]
update_info=kxkb_variants.upd:split-variants,kxkb.upd:remove-empty-lists,kxkb.upd:add-back-resetoptions

[Layout]
DisplayNames=,
LayoutList=us,us
LayoutLoopCount=-1
Model=pc104awide
Options=grp:alt_shift_toggle,grp:win_space_toggle,caps:backspace,lv3:ralt_switch_multikey,compose:menu
ResetOldOptions=true
ShowFlag=false
ShowLabel=true
ShowLayoutIndicator=true
ShowSingle=true
Use=true
VariantList=cmk_ed_dh,
``` 
This one uses Caps as a Backspace. See the example above to upgrade it to an Extend key.

In NixOS without Wayland/Sway, [services.xserver](https://nixos.wiki/wiki/Keyboard_Layout_Customization) should work:
```
services.xserver = {
  layout = "us";
  xkbVariant = "cmk_ed_dh";
  xkbModel   = "pc105awide";
  xkbOptions = "misc:extend,lv5:caps_switch_lock,compose:menu";
};
```
To get the xserver layout in your console as well, use `console.useXkbConfig` in your `configuration.nix` file.

I guess the solution will be quite similar for other compositors, but I don't know more at the moment.

localectl
---------
* You can use the `localectl set-x11-keymap` command to make changes persistent; you may have to run it with `sudo` privileges
* Syntax: `[sudo] localectl [--no-convert] set-x11-keymap layout [model [variant [options]]]`
* Example: `sudo localectl set-x11-keymap us pc105awide cmk_ed_us "lv5:caps_switch_lock,misc:extend"`
* For `layout` and `[variant]`, you can use for instance `"us,us"` and `"cmk_ed_us,"` to switch between Cmk-eD and the default us layout
* Unfortunately, you can't switch between multiple models nor options this way – so your QWERTY may have the Angle (and Curl!) mods...
* Add `--no-convert` to not convert between closest matching console and X11 keyboard mappings; this precludes applying as system console mapping
* Note that XKB options may be overridden by the settings tools used with desktop environments like GNOME and KDE
* More info on setting keyboard layouts is found in the Arch Manual and Wiki, at: 
 - https://man.archlinux.org/man/localectl.1
 - https://wiki.archlinux.org/title/Xorg/Keyboard_configuration#Using_localectl
 - https://wiki.archlinux.org/title/Linux_console/Keyboard_configuration#Persistent_configuration
* Thanks to: Daniele, i-c-u-p, Flomza and others at the Cmk Discord for helping find this out

Links
-----
See [DREYMAR'S BigBag XKB topic on the Colemak Forums][BigBag4X].
There are plenty of explanations and further links in there.

TODO/DONE for this repo are found in the [xmod folder README][xmREADME].

One good source of info on the `xkb-data` package is the [xkeyboard-config][XKB-conf] repository itself, and its `docs` folder. The repo is found at [GitLab][XKBgitLb].

Or, have a look in the X.Org Wiki.
https://www.x.org/wiki/XKB/

Arch has good documentation on all things XKB.
https://wiki.archlinux.org/title/X_keyboard_extension
https://wiki.archlinux.org/title/Xorg/Keyboard_configuration

Ivan Pascal is a grandmaster of XKB; to learn it better you should definitely consult his site. Though maybe a bit less complete for us who can't read Russian, it's well worth it.
http://pascal.tsu.ru/en/xkb
http://pascal.tsu.ru/en/xkb/gram-symbols.html

Happy XKB hacking! &nbsp;&nbsp;
_DreymaR_

[XKB-conf]: https://www.freedesktop.org/wiki/Software/XKeyboardConfig/ (XKeyboard Config page)
[XKBgitLb]: https://gitlab.freedesktop.org/xkeyboard-config/xkeyboard-config (XKB-config on GitLab)
[XKB-pkgs]: https://pkgs.org/download/xkb-data (pkgs.org xkb-data page)
[XKB-DebS]: https://packages.debian.org/sid/xkb-data (Debian Sid xkb-data download)
[BigBag]:   https://dreymar.colemak.org/ (DreymaR's Big Bag of Keyboard Tricks)
[BigBag4X]: http://forum.colemak.com/viewtopic.php?id=1438 (DreymaR's old BigBag for Linux/XKB on the Colemak Forum)
[BBREADME]: README.md                               (main BigBag4XKB README)
[xmREADME]: /xkb-data_xmod/README.md                (xmod BigBag4XKB README)

[XKB-2351]: https://debian.pkgs.org/sid/debian-main-amd64/xkb-data_2.35.1-1_all.deb.html (Debian Sid xkb-data page, 2022-12)
[BB-ExtFK]: /xkb-data_xmod/xkb/symbols/extend#L66   (BigBag4XKB – FKkey include in symbol/extend file)

BigBagKbdTrixXKB

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

BigBagKbdTrixXKB

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README