New message: 'list_rules'

[bspwm.git] / README.md

diff --git a/README.md b/README.md
index 05dda6c39de4f5dddc93593d89e3b9d0f13a1733..9e8683b3f62b594d2809dc1ce634e7db39f48fed 100644 (file)
--- a/README.md
+++ b/README.md
@@ -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/`.
 
@@ -65,6 +65,12 @@ was sent beforehand:
         |            |            |         |            |            |
         +-------------------------+         +-------------------------+
 
+## Synopsis
+
+    bspwm [-v|-s STATUS_FIFO]
+
+    bspc MESSAGE [ARGUMENTS] [OPTIONS]
+
 ## Messages
 
 The syntax for the client is `bspc MESSAGE [ARGUMENTS ...]`.
@@ -89,7 +95,10 @@ The following messages are handled:
     list_windows
         Return the list of managed windows (i.e. their identifiers).
 
-    presel left|right|up|down
+    list_rules
+        Return the list of rules.
+
+    presel left|right|up|down [SPLIT_RATIO]
         Switch to manual mode and select the splitting direction.
 
     cancel
@@ -98,6 +107,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.
 
@@ -128,16 +140,19 @@ The following messages are handled:
     toggle_locked
         Toggle the locked state of the current window (locked windows will not respond to the 'close' message).
 
+    toggle_visibility
+        Toggle the visibility of all the managed windows.
+
     close
         Close the focused window.
 
     kill
         Kill the focused window.
 
-    send_to DESKTOP_NAME
+    send_to DESKTOP_NAME [--follow]
         Send the focused window to the given desktop.
 
-    send_to_monitor MONITOR_NAME
+    send_to_monitor MONITOR_NAME [--follow]
         Send the focused window to the given monitor.
 
     use DESKTOP_NAME
@@ -194,10 +209,7 @@ The following messages are handled:
     reload_settings
         Reload the default settings.
 
-    reload
-        Reload the autostart file and the default settings.
-
-    quit
+    quit [EXIT_STATUS]
         Quit.
 
 ## Settings
@@ -242,11 +254,8 @@ 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.
@@ -269,6 +278,9 @@ Colors are either [X color names](http://en.wikipedia.org/wiki/X11_color_names)
     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
@@ -290,9 +302,10 @@ Colors are either [X color names](http://en.wikipedia.org/wiki/X11_color_names)
 
 ## Panel
 
-`dzen2` fed with the output of `ewmhstatus`. Example: [launchpanel](https://github.com/baskerville/bin/blob/master/launchpanel).
-
-Or any EWMH compliant panel.
+Multiple choices:
+- `dzen2` fed with the output of `ewmhstatus`. Example: [launchpanel](https://github.com/baskerville/bin/blob/master/launchpanel).
+- A custom panel if the `-s` flag is used (have a look at the files in `examples/`).
+- Any EWMH compliant panel (e.g. `tint2`, `bmpanel2`, etc.).
 
 ## Required Libraries:
 
@@ -308,3 +321,7 @@ Or any EWMH compliant panel.
 ## Contributors
 
 - [Ivan Kanakarakis](https://github.com/c00kiemon5ter)
+
+## Mailing List
+
+bspwm *at* librelist *dot* com.