Skip to content

Latest commit

 

History

History
196 lines (130 loc) · 6.46 KB

README.md

File metadata and controls

196 lines (130 loc) · 6.46 KB

Installation

  1. Download the Karabiner-Elements package from here.
  2. Open the dmg file and then open the installer.
  3. Karabiner-Elements and Karabiner-EventViewer will be installed into Launchpad.

Open Karabiner-Elements

Open Karabiner-Elements from Launchpad. The preferences window will be opened.

Quit Karabiner-Elements

You can quit Karabiner-Elements by pressing the "Quit Karabiner-Elements" button in the preferences window.

Uninstall Karabiner-Elements

You can uninstall Karabiner-Elements from Misc tab.

How to configure Karabiner-Elements

You can add key modification configurations from Preferences.

You can investigate the key name in Karabiner-EventViewer.

How to use complex modifications

Open Complex Modifications tab.

Then press the Import more rules from the Internet button.

A web browser is opened. Press Import button.

A confirmation dialog is opened. Press Allow.

Karabiner-Elements Preferences is opened. Press Import button.

New rules are imported. Press Enable button.

A new rule is enabled.

Set keyboard type

You can set keyboard type in Virtual Keyboard tab.

If your keyboard is not ANSI layout, you have to set the keyboard type of virtual keyboard.

Learn about karabiner.json

Karabiner-Elements configuration will be saved to ~/.config/karabiner/karabiner.json.

You don't need to care about this file for normal usage. We describe about karabiner.json for advanced usage.

An example karabiner.json

karabiner.json uses the json syntax. If you are not familiar with it, it may help to read up on it beforehand.

The following is an example configuration. It maps Caps Lock ⇪ key to Delete ⌫ key.

{
    "profiles": [
        {
            "name": "Default profile",
            "selected": true,
            "simple_modifications": {
                "caps_lock": "delete_or_backspace"
            }
        }
    ]
}

All mapping rules must be placed between "simple_modifications": { and }. Rules are separated by a comma.

Let's say, in addition to Caps Lock mapping, we want to map left Command ⌘ key to Control ⌃ key. To do this, we can add new rule under the caps_lock rule.

{
    "profiles": [
        {
            "name": "Default profile",
            "selected": true,
            "simple_modifications": {
                "caps_lock": "delete_or_backspace",
                "left_command": "left_control"
            }
        }
    ]
}

The key definition

You need key definitions to map keys. For example you should know Caps Lock ⇪ key is caps_lock. Keys (e.g. "caps_lock") are defined in simple_modifications.json.

Typical configuration files

Following are few configuration files that will help you get started. You can use them as-is or mix the rules as per your need.

Swapping Section/Paragraph § key on non-US keyboards

Most non US keyboards have a § key paired with ± or $ or something else.

UK Keyboard

Danish Keyboard

Arabic Keyboard

German Keyboard

Most users swap § with whatever key is right next to shift ⇧ key. The following is sample configuration that swaps those two keys.

{
    "profiles": [
        {
            "name": "Default profile",
            "selected": true,
            "simple_modifications": {
                "non_us_backslash": "grave_accent_and_tilde",
                "grave_accent_and_tilde" : "non_us_backslash"
            }
        }
    ]
}

This will give you following mapping:

Keyboard Before After
UK or Arabic § `
UK or Arabic ` §
UK or Arabic ± ~
UK or Arabic ~ ±
Danish § >
Danish > §
Danish $ <
Danish < $
German ^ <
German < ^