README.md
1## Description
2
3*sxhkd* is an X daemon that reacts to input events by executing commands.
4
5Its configuration file is a series of bindings that define the associations between the input events and the commands.
6
7The format of the configuration file supports a simple notation for mapping multiple shortcuts to multiple commands in parallel.
8
9## Example Bindings
10
11 XF86Audio{Prev,Next}
12 mpc -q {prev,next}
13
14 @XF86LaunchA
15 scrot -s -e 'image_viewer $f'
16
17 super + shift + equal
18 sxiv -rt "$HOME/image"
19
20 XF86LaunchB
21 xdotool selectwindow | xsel -bi
22
23 super + {h,j,k,l}
24 bspc node -f {west,south,north,east}
25
26 super + alt + {0-9}
27 mpc -q seek {0-9}0%
28
29 super + {alt,ctrl,alt + ctrl} + XF86Eject
30 sudo systemctl {suspend,reboot,poweroff}
31
32 super + {_,shift + }{h,j,k,l}
33 bspc node -{f,s} {west,south,north,east}
34
35 {_,shift + ,super + }XF86MonBrightness{Down,Up}
36 bright {-1,-10,min,+1,+10,max}
37
38 super + o ; {e,w,m}
39 {gvim,firefox,thunderbird}
40
41 super + alt + control + {h,j,k,l} ; {0-9}
42 bspc node @{west,south,north,east} -r 0.{0-9}
43
44 super + alt + p
45 bspc config focus_follows_pointer {true,false}
46
47 # Smart resize, will grow or shrink depending on location.
48 # Will always grow for floating nodes.
49 super + ctrl + alt + {Left,Down,Up,Right}
50 n=10; \
51 { d1=left; d2=right; dx=-$n; dy=0; \
52 , d1=bottom; d2=top; dx=0; dy=$n; \
53 , d1=top; d2=bottom; dx=0; dy=-$n; \
54 , d1=right; d2=left; dx=$n; dy=0; \
55 } \
56 bspc node --resize $d1 $dx $dy || bspc node --resize $d2 $dx $dy
57
58## Editor Plugins
59
60### Vim
61
62- [vim-sxhkdrc](https://github.com/baskerville/vim-sxhkdrc).
63- [sxhkd-vim](https://github.com/kovetskiy/sxhkd-vim).
64
65----
66
67For further information, check the `man` pages.
68