Merge branch 'master' into status

[bspwm.git] / bspwm.1

diff --git a/bspwm.1 b/bspwm.1
index a4bf1ce34aeb1c8e0dbaed1b7984768fd89d0b74..b2b182f78194b1ac6279a89caa22bd5faba5bcab 100644 (file)
--- a/bspwm.1
+++ b/bspwm.1
@@ -2,8 +2,8 @@
 .SH NAME
 bspwm \- Tiling window manager based on binary space partitioning
 .SH SYNOPSIS
-.BI bspwm
-.RI [ -v ]
+.B bspwm
+.RI [ -v | "-s STATUS_FIFO" ]
 .P
 .BI bspc " MESSAGE"
 .RI [ ARGUMENTS ]
@@ -28,7 +28,7 @@ environment variable is defined, it will be used as the socket path, otherwise
 is used.
 .P
 The recommended way of defining keyboard shortcuts is to use
-.BR xbindkeys .
+.BR shkd " or " xbindkeys .
 .P
 The only way to configure
 .B bspwm
@@ -104,7 +104,7 @@ Return the value of the given setting.
 .BI set " SETTING VALUE"
 Set the value of the given setting.
 .TP
-.BI list
+.BI list " [DESKTOP_NAME]"
 Output the internal representation of the window tree.
 .TP
 .BI list_desktops " [--quiet]"
@@ -125,6 +125,9 @@ Switch to automatic mode.
 .BI ratio " VALUE"
 Set the splitting ratio of the focused window.
 .TP
+.BI pad " MONITOR_NAME [TOP_PADDING [RIGHT_PADDING [BOTTOM_PADDING [LEFT_PADDING]]]]"
+Set the padding of the given monitor.
+.TP
 .BI focus " left|right|up|down"
 Focus the neighbor window situated in the given direction.
 .TP
@@ -201,9 +204,9 @@ Select the next or previous monitor.
 .TP
 .BI cycle_desktop " next|prev [--skip-free|--skip-occupied]"
 Select the next or previous desktop.
-
-.BI layout " monocle|tiled"
-Set the layout of the current desktop.
+.TP
+.BI layout " monocle|tiled [DESKTOP_NAME ...]"
+Set the layout of the given desktops (current if none given).
 .TP
 .BI cycle_layout
 Cycle the layout of the current desktop.
@@ -211,8 +214,8 @@ Cycle the layout of the current desktop.
 .BI rotate " clockwise|counter_clockwise|full_cycle"
 Rotate the tree of the current desktop.
 .TP
-.BI rule " PATTERN floating "
-Make a new rule that will float the windows whose class name or instance name equals PATTERN.
+.BI rule " PATTERN [DESKTOP_NAME] [floating] "
+Create a new rule (PATTERN must match the class or instance name).
 .TP
 .BI adopt_orphans
 Manage all the unmanaged windows remaining from a previous session.
@@ -278,8 +281,8 @@ Width of the inner, main and outer borders.
 .I window_gap
 Value of the gap that separates windows.
 .TP
-.I {top,bottom,left,right}_padding
-Padding space added at the sides of the screen.
+.I {top,right,bottom,left}_padding
+Padding space added at the sides of the current monitor.
 .TP
 .I wm_name
 The value that shall be used for the
@@ -288,7 +291,14 @@ property of the root window.
 .TP
 .I button_modifier
 The modifier mask used for mouse bindings (possible values:
-.BR mod1 " ... " mod5 ).
+.BR shift ", " control ", " lock ", " mod1 " ... " mod5 ).
+.TP
+.I numlock_modifier
+The modifier holding Num_Lock (cf.
+.BR xmodmap (1)).
+.TP
+.I capslock_modifier
+The modifier holding Lock.
 .TP
 .I borderless_monocle
 Whether to remove borders for tiled windows in monocle mode.
@@ -298,6 +308,9 @@ Whether to remove gaps for tiled windows in monocle mode.
 .TP
 .I focus_follows_mouse
 Wether to focus the window under the mouse pointer.
+.TP
+.I adaptative_raise
+Prevent floating windows from being raised when they might cover other floating windows.
 .SH MOUSE BINDINGS
 .TP
 .I button_modifier + left mouse button
@@ -318,6 +331,9 @@ Ivan Kanakarakis <ivan.kanak at gmail.com>
 .SH HOMEPAGE
 .TP
 https://github.com/baskerville/bspwm
+.SH MAILING LIST
+.TP
+bspwm at librelist.com
 .SH SEE ALSO
 .BR monsterwm (1),
 .BR tmux (1).