Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/waycrate/swhkd
Sxhkd clone for Wayland (works on TTY and X11 too)
https://github.com/waycrate/swhkd
hotkey hotkey-client hotkey-daemons hotkey-functionality hotkey-server hotkeys linux linux-app rust rust-application rust-apps rust-lang rust-language
Last synced: about 1 month ago
JSON representation
Sxhkd clone for Wayland (works on TTY and X11 too)
- Host: GitHub
- URL: https://github.com/waycrate/swhkd
- Owner: waycrate
- License: bsd-2-clause
- Created: 2021-12-09T07:15:55.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T07:19:02.000Z (6 months ago)
- Last Synced: 2024-05-21T06:32:20.228Z (6 months ago)
- Topics: hotkey, hotkey-client, hotkey-daemons, hotkey-functionality, hotkey-server, hotkeys, linux, linux-app, rust, rust-application, rust-apps, rust-lang, rust-language
- Language: Rust
- Homepage: https://git.sr.ht/~shinyzenith/swhkd
- Size: 5.66 MB
- Stars: 648
- Watchers: 9
- Forks: 47
- Open Issues: 74
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
A next-generation hotkey daemon for Wayland/X11 written in Rust.
## SWHKD
**S**imple **W**ayland **H**ot**K**ey **D**aemon
`swhkd` is a display protocol-independent hotkey daemon made in
[Rust](https://www.rust-lang.org). `swhkd` uses an easy-to-use configuration
system inspired by `sxhkd`, so you can easily add or remove hotkeys.
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.
## Installation and Building
[Installation and building instructions can be found here.](./INSTALL.md)
## Running
```bash
swhks &
pkexec swhkd
```
## Runtime signals
After opening `swhkd`, you can control the program through signals:
- `sudo pkill -USR1 swhkd` — Pause key checking
- `sudo pkill -USR2 swhkd` — Resume key checking
- `sudo pkill -HUP swhkd` — Reload config file
## Configuration
`swhkd` closely follows `sxhkd` syntax, so most existing `sxhkd` configs should
be functional with `swhkd`.
The default configuration file is in `/etc/swhkd/swhkdrc`. If you don't like
having to edit the file as root every single time, you can create a symlink from
`~/.config/swhkd/swhkdrc` to `/etc/swhkd/swhkdrc`.
If you use Vim, you can get `swhkd` config syntax highlighting with the
[swhkd-vim](https://github.com/waycrate/swhkd-vim) plugin. Install it in
vim-plug with `Plug 'waycrate/swhkd-vim'`.
All supported key and modifier names are listed in `man 5 swhkd-keys`.
## Autostart
### To autostart `swhkd` you can do one of two things
1. Add the commands from the ["Running"
section](https://github.com/waycrate/swhkd#running) to your window managers
configuration file.
1. Enable the [service
file](https://github.com/waycrate/swhkd/tree/main/contrib/init) for your
respective init system. Currently, only systemd and OpenRC service files
exist and more will be added soon including Runit.
## Security
We use a server-client model to keep you safe. The daemon (`swhkd` — privileged
process) communicates to the server (`swhks` — running as non-root user) after
checking for valid keybindings. Since the daemon is totally separate from the
server, no other process can read your keystrokes. As for shell commands, you
might be thinking that any program can send shell commands to the server and
that's true! But the server runs the commands as the currently logged-in user,
so no extra permissions are provided (This is essentially the same as any app on
your desktop calling shell commands).
So yes, you're safe!
## Support
1. https://matrix.to/#/#waycrate-tools:matrix.org
1. https://discord.gg/KKZRDYrRYW
## Contributors
## Supporters:
1. [@CluelessTechnologist](https://github.com/CluelessTechnologist)