diff --git a/README.md b/README.md index 2c1c3e5..ac1b23a 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,18 @@ window manager written in javascript sure, ~~you sometimes have to Mod4+click a window to get it to focus~~ -~~and~~ it doesn't do tiling +~~and~~ it doesn't do (real) tiling -and the code is all over the place and mad +and the code is all over the place -and ~~sometimes you have to switch to a tty to tell it to refocus the root window~~ +and ~~sometimes you have to switch to a tty to tell it to +refocus the root window~~ -but every keybinding is bound to just a program, just any executable file in `PATH` be it firefox or its own internal programs +but every keybinding is bound to just a program, just any +executable file in `PATH` be it firefox or wireshark or +its own internal programs -here's an example `~/.wmrc`: +here's an example of a `~/.wmrc`: ```ini [keybindings] @@ -34,11 +37,35 @@ M-2 = workspace switch 2 M-3 = workspace switch 3 M-4 = workspace switch 4 M-5 = workspace switch 5 + +# window tile +M-A-comma = window tile left +M-A-period = window tile right +M-A-f = window tile full ``` -now you notice `window move 1` and `workspace switch 1` etc +now you notice `window move 1` and `workspace switch 1` +etc + +those are just commands as well that live in the wm/bin +directory, which is prepended to `PATH` before keybound +commands are executed + +and all those little programs do is write to the socket= +living at /tmp/wm, which the window manager is listening +on and accepts commands to + +## keybinding format -those are just commands as well that live in the wm/bin directory, which is prepended to `PATH` before keybound commands are executed +modifier keys are uppercase: -and all those little programs do is write to the socket= living at /tmp/wm, which the window manager is listening on and accepts commands to +* M: super key (windows key/cmd) +* S: shift +* C: control +* A: alt +all letters are lower case. special keys available so far +are `space`, `return`, `period` and `comma` and `tab`. +also supports the volume keys (`XF86AudioLowerVolume`, +`XF86AudioRaiseVolume`) but no other media keys right now. +(not for any good reason)