]> git.lizzy.rs Git - bspwm.git/blobdiff - doc/bspwm.1.txt
Asynchronously parse rule command output
[bspwm.git] / doc / bspwm.1.txt
index dc79dc9934c8b46930a86bccd6566e1a42efd2ba..9417cfe2d47746d1762a30590ee34cf05c53e7ac 100644 (file)
@@ -13,7 +13,7 @@ bspwm - Binary space partitioning window manager
 Synopsis
 --------
 
-*bspwm* [*-h*|*-v*|*-c* 'CONFIG_PATH'|*-s* 'PANEL_FIFO'|*-p* 'PANEL_PREFIX']
+*bspwm* [*-h*|*-v*|*-c* 'CONFIG_PATH']
 
 *bspc* 'COMMAND' ['ARGUMENTS']
 
@@ -37,13 +37,6 @@ Options
 *-c* 'CONFIG_PATH'::
     Use the given configuration file.
 
-*-s* 'PANEL_FIFO'::
-    Write the internal state to the given FIFO.
-
-*-p* 'PANEL_PREFIX'::
-    Start every line written to the 'PANEL_FIFO' with the given prefix.
-
-
 Configuration
 -------------
 
@@ -334,7 +327,7 @@ Options
 *-R*, *--rotate* 'DIR' '90|270|180'::
     Rotate the tree holding the edge located in the given direction in relation to the selected window.
 
-*-t*, *--toggle* floating|fullscreen|locked|sticky|visible[=on|off]::
+*-t*, *--toggle* floating|fullscreen|locked|sticky|private[=on|off]::
     Set or toggle the given state for the selected window.
 
 *-c*, *--close*::
@@ -386,6 +379,10 @@ Options
 *-C*, *--circulate* forward|backward::
     Circulate the leaves of the tree of the selected desktop.
 
+*-t*, *--toggle* floating[=on|off]::
+    Set or toggle the given state for the selected desktop.
+
+
 Monitor
 ~~~~~~~
 
@@ -414,40 +411,6 @@ Options
 *-s*, *--swap* 'MONITOR_SEL'::
     Swap the selected monitor with the given monitor.
 
-Tag
-~~~
-
-General Syntax
-^^^^^^^^^^^^^^
-
-tag 'OPTIONS'
-
-Options
-^^^^^^^
-*-l*, *--list*::
-    List the tags.
-
-*-a*, *--add* <name>...::
-    Create tags with the given names.
-
-*-r*, *--remove* <name>|^<n>...::
-    Remove tags with the given names or indexes.
-
-*-e*, *--enumerate-tags* <name>...::
-    Rename, add or remove tags depending on whether the number of given names is equal, superior or inferior to the number of existing tags.
-
-*-d*, *--desktop* 'DESKTOP_SEL'::
-    Select the given desktop as target for the *-s* and *-t* options.
-
-*-w*, *--window* 'WINDOW_SEL'::
-    Select the given window as target for the *-s* and *-t* options.
-
-*-s*, *--set-tags* (<name>|^<n>...)|all::
-    Set the tags of the selected object.
-
-*-t*, *--toggle-tags* (<name>|^<n>)[=on|off]...::
-    Toggle the tags of the selected object.
-
 Query
 ~~~~~
 
@@ -513,15 +476,15 @@ Options
 *--adopt-orphans*::
     Manage all the unmanaged windows remaining from a previous session.
 
-*--put-status*::
-    Write the current internal state to the panel FIFO.
-
 *--toggle-visibility*::
     Toggle the visibility of all the windows.
 
 *--record-history* on|off::
     Enable or disable the recording of window focus history.
 
+*--subscribe*::
+    Continuously print status informations on standard output.
+
 Pointer
 ~~~~~~~
 
@@ -533,31 +496,14 @@ pointer 'OPTIONS'
 Options
 ^^^^^^^
 
-*-t*, *--track* <x> <y>::
-    Pass the pointer root coordinates for the current pointer action.
-
 *-g*, *--grab* focus|move|resize_side|resize_corner::
-    Perform the given pointer action.
-
-Rule
-~~~~
-
-General Syntax
-^^^^^^^^^^^^^^
+    Initiate the given pointer action.
 
-rule 'OPTIONS'
-
-Options
-^^^^^^^
-
-*-a*, *--add* <class_name>|<instance_name> [-d 'DESKTOP_SEL' [--follow]] [--tags <name>|^<n>[,...]][--floating] [--fullscreen] [--locked] [--sticky] [--focus] [--frame] [--unmanage] [--one-shot]::
-    Create a new rule.
-
-*-r*, *--remove* <name>|^<n>|tail|head...::
-    Remove the rules with the given names or indexes.
+*-t*, *--track* <x> <y>::
+    Pass the pointer root coordinates for the current pointer action.
 
-*-l*, *--list* [<name>]::
-    List the rules.
+*-u*, *--ungrab*::
+    Terminate the current pointer action.
 
 Config
 ~~~~~~
@@ -586,6 +532,12 @@ All the boolean settings are 'false' by default.
 Global Settings
 ~~~~~~~~~~~~~~~
 
+'rule_command'::
+    External command used to retrieve rule consequences. The command will receive the the ID of the window being processed as its first argument. The output of that command must have the following format: *key1=value1 key2=value2 ...*, where *keyN* is one of 'floating', 'fullscreen', 'locked', 'sticky', 'private', 'frame', 'center', 'lower', 'follow', 'manage', 'focus', 'desktop' or 'monitor'.
+
+'status_prefix'::
+    Prefix prepended to each of the status lines.
+
 'focused_border_color'::
     Color of the border of a focused window of a focused monitor.
 
@@ -616,6 +568,15 @@ Global Settings
 'normal_sticky_border_color'::
     Color of the border of an unfocused sticky window.
 
+'focused_private_border_color'::
+    Color of the border of a focused private window of a focused monitor.
+
+'active_private_border_color'::
+    Color of the border of a focused private window of an unfocused monitor.
+
+'normal_private_border_color'::
+    Color of the border of an unfocused private window.
+
 'urgent_border_color'::
     Color of the border of an urgent window.
 
@@ -658,8 +619,8 @@ Global Settings
 'apply_floating_atom'::
     Set the value of the '_BSPWM_FLOATING_WINDOW' atom of each window according to its floating state.
 
-'honor_ewmh_focus'::
-    Honor EWMH requests to focus a window.
+'ignore_ewmh_focus'::
+    Ignore EWMH requests to focus a window.
 
 Monitor Settings
 ~~~~~~~~~~~~~~~~
@@ -680,12 +641,10 @@ Desktop Settings
     Window border width.
 
 
-Internal State Format
----------------------
-
-If a 'PANEL_FIFO' is specified, *bspwm* will write informations regarding its current state to it.
+Status Format
+-------------
 
-Those informations are composed of items separated by colons.
+Status informations are composed of items separated by colons.
 
 Each item as the form '<type><value>' where '<type>' is the first character of the item.
 
@@ -716,12 +675,6 @@ Each item as the form '<type><value>' where '<type>' is the first character of t
 'L(tiled|monocle)'::
     Layout of the focused desktop of the focused monitor.
 
-'T<tag_name>'::
-    Selected tag of the focused desktop of the focused monitor.
-
-'t<tag_name>'::
-    Non-selected tag of the focused desktop of the focused monitor.
-
 Environment Variables
 ---------------------