xremap 0.15.6

Dynamic key remap for X and Wayland
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

## Actions

Remapping lets you assign actions to keys. Actions can only be used in `keymap`
and [press/release keys](reference_press_release_key.md).

### Example: Run programs

Run a program when `KEY_A` is pressed (and repeated). The trigger key is disabled entirely.
The program is just started and ignored, it does not block key processing.

```yml
keymap:
  - remap:
      Capslock: { launch: ["notify-send", "Hello World!"] }
```

Note: Holding down `capslock` will generate repeat events, which will run the program every say `50ms`.

### Example: Run bash script

By using yaml notation for multi-line text it's possible to write scripts:

```yml
keymap:
  - remap:
      Capslock:
        launch:
          - "bash"
          - "-c"
          - |
            NAME=`whoami`
            WORKDIR=`pwd`
            notify-send "Username: $NAME" "Workdir: $WORKDIR"
```

### Example: Key events

It's possible to emit the individual press, repeat and release events:

```yml
throttle_ms: 10 # Slows down events.
keymap:
  - remap:
      Capslock: [{ press: B }, { repeat: B }, { release: B }]
```

Note: `throttle_ms` is necessary for some applications because actions are
sent without any delay in-between by default.

Note: That repeat events are usually ignored by the kernel. It emits the repeat events itself.

### Example: Sleep

Block key processing in the given amount of `ms`.

```yml
keymap:
  - remap:
      Capslock: { sleep: 10 }
```

### Example: Close applications

Close all applications that have the exact `app_class`.

```yml
keymap:
  - remap:
      Capslock: { close_apps: "firefox" }
```

Since: `v0.15.3`. Not supported in GNOME yet.