commit e79c0991d924dd894c2c5d070736e1df9198beef
from: Brett Fisher <code@brettfisher.xyz>
date: Thu May 21 19:16:28 2026 UTC

bxhkd.1: Initial commit.

commit - 44dbec001e057ba20d7cdd329cfe846a84c24f39
commit + e79c0991d924dd894c2c5d070736e1df9198beef
blob - /dev/null
blob + 4341310b73568630601c3bcb1d32d0a347cc76f2 (mode 644)
--- /dev/null
+++ bxhkd.1
@@ -0,0 +1,64 @@
+.Dd May 20, 2026
+.Dt BXHKD 1
+.Os
+.Sh NAME
+.Nm bxhkd
+.Nd basic X hotkey daemon
+.Sh SYNOPSIS
+.Nm 
+.Sh DESCRIPTION
+.Nm
+is a lightweight hotkey daemon for the X11 window system that monitors key presses and executes associated commands. bxhkd is designed to be the primary input interface for
+.Xr bxwm 1
+allowing for window mapping, focusing, and placement management. bxhkd hooks into the X server on startup, stays resident in the background, and listens for key events defined in the configuration. When a configured key combination is pressed, bxhkd executes the corresponding command string or script.
+.Sh DEFAULT KEY COMMANDS
+.Bl -tag -width "Super+Shift+[1,2 ... 0]" -compact
+.It Ic Shift+Alt+Return
+Open terminal
+.Xr st 1 .
+.It Ic Shift+Alt+P
+Open author's launchprogram script.
+.It Ic Ctrl+Shift+q
+Quit the X window system session.
+.It Ic Ctrl+Shift+c
+Center window horizontally, full height.
+.It Ic Ctrl+Shift+h
+Move window to left half.
+.It Ic Ctrl+Shift+l
+Move window to right half.
+.It Ic Ctrl+Shift+m
+Maximize window full height and width.
+.It Ic Ctrl+Shift+s
+Small window, centered.
+.It Ic Ctrl+Shift+j
+Move to next window in stack (down).
+.It Ic Ctrl+Shift+k
+Move to previous window in stack (up).
+.It Ic Ctrl+Shift+x
+Close the focused window.
+.It Ic Super+[1,2, ... 0]
+View specified workspace.
+.It Ic Super+Shift+[1,2 ... 0]
+Move focused window to specified workspace.
+.El
+.Sh CONFIGURATION
+.Nm
+is configured at compile-time by modifying the 
+.Pa config.def.h 
+header file. 
+After modifying this file, 
+.Nm
+must be recompiled and reinstalled to apply changes. User's may want to configure preferred terminal, launcher program or script, or additional programs to open with key commands.
+.Sh FILES
+.Bl -tag -width ".Pa ~/.local/var/log/bxhkd.log" -compact
+.It Pa config.def.h
+The default configuration file (see CONFIGURATION).
+.It Pa ~/.local/var/log/bxhkd.log
+The log file for runtime diagnostics of 
+.Nm .
+.El
+.Sh SEE ALSO
+.Xr bxwm 1 ,
+.Xr xinit 1
+.Sh AUTHOR
+.An "Brett Fisher <code@brettfisher.xyz>."