New logo

[bspwm.git] / README.md

diff --git a/README.md b/README.md
index 985d6f37fed673883692d6917e922b3de29ec0e2..05dda6c39de4f5dddc93593d89e3b9d0f13a1733 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
 
@@ -10,7 +10,7 @@ The windows are represented as the leaves of a binary tree.
 
 `bspwm` have only two sources of informations: the X events it receives and the messages it reads on a dedicated socket.
 
-Those messages are sent through the `bspc` program.
+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.
 
@@ -67,7 +67,7 @@ was sent beforehand:
 
 ## Messages
 
-The syntax for the client is `bspc COMMAND ARGUMENTS ...`.
+The syntax for the client is `bspc MESSAGE [ARGUMENTS ...]`.
 
 The following messages are handled:
 
@@ -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]
@@ -99,10 +99,10 @@ The following messages are handled:
         Set the splitting ratio of the focused window.
 
     focus left|right|up|down
-        Focus the neighbor window situated in the given direction. 
+        Focus the neighbor window situated in the given direction.
 
     shift left|right|up|down
-        Exchange the current window with the given neighbor. 
+        Exchange the current window with the given neighbor.
 
     push left|right|up|down
         Push the fence located in the given direction.
@@ -116,6 +116,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.
 
@@ -123,7 +126,7 @@ The following messages are handled:
         Toggle the floating state of the current window.
 
     toggle_locked
-        Toggle the locked state of the current window (locked windows will not respond to the 'close' command).
+        Toggle the locked state of the current window (locked windows will not respond to the 'close' message).
 
     close
         Close the focused window.
@@ -169,9 +172,9 @@ 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 +182,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.
@@ -209,13 +212,13 @@ Colors are either [X color names](http://en.wikipedia.org/wiki/X11_color_names)
 
     normal_border_color
         Color of the main border of an unfocused window.
-    
+
     inner_border_color
         Color of the inner border of a window.
 
     outer_border_color
         Color of the outer border of a window.
-    
+
     presel_border_color
         Color of the *presel* message feedback.
 
@@ -249,11 +252,20 @@ Colors are either [X color names](http://en.wikipedia.org/wiki/X11_color_names)
         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').
 
-    borderless_monocle 
+    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.