From 3e622b719273bc449aef3a829dae2044ac3e13a2 Mon Sep 17 00:00:00 2001 From: Tait Hoyem Date: Sun, 20 Feb 2022 11:31:10 -0700 Subject: [PATCH] New name --- README.md | 34 ++++++++++------------------------ docs/INSTALL.md | 24 +++++++++++------------- sohkd.rules | 1 + swhkd.rules | 5 ----- 4 files changed, 22 insertions(+), 42 deletions(-) create mode 100644 sohkd.rules delete mode 100644 swhkd.rules diff --git a/README.md b/README.md index cfcb60b..8a02150 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,31 @@ -

- SWHKD - -

A next-generation hotkey daemon for Wayland/X11 written in Rust.

- -

- - - - - -

-

+# SOHKD -## SWHKD +**S**imple **O**dilia **H**ot**K**ey **D**aemon -**S**imple **W**ayland **H**ot**K**ey **D**aemon +*A next-generation hotkey daemon for Wayland/X11 written in Rust.* -swhkd is a display protocol-independent hotkey daemon made in Rust. swhkd uses an easy-to-use configuration system inspired by sxhkd so you can easily add or remove hotkeys. +sohkd is a display protocol-independent hotkey daemon made in Rust (based off the original, [swhkd](https://waycrate.github.io/swhkd/)). sohkd uses an easy-to-use configuration system inspired by swhkd so you can easily add or remove hotkeys, and it integrates with the [Odilia screen reader](https://odilia.app) to provide modal access to key bindings. -It also attempts to be a drop-in replacement for sxhkd, meaning, your sxhkd config file is also compatible with swhkd. - -Because swhkd can be used anywhere, the same swhkd config can be used across Xorg or Wayland desktops, and you can even use swhkd in a tty. +Because sohkd can be used anywhere, the same sohkd config can be used across Xorg or Wayland desktops, and you can even use swhkd in a tty. **Note: The project is a WIP.** **BUT!! It does work right now however it's not a drop-in replacement yet. [Example config file](./docs/swhkdrc).** ## Installation -See [INSTALL.md](./docs/INSTALL.md) for installing swhkd. +See [INSTALL.md](./docs/INSTALL.md) for installing sohkd. ## Running: ```bash -swhks & -pkexec swhkd +sohks & +pkexec sohkd ``` To refresh the config at runtime, make a script like so: ```bash #!/bin/sh -sudo killall swhkd -pkexec swhkd +sudo killall sohkd +pkexec sohkd ``` Mark it as executable using `chmod +x `. diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 21a7424..5a95977 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -1,30 +1,28 @@ -# AUR: -`swhkd-git` `swhkd-musl-git` have been packaged. `swhkd-bin` & `swhkd-musl-bin` will be released soon. - # Install -`swhkd` and `swhks` install to `/usr/local/bin/` by default. You can change this behaviour by editing the [Makefile](../Makefile) variable, `TARGET_DIR`. +`sohkd` and `sohks` install to `/usr/local/bin/` by default. You can change this behaviour by editing the [Makefile](../Makefile) variable, `TARGET_DIR`. # Dependencies: ## Runtime: -- Policy Kit Daemon ( polkit ) +* Policy Kit Daemon (polkit) ## Compile time: -- rustup -- make +* rustup +* make # Compiling: -- `git clone https://github.com/waycrate/swhkd;cd swhkd` -- `make setup` -- `make clean` - - `make` for a musl compile. - - `make glibc` for a glibc compile. -- `sudo make install` +* `git clone https://github.com/waycrate/swhkd;cd swhkd` +* `make setup` +* `make clean` + * `make` for a musl compile. + * `make glibc` for a glibc compile. +* `sudo make install` # Running: + `swhks` `pkexec swhkd` diff --git a/sohkd.rules b/sohkd.rules new file mode 100644 index 0000000..b14d75f --- /dev/null +++ b/sohkd.rules @@ -0,0 +1 @@ +KERNEL=="uinput", MODE="660", GROUP="odilia", OPTIONS+="static_mode=uinput" diff --git a/swhkd.rules b/swhkd.rules deleted file mode 100644 index 90e8c18..0000000 --- a/swhkd.rules +++ /dev/null @@ -1,5 +0,0 @@ -polkit.addRule(function(action, subject) { - if (action.lookup("program") == "/usr/bin/swhkd") { - return polkit.Result.YES; - } -})