From a39e2d8a41fd186fa8f11ad0924b9eacf006501c Mon Sep 17 00:00:00 2001
From: Jim Myhrberg <contact@jimeh.me>
Date: Wed, 27 Mar 2024 02:07:05 +0000
Subject: [PATCH] feat(xkeysnail): add systemd unit and basic README

---
 config/xkeysnail/README.md       | 53 ++++++++++++++++++++++++++++++++
 config/xkeysnail/systemd.service | 13 ++++++++
 2 files changed, 66 insertions(+)
 create mode 100644 config/xkeysnail/README.md
 create mode 100644 config/xkeysnail/systemd.service

diff --git a/config/xkeysnail/README.md b/config/xkeysnail/README.md
new file mode 100644
index 0000000..f4d8c79
--- /dev/null
+++ b/config/xkeysnail/README.md
@@ -0,0 +1,53 @@
+# jimeh's xkeysnail setup
+
+The goal here is to use [xkeysnail][] Linux keyboard shortcuts mostly behave the
+same as on macOS.
+
+[xkeysnail]: https://github.com/mooz/xkeysnail
+
+## Pre-requisites
+
+To be able to run xkeysnail as a non-root user / with sudo, we need to perform
+some initial setup.
+
+1. Create a `uinput` group and add your user to it:
+   ```bash
+   sudo groupadd -f uinput
+   sudo gpasswd -a $USER uinput
+   ```
+2. Create udev rules for xkeysnail:
+   ```bash
+   cat <<EOF | sudo tee /etc/udev/rules.d/70-xkeysnail.rules
+   KERNEL=="uinput", GROUP="uinput", MODE="0660", OPTIONS+="static_node=uinput"
+   KERNEL=="event[0-9]*", GROUP="uinput", MODE="0660"
+   EOF
+   ```
+3. Reboot.
+
+(Borrowed from [here][1].)
+
+[1]: https://github.com/mooz/xkeysnail/issues/64#issuecomment-600380800
+
+## Setup systemd user service
+
+1. Copy service into place:
+   ```bash
+   mkdir -p $HOME/.config/systemd/user
+   cp ./systemd.service $HOME/.config/systemd/user/xkeysnail.service
+   ```
+2. Reload user units:
+   ```bash
+   systemctl --user daemon-reload
+   ```
+3. Enable service:
+   ```bash
+   systemctl --user enable xkeysnail.service
+   ```
+4. Start service:
+   ```bash
+   systemctl --user start xkeysnail.service
+   ```
+5. Check status of service:
+   ```bash
+   systemctl --user status xkeysnail.service
+   ```
diff --git a/config/xkeysnail/systemd.service b/config/xkeysnail/systemd.service
new file mode 100644
index 0000000..1e71f1d
--- /dev/null
+++ b/config/xkeysnail/systemd.service
@@ -0,0 +1,13 @@
+[Unit]
+Description=xkeysnail
+
+[Service]
+Type=simple
+KillMode=process
+ExecStart=%h/.local/share/mise/shims/xkeysnail --watch --quiet %h/.config/xkeysnail/config.py
+Restart=on-failure
+RestartSec=3
+Environment=DISPLAY=:0
+
+[Install]
+WantedBy=default.target