Add a `--swap` option to the `monitor` command

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

diff --git a/doc/bspwm.1.txt b/doc/bspwm.1.txt
index 330f747097123f6517325898ca855a05d246b9cb..f4e6c755b6a9421aee8ef3345a4ddef789eebf2c 100644 (file)
--- a/doc/bspwm.1.txt
+++ b/doc/bspwm.1.txt
@@ -13,7 +13,7 @@ bspwm - Tiling window manager based on binary space partitioning
 Synopsis
 --------
 
-*bspwm* [*-h*|*-v*|*-s* 'PANEL_FIFO'|*-p* 'PANEL_PREFIX']
+*bspwm* [*-h*|*-v*|*-c* 'CONFIG_PATH'|*-s* 'PANEL_FIFO'|*-p* 'PANEL_PREFIX']
 
 *bspc* 'COMMAND' ['ARGUMENTS']
 
@@ -34,6 +34,9 @@ Options
 *-v*::
     Print the version and exit.
 
+*-c* 'CONFIG_PATH'::
+    Use the given configuration file.
+
 *-s* 'PANEL_FIFO'::
     Write the internal state to the given FIFO.
 
@@ -46,7 +49,7 @@ Configuration
 
 *bspwm* have only two sources of informations: the X events it receives and the messages it reads on a dedicated socket.
 
-Its configuration file is '$XDG_CONFIG_HOME/bspwm/autostart'.
+The default configuration file is '$XDG_CONFIG_HOME/bspwm/bspwmrc'.
 
 Keyboard and pointer bindings are defined with https://github.com/baskerville/sxhkd[sxhkd].
 
@@ -138,7 +141,7 @@ Select a window.
 
 ----
 WINDOW_SEL := <window_id> 
-            | (DIR|CYCLE_DIR|biggest|last|focused)[.floating|.tiled][.like|.unlike]
+            | (DIR|CYCLE_DIR|biggest|last|focused)[.floating|.tiled][.like|.unlike][.automatic|.manual][.urgent|.nonurgent]
 ----
 
 Primary Selectors
@@ -175,6 +178,18 @@ like::
 unlike::
     Only consider windows that have a different class than the current window.
 
+automatic::
+    Only consider windows in automatic splitting mode.
+
+manual::
+    Only consider windows in manual splitting mode (see *--presel*).
+
+urgent::
+    Only consider urgent windows.
+
+nonurgent::
+    Only consider nonurgent windows.
+
 Desktop
 ~~~~~~~
 
@@ -182,12 +197,19 @@ Select a desktop.
 
 ----
 DESKTOP_SEL := <desktop_name>
-             | (CYCLE_DIR|last|focused)[.occupied|.free]
+             | ^<n>
+             | (CYCLE_DIR|last|focused)[.occupied|.free][.urgent|.nonurgent]
 ----
 
 Primary Selectors
 ^^^^^^^^^^^^^^^^^
 
+<desktop_name>::
+    Selects the desktop with the given name.
+
+^<n>::
+    Selects the nth desktop.
+
 'CYCLE_DIR'::
     Selects the desktop in the given direction relative to the active desktop.
 
@@ -206,6 +228,12 @@ occupied::
 free::
     Only consider free desktops.
 
+urgent::
+    Only consider urgent desktops.
+
+nonurgent::
+    Only consider nonurgent desktops.
+
 Monitor
 ~~~~~~~
 
@@ -213,18 +241,28 @@ Select a monitor.
 
 ----
 MONITOR_SEL := <monitor_name>
-             | (DIR|CYCLE_DIR|last|focused)[.occupied|.free]
+             | ^<n>
+             | (DIR|CYCLE_DIR|last|primary|focused)[.occupied|.free]
 ----
 
 Primary Selectors
 ^^^^^^^^^^^^^^^^^
 
+<monitor_name>::
+    Selects the monitor with the given name.
+
+^<n>::
+    Selects the nth monitor.
+
 'DIR'::
     Selects the monitor in the given (spacial) direction relative to the active monitor.
 
 'CYCLE_DIR'::
     Selects the monitor in the given (cyclic) direction relative to the active monitor.
 
+primary::
+    Selects the primary monitor.
+
 last::
     Selects the previously focused monitor.
 
@@ -273,11 +311,14 @@ Options
     Preselect the splitting area of the selected window (or cancel the preselection).
 
 *-r*, *--ratio* 'RATIO'::
-    Set the splitting ratio of the selected window.
+    Set the splitting ratio of the selected window (0 < 'RATIO' < 1).
 
 *-e*, *--edge* 'DIR' 'RATIO'|pull|push::
     Set the splitting ratio (or pull, or push) the edge located in the given direction in relation to the selected window.
 
+*-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[=on|off]::
     Set or toggle the given state for the selected window.
 
@@ -352,6 +393,9 @@ Options
 *-n*, *--rename* <new_name>::
     Rename the selected monitor.
 
+*-s*, *--swap* 'MONITOR_SEL'::
+    Swap the selected monitor with the given monitor.
+
 Query
 ~~~~~
 
@@ -445,7 +489,7 @@ rule 'OPTIONS'
 Options
 ^^^^^^^
 
-*-a*, *--add* <pattern> [-d 'DESKTOP_SEL'] [--floating] [--follow]::
+*-a*, *--add* <pattern> [-d 'DESKTOP_SEL' [--follow]] [--floating] [--focus]::
     Create a new rule (<pattern> must match the class or instance name).
 
 *-r*, *--rm* <rule_uid>...::
@@ -512,14 +556,8 @@ All the boolean settings are 'false' by default.
 'split_ratio'::
     Default split ratio.
 
-'top_padding'::
-'right_padding'::
-'bottom_padding'::
-'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.
+'history_aware_focus'::
+    Give priority to the focus history when focusing nodes.
 
 'borderless_monocle'::
     Remove borders for tiled windows in monocle mode.
@@ -536,23 +574,21 @@ All the boolean settings are 'false' by default.
 'adaptative_raise'::
     Prevent floating windows from being raised when they might cover other floating windows.
 
-'apply_shadow_property'::
-    Enable shadows for floating windows via the '_COMPTON_SHADOW' property.
-
 'auto_alternate'::
     Interpret two consecutive identical *use* messages as an *alternate* message.
 
 'auto_cancel'::
     Interpret two consecutive identical *presel* messages as a *cancel* message.
 
-'history_aware_focus'::
-    Give priority to the focus history when focusing nodes.
+'apply_floating_atom'::
+    Set the value of the '_BSPWM_FLOATING_WINDOW' atom of each window according to its floating state.
+
 
 Environment Variables
 ---------------------
 
 'BSPWM_SOCKET'::
-  The path of the socket used for the communication between *bspc* and *bspwm*.
+  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-socket'.
 
 Panels
 ------