You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
rusty-keys/README.md

61 lines
2.8 KiB
Markdown

rusty-keys
7 years ago
======
uinput level keyboard mapper for linux, with advanced caps lock and shift swapping behavior
This is the only keymapper I am aware of capable of implementing this layout:
![Unix Programmer's Dvorak](https://www.moparisthebest.com/kbs/programmer-dvorak-NoSecondary-NumpadStandard-NoSwap-StandardNums-SwapAt-SwapPipe.svg)
The Problem
-----------
6 years ago
If you ever have mapped keys on linux, you know that there is the console keymap (loadkeys) and the X keymap (setxkbmap),
also things like SDL and Virtualbox grab the input directly and respect no maps. Lastly I want to revert to QWERTY when
holding ctrl so ctrl+c works just like normal, without remapping all programs to ctrl+j. Linux keymaps cannot do this either.
The Solution
------------
1. Grab a keyboard device directly so only we can read events from it.
6 years ago
2. Create a new keyboard input device with uinput, this looks identical to any other keyboard device to anything running on the box.
3. Read input_events from the real device, map them, send them to our created device.
This solution is what rusty-keys implements, it works in ttys, in X, in virtualbox even running windows or whatever,
on SDL games, it will work literally everywhere, because rusty-keys just creates a regular keyboard.
How to run
----------
6 years ago
When ran, it will read a keymap.toml configuration file, refer to example and tweak to suit.
7 years ago
```
6 years ago
Usage: rusty-keys [options] [device_files...]
Options:
-h, --help prints this help message
-v, --version prints the version
6 years ago
-c, --config FILE specify the keymap config file to use (default:
/etc/rusty-keys/keymap.toml)
```
6 years ago
when ran without specifying input devices, it maps all currently connected keyboards, and watches /dev/input/ with
inotify and starts mapping any new keyboards that are plugged in forever, until you kill it:
`rusty-keys`
6 years ago
or you can specify one or multiple input devices, and it will run until all are disconnected, then stop:
`rusty-keys /dev/input/event0` or `rusty-keys /dev/input/event0 /dev/input/event2`
6 years ago
An example systemd service is in systemd/rusty-keys.service, enable it to have mapped keyboards all the time.
How to install
--------------
* `cargo install rusty-keys`
6 years ago
* Arch Linux [rusty-keys](https://aur.archlinux.org/packages/rusty-keys/) [rusty-keys-git](https://aur.archlinux.org/packages/rusty-keys-git/)
License
-------
AGPLv3 for now, message me if you have a problem with this
Notes
-----
Technically this is a re-implementation of a [previous](https://code.moparisthebest.com/moparisthebest/uinput-mapper/src/master/uinputmapper/keymapper.py) [python](https://code.moparisthebest.com/moparisthebest/uinput-mapper/src/master/keymaps/dvorak.py) [program](https://code.moparisthebest.com/moparisthebest/uinput-mapper/src/master/input-read#L151)
I had been using for 3 years previously.