New setting: leaf_monocle

[bspwm.git] / doc / bspwm.1.txt

diff --git a/doc/bspwm.1.txt b/doc/bspwm.1.txt
index 1d3f4a1bc29126929c3acea96bb8afe22927e966..ae073f9d82920a84fb0b3722baa81537d3f3b625 100644 (file)
--- a/doc/bspwm.1.txt
+++ b/doc/bspwm.1.txt
@@ -134,7 +134,7 @@ Select a window.
 
 ----
 WINDOW_SEL := <window_id> 
-            | (DIR|CYCLE_DIR|biggest|last|focused|older|newer)[.floating|.tiled][.like|.unlike][.manual|.automatic][.urgent][.local]
+            | (DIR|CYCLE_DIR|biggest|last|focused|older|newer)[.floating|.tiled][.like|.unlike][.manual|.automatic][.urgent][.local][.unfocused]
 ----
 
 Primary Selectors
@@ -188,6 +188,9 @@ local::
 urgent::
        Only consider urgent windows.
 
+unfocused::
+       Only consider windows other than the focused window.
+
 Desktop
 ~~~~~~~
 
@@ -385,6 +388,9 @@ Options
 *-s*, *--swap* 'DESKTOP_SEL'::
        Swap the selected desktop with the given desktop.
 
+*-b*, *--bubble* 'CYCLE_DIR'::
+       Bubble the selected desktop in the given direction.
+
 *-r*, *--remove*::
        Remove the selected desktop.
 
@@ -512,7 +518,7 @@ Options
 *--record-history* on|off::
        Enable or disable the recording of window focus history.
 
-*--subscribe*::
+*--subscribe* (all|report|monitor|desktop|window|...)*::
        Continuously print status information.
 
 *--get-status*::
@@ -549,7 +555,7 @@ rule 'OPTIONS'
 Options
 ^^^^^^^
 
-*-a*, *--add* <class_name>|<instance_name>|* [*-o*|*--one-shot*] [monitor=MONITOR_SEL|desktop=DESKTOP_SEL|window=WINDOW_SEL] [(floating|fullscreen|pseudo_tiled|locked|sticky|private|center|follow|manage|focus|border)=(on|off)] [split_dir=DIR]::
+*-a*, *--add* <class_name>|<instance_name>|* [*-o*|*--one-shot*] [monitor=MONITOR_SEL|desktop=DESKTOP_SEL|window=WINDOW_SEL] [(floating|fullscreen|pseudo_tiled|locked|sticky|private|center|follow|manage|focus|border)=(on|off)] [split_dir=DIR] [split_ratio=RATIO]::
        Create a new rule.
 
 *-r*, *--remove* ^<n>|head|tail|<class_name>|<instance_name>|*...::
@@ -591,9 +597,9 @@ If the server can't handle a message, *bspc* will return with one of the followi
 
 Settings
 --------
-Colors are either http://en.wikipedia.org/wiki/X11_color_names[X color names] or '#RRGGBB', booleans are 'true' or 'false'.
+Colors are either '#RRGGBB' or http://en.wikipedia.org/wiki/X11_color_names[X color names], booleans are 'true', 'on', 'false' or 'off'.
 
-All the boolean settings are 'false' by default.
+All the boolean settings are 'false' by default unless stated otherwise.
 
 Global Settings
 ~~~~~~~~~~~~~~~
@@ -649,6 +655,9 @@ Global Settings
 'external_rules_command'::
        External command used to retrieve rule consequences. The command will receive the the ID of the window being processed as its first argument and the class and instance names as second and third arguments. The output of that command must have the following format: *key1=value1 key2=value2 ...* (the valid key/value pairs are given in the description of the 'rule' command).
 
+'initial_polarity'::
+       On which child should a new window be attached when adding a window on a single window tree in automatic mode. Accept the following values: *first_child*, *second_child*.
+
 'history_aware_focus'::
        Give priority to the focus history when focusing nodes.
 
@@ -661,9 +670,15 @@ Global Settings
 'gapless_monocle'::
        Remove gaps for tiled windows in monocle mode.
 
+'leaf_monocle'::
+       Use monocle layout if there is a single node.
+
 'focus_follows_pointer'::
        Focus the window under the pointer.
 
+'pointer_follows_focus'::
+       When focusing a window, put the pointer at its center.
+
 'pointer_follows_monitor'::
        When focusing a monitor, put the pointer at its center.
 
@@ -679,6 +694,9 @@ Global Settings
 'ignore_ewmh_focus'::
        Ignore EWMH focus requests coming from applications.
 
+'center_pseudo_tiled'::
+       Center pseudo tiled windows into their tiling rectangles. Defaults to 'true'.
+
 'remove_disabled_monitors'::
        Consider disabled monitors as disconnected.
 
@@ -748,20 +766,20 @@ Environment Variables
 ---------------------
 
 'BSPWM_SOCKET'::
-       The path of the socket used for the communication between *bspc* and *bspwm*. If it isn't defined, then the following path is used: '/tmp/bspwm<display_name>-socket'.
+       The path of the socket used for the communication between *bspc* and *bspwm*. If it isn't defined, then the following path is used: '/tmp/bspwm<host_name>_<display_number>_<screen_number>-socket'.
 
 Panels
 ------
 
 * Any EWMH compliant panel (e.g.: 'tint2', 'bmpanel2', etc.).
-* A custom panel if the '-s' flag is used (have a look at the files in 'examples/panel').
+* A custom panel (have a look at the files in 'examples/panel').
 
 Key Features
 ------------
 
 * Configured and controlled through messages.
-* Multiple monitors support (via 'RandR').
-* EWMH support (*tint2* works).
+* Multiple monitors support.
+* EWMH support.
 * Hybrid tiling.
 
 Contributors