Skip to content

Latest commit

 

History

History
162 lines (108 loc) · 5.11 KB

README.md

File metadata and controls

162 lines (108 loc) · 5.11 KB
Raw

dxhd

daky's X11 hotkey daemon

dxhd is heavily inspired by sxhkd, written in Go, and has quite elegant syntax for configuration files!

Installation

NOTE: the git version, a.k.a. the master version is usually more bug free than the released, binary ones, since introduced bugs first get fixed in this version.

  • Arch User Repository
git clone https://aur.archlinux.org/dxhd-git.git
# or binary version - git clone https://aur.archlinux.org/dxhd-bin.git
cd dxhd-git
# or cd dxhd-bin if you cloned binary one
makepkg -si

or use an AUR helper like yay - yay -S dxhd

  • From the source
git clone https://github.com/dakyskye/dxhd.git
cd dxhd
go build -o dxhd .

and copy dxhd executable file to somewhere in your $PATH

  • From releases

Download the dxhd executable file from the latest release, from releases page

and copy dxhd executable file to somewhere in your $PATH

Features (what's inside parentheses, are just minimal example patterns)

  • key press events (super + key, where key is a non-modifier key)
  • key release events (super + @key where key is a non-modifier key, and @ is specifier)
  • mouse button press events (mouseN where n is button number)
  • mouse button release events (@mouseN where n is button number, and @ is specifier)
  • variants ({a,b,c})
  • ranges ({1-9}, {a-z}, {1-3,5-9,i-k,o-z})
  • in-place reloading (dxhd -r)
  • calculating the time parsing a config file took (dxhd -p)
  • support for any shell scripting language (sh, bash, ksh, zsh, python, perl etc.) given as a shebang
  • support for scripting, as much as a user wishes!

Demo

! outdated gif !

demo gif

Configuration

The default config file is located at ~/.config/dxhd/dxhd.sh, however, dxhd can use a file from any path, by passing it to -c:

dxhd -c /my/custom/path/to/a/config/file

A dxhd config file should containt a shebang (defaults to /bin/sh) on top of a file, which is where binding actions take action

Syntax

* config file *

#! shebang

## a comment
######### a comment

# key + combo
<what to do>

# key + combo + with + {1-9,0,a-z} + ranges
<what to do {with,these,ranges}>

Daemonisation

Rather then dxhd self daemonising itself, let other programs do their job.

Use systemd, runit, openrc or other Linux init system to start dxhd on system startup, or let your DE/WM start it by adding an ampersant at the end dxhd -c path/to/config &, optionally, use disown keyword to make it not owned by the DE/WM process.

For further help, join the developer's Discord guild

Examples

License

Licensed under the MIT license.

FAQ

Why was dxhd made

Because I had (and have) 20 workspaces, and sxhkd did not allow me to have 11-19 range, that was one of the main reasons I started developing dxhd

What makes dxhd better than sxhkd

  • dxhd uses shebang to determine which shell to use (so you don't have to set an environment variable)
  • dxhd config file syntax matches shell, python, perl and probably some other languages syntax
  • dxhd is great with scripting, because of it's elegant syntax. multi line scripts do not need \ at the end of line
  • dxhd allows you to have different range in a keybinding's action, for example, 1-9 in a keybinding, and 11-19 in it's action
  • dxhd has support for mouse bindings out of the box, no patching required!

How do I port my sxhkd config to dxhd

It is simple enough! (I personally used Vim macros when I did it, because if you use Vim, you'll know why:)

  • convert any line starting with single # to a dxhd comment (so ## or more)
  • put # before every keybinding (super + a to # super + a)
  • remove spaces before lines ( echo foo to echo foo) (optional)
  • remove every end-line backslash (echo bar \ to echo bar) (probably optional, unsure)

So you'd end up with:

# print hello world
super + a
	echo hello \
	echo world

to

#!/bin/sh

## print hello world
# super + a
echo hello
echo world

I use ranges, released key events and chords from sxhkd, does dxhd have them

Yes! and no. dxhd has released key events and ranges, but no chords (yet - wip)

Is dxhd faster than sxhkd

They haven't benchmarked yet, so I don't know. However, been using dxhd since the first release and haven't noticed any speed loss!

Why is the released binary file +8mb

Because it's statically built, to make sure it will work on any amd64 linux machine! You can build dxhd instead to get much smaller file size. (build with -ldflags "-s -w")