Mention 'shkd'

[bspwm.git] / README.md

diff --git a/README.md b/README.md
index cb09fe41ab3d93cbae32d9817604f12d4e28a81a..21df5b4ca72ae237eefabe0d1d7d08b289d502c2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-![logo](https://github.com/baskerville/bspwm/raw/master/resources/bspwm_logo.png)
+![logo](https://github.com/baskerville/bspwm/raw/master/logo/bspwm-logo.png)
 
 ## Description
 
@@ -14,7 +14,7 @@ Those messages are sent via `bspc`.
 
 If the `BSPWM_SOCKET` environment variable is defined, it will be used as the socket path, otherwise `/tmp/bspwm-socket` is used.
 
-The recommended way of defining keyboard shortcuts is to use `xbindkeys`.
+The recommended way of defining keyboard shortcuts is to use `shkd` or `xbindkeys`.
 
 The only way to configure `bspwm` is by sending *set* messages via the client, hence `bspwm`'s configuration file is an executable called `autostart` which lives in `$XDG_CONFIG_HOME/bspwm/`.
 
@@ -77,7 +77,7 @@ The following messages are handled:
     set SETTING VALUE
         Set the value of the given setting.
 
-    list
+    list [DESKTOP_NAME]
         Output the internal representation of the window tree.
 
     list_desktops [--quiet]
@@ -98,6 +98,9 @@ The following messages are handled:
     ratio VALUE
         Set the splitting ratio of the focused window.
 
+    pad MONITOR_NAME [TOP_PADDING [RIGHT_PADDING [BOTTOM_PADDING [LEFT_PADDING]]]]
+        Set the padding of the given monitor.
+
     focus left|right|up|down
         Focus the neighbor window situated in the given direction.
 
@@ -116,6 +119,9 @@ The following messages are handled:
     nearest older|newer [--skip-floating|--skip-tiled|--skip-class-equal|--skip-class-differ]
         Focus the nearest window matching the given constraints.
 
+    circulate forward|backward
+        Circulate the leaves in the given direction.
+
     toggle_fullscreen
         Toggle the fullscreen state of the current window.
 
@@ -170,8 +176,8 @@ The following messages are handled:
     cycle_desktop next|prev [--skip-free|--skip-occupied]
         Select the next or previous desktop.
 
-    layout monocle|tiled
-        Set the layout of the current desktop.
+    layout monocle|tiled [DESKTOP_NAME ...]
+        Set the layout of the given desktops (current if none given).
 
     cycle_layout
         Cycle the layout of the current desktop.
@@ -179,11 +185,11 @@ The following messages are handled:
     rotate clockwise|counter_clockwise|full_cycle
         Rotate the tree of the current desktop.
 
-    magnetise top_left|top_right|bottom_left|bottom_right
-        Move all the fences toward the given corner.
+    rule PATTERN [DESKTOP_NAME] [floating]
+        Create a new rule (PATTERN must match the class or instance name).
 
-    rule PATTERN floating
-        Make a new rule that will float the windows whose class name or instance name equals PATTERN.
+    adopt_orphans
+        Manage all the unmanaged windows remaining from a previous session.
 
     reload_autostart
         Reload the autostart file.
@@ -239,24 +245,33 @@ Colors are either [X color names](http://en.wikipedia.org/wiki/X11_color_names)
     window_gap
         Value of the gap that separates windows.
 
-    top_padding
-    bottom_padding
-    left_padding
-    right_padding
-        Padding space added at the sides of the screen.
+    {top,right,bottom,left}_padding
+        Padding space added at the sides of the current monitor.
 
     wm_name
         The value that shall be used for the _NET_WM_NAME property of the root window.
 
     button_modifier
-        The modifier mask used for mouse bindings (possible values: 'mod1' ... 'mod5').
+        The modifier mask used for mouse bindings (possible values: 'shift', 'control', 'lock', 'mod1' ... 'mod5').
+
+    numlock_modifier
+        The modifier holding Num_Lock (cf. xmodmap).
+
+    capslock_modifier
+        The modifier holding Lock.
 
     borderless_monocle
         Whether to remove borders for tiled windows in monocle mode.
 
+    gapless_monocle
+        Whether to remove gaps for tiled windows in monocle mode.
+
     focus_follows_mouse
         Wether to focus the window under the mouse pointer.
 
+    adaptative_raise
+        Prevent floating windows from being raised when they might cover other floating windows.
+
 ## Mouse Bindings
 
     button_modifier + left mouse button