Dynamic key remapper for X Window System
This is an experimental project to achieve a comfortable configuration experience of key remap on Linux.
Some issues are reported and some of them are hard to reproduce or resolve immediately. If you can fix any open issues on these platforms, you'll be welcomed as a maintainer of xremap.
xremap is a key remapper for X Window System. With xremap's Ruby DSL, you can simply write configuration of key bindings.
remap 'C-b', to: 'Left'
And you can configure application-specific key bindings, which is dynamically applied based on a current window.
window class_only: 'slack' do
remap 'Alt-k', to: 'Alt-Up'
remap 'Alt-j', to: 'Alt-Down'
end
While xremap's configuration is written in Ruby, you can run xremap without Ruby installation because it embeds mruby to evaluate configuration.
- ruby
- bison
- libx11-dev
While ruby is not runtime dependency for xremap, mruby embedded in xremap requires ruby to build.
$ git clone https://github.com/k0kubun/xremap
$ cd xremap
$ make
$ sudo make install # or `make DESTDIR=~/bin install`
$ xremap /path/to/config
See examples to write config file.
window class_not: 'urxvt' do
remap 'C-b', to: 'Left'
remap 'C-f', to: 'Right'
remap 'C-p', to: 'Up'
remap 'C-n', to: 'Down'
remap 'M-b', to: 'Ctrl-Left'
remap 'M-f', to: 'Ctrl-Right'
remap 'C-a', to: 'Home'
remap 'C-e', to: 'End'
remap 'C-k', to: ['Shift-End', 'Ctrl-x']
remap 'C-d', to: 'Delete'
remap 'M-d', to: 'Ctrl-Delete'
end
Following configuration works fine with above Emacs-like bindings.
%w[a z x c v w t].each do |key|
remap "Alt-#{key}", to: "C-#{key}"
end
You can start an application by a shortcut key. See examples/window_switcher too.
remap 'C-o', to: execute('nocturn')
remap 'C-u', to: execute('google-chrome-stable')
remap 'C-h', to: execute('urxvt')
See xremap's stdout to find a window class name of your application.
window class_only: 'slack' do
remap 'Alt-n', to: 'Ctrl-k'
remap 'Alt-k', to: 'Alt-Up'
remap 'Alt-j', to: 'Alt-Down'
remap 'Ctrl-Alt-k', to: 'Alt-Shift-Up'
remap 'Ctrl-Alt-j', to: 'Alt-Shift-Down'
end
xremap is designed to have similar functionality with Karabiner and karabiner-dsl for Linux environments.
Takashi Kokubun