You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Tait Hoyem db896e3bb4
don't follow lock
2 years ago
.github [remove] pr template 2 years ago
assets Include assets 2 years ago
contrib Add contrib from latest version 2 years ago
docs Update docs with newest version 2 years ago
src Remove common 2 years ago
.gitignore [update] add server binary to gitignore 2 years ago
.rustfmt.toml [Create] rustfmt.toml 2 years ago
CODE_OF_CONDUCT.md [create] Code of conduct.md 2 years ago
CONTRIBUTING.md [update] Contributing.md 2 years ago
Cargo.toml Remove common 2 years ago
INSTALL.md Update docs with newest version 2 years ago
LICENSE move to permissive BSD 2-Clause "Simplified" License 2 years ago
README.md misc fixes and note uptes 2 years ago
com.github.sohkd.pkexec.policy Update docs with newest version 2 years ago
rust-toolchain.toml Update docs with newest version 2 years ago

README.md

SWHKD

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

SOHKD:

Simple Odilia HotKey Daemon

sohkd is a display protocol-independent hotkey daemon made in Rust. sohkd 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 swhkd, meaning your sxhkd config file is also compatible with sohkd.

Because sohkd can be used anywhere, the same sohkd config can be used across Xorg or Wayland desktops, and you can even use sohkd in a tty.

Installation and Building:

Installation and building instructions can be found here.

Running:

swhks &
pkexec sohkd

Runtime signals:

After opening sohkd, you can control the program through signals:

  • sudo pkill -USR1 sohkd - Pause key checking
  • sudo pkill -USR2 sohkd - Resume key checking
  • sudo pkill -HUP sohkd - Reload config file

Configuration:

Swhkd closely follows sxhkd syntax, so most existing sxhkd configs should be functional with sohkd.

The default configuration file is in /etc/sohkd/sohkdrc. If you don't like having to edit the file as root every single time, you can create a symlink from ~/.config/sohkd/sohkdrc to /etc/sohkd/sohkdrc.

If you use Vim, you can get sohkd config syntax highlighting with the sohkd-vim plugin. Install it in vim-plug with Plug 'waycrate/sohkd-vim'.

All supported key and modifier names are listed in man 5 sohkd-keys.

Autostart:

To autostart sohkd you can do one of two things:

  1. Add the commands from the "Running" section to your window managers configuration file.
  2. Enable the service file 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 ( sohkd - privileged process ) communicates to the server ( swhks - running as non root user ) after checking for valid keybinds. 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!

Contributors: