commit 2050470ba882f22c088bc5711eed1126dd7efe2b
parent 3b26f3db4ea8234c8b89289ca882e300025b8eeb
Author: Bastien Dejean <nihilhill@gmail.com>
Date: Mon, 29 Aug 2016 20:05:14 +0200
Create original README
Diffstat:
3 files changed, 52 insertions(+), 44 deletions(-)
diff --git a/README.asciidoc b/README.asciidoc
@@ -1 +0,0 @@
-doc/sxhkd.1.txt
-\ No newline at end of file
diff --git a/README.md b/README.md
@@ -0,0 +1,52 @@
+## Description
+
+*sxhkd* is an X daemon that reacts to input events by executing commands.
+
+Its configuration file is a series of bindings that define the associations between the input events and the commands.
+
+The format of the configuration file supports a simple notation for mapping multiple shortcuts to multiple commands in parallel.
+
+## Example Bindings
+
+ XF86Audio{Prev,Next}
+ mpc -q {prev,next}
+
+ @XF86LaunchA
+ scrot -s -e 'image_viewer $f'
+
+ super + shift + equal
+ sxiv -rt "$HOME/image"
+
+ XF86LaunchB
+ xdotool selectwindow | xsel -bi
+
+ super + {h,j,k,l}
+ bspc node -f {west,south,north,east}
+
+ super + alt + {0-9}
+ mpc -q seek {0-9}0%
+
+ super + {alt,ctrl,alt + ctrl} + XF86Eject
+ sudo systemctl {suspend,reboot,poweroff}
+
+ super + {_,shift + }{h,j,k,l}
+ bspc node -{f,s} {west,south,north,east}
+
+ {_,shift + ,super + }XF86MonBrightness{Down,Up}
+ bright {-1,-10,min,+1,+10,max}
+
+ super + o ; {e,w,m}
+ {gvim,firefox,thunderbird}
+
+ super + alt + control + {h,j,k,l} ; {0-9}
+ bspc node @{west,south,north,east} -r 0.{0-9}
+
+ super + alt + p
+ bspc config focus_follows_pointer {true,false}
+
+## Editor Plugins
+
+### Vim
+
+- [vim-sxhkdrc](https://github.com/baskerville/vim-sxhkdrc).
+- [sxhkd-vim](https://github.com/kovetskiy/sxhkd-vim).
diff --git a/doc/sxhkd.1.txt b/doc/sxhkd.1.txt
@@ -110,48 +110,6 @@ In addition, the sequences can contain ranges of the form _A_-_Z_ where _A_ and
The underscore character represents an empty sequence element.
-
-Example Bindings
-----------------
-
-----
-XF86Audio{Prev,Next}
- mpc -q {prev,next}
-
-@XF86LaunchA
- scrot -s -e 'image_viewer $f'
-
-super + shift + equal
- sxiv -rt "$HOME/image"
-
-XF86LaunchB
- xdotool selectwindow | xsel -bi
-
-super + {h,j,k,l}
- bspc node -f {west,south,north,east}
-
-super + alt + {0-9}
- mpc -q seek {0-9}0%
-
-super + {alt,ctrl,alt + ctrl} + XF86Eject
- sudo systemctl {suspend,reboot,poweroff}
-
-super + {_,shift + }{h,j,k,l}
- bspc node -{f,s} {west,south,north,east}
-
-{_,shift + ,super + }XF86MonBrightness{Down,Up}
- bright {-1,-10,min,+1,+10,max}
-
-super + o ; {e,w,m}
- {gvim,firefox,thunderbird}
-
-super + alt + control + {h,j,k,l} ; {0-9}
- bspc node @{west,south,north,east} -r 0.{0-9}
-
-super + alt + p
- bspc config focus_follows_pointer {true,false}
-----
-
Author
------
