Asynchronously parse rule command output

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

diff --git a/doc/bspwm.1.txt b/doc/bspwm.1.txt
index a468043c7c521fdd90e0e02c0d225aa3c889591e..9417cfe2d47746d1762a30590ee34cf05c53e7ac 100644 (file)
--- a/doc/bspwm.1.txt
+++ b/doc/bspwm.1.txt
@@ -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
 -------------
 
@@ -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
 ~~~~~~~
 
@@ -479,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
 ~~~~~~~
 
@@ -508,26 +505,6 @@ Options
 *-u*, *--ungrab*::
     Terminate the current pointer action.
 
-Rule
-~~~~
-
-General Syntax
-^^^^^^^^^^^^^^
-
-rule 'OPTIONS'
-
-Options
-^^^^^^^
-
-*-a*, *--add* <class_name>|<instance_name> [-d 'DESKTOP_SEL' [--follow]] [--floating] [--fullscreen] [--locked] [--sticky] [--focus] [--frame] [--private] [--center] [--unmanage] [--one-shot]::
-    Create a new rule.
-
-*-r*, *--remove* <name>|^<n>|tail|head...::
-    Remove the rules with the given names or indexes.
-
-*-l*, *--list* [<name>]::
-    List the rules.
-
 Config
 ~~~~~~
 
@@ -555,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.
 
@@ -658,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.