Dynamic key remapper for X Window System
C Ruby Makefile
Latest commit 2d3eefb Jan 15, 2017 @k0kubun committed on GitHub Merge pull request #17 from acro5piano/master
Fix cannot remap_keys when using "window focus follows the mouse"

README.md

xremap

Dynamic key remapper for X Window System

Description

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.

Installation

Build dependencies

  • ruby
  • bison
  • libx11-dev

While ruby is not runtime dependency for xremap, mruby embedded in xremap requires ruby to build.

From source code

$ git clone https://github.com/k0kubun/xremap
$ cd xremap
$ make
$ sudo make install # or `make DESTDIR=~/bin install`

Usage

$ xremap /path/to/config

See examples to write config file.

Emacs-like bindings

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

Simulate macOS's command key

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

Application launcher

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')

Application-specific key bindings

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

Project status

Experimental. It's working but not tested well.

Note

xremap is designed to have similar functionality with Karabiner and karabiner-dsl for Linux environments.

Author

Takashi Kokubun