bspwm.1

   1 .TH BSPWM 1 bspwm
   2 .SH NAME
   3 bspwm \- Tiling window manager based on binary space partitioning
   4 .SH SYNOPSIS
   5 .BI bspwm
   6 .RI [ -v ]
   7 .P
   8 .BI bspc " MESSAGE"
   9 .RI [ ARGUMENTS ]
  10 .RI [ OPTIONS ]
  11 .SH DESCRIPTION
  12 .B bspwm
  13 is a tiling window manager where each window is represented as the leaf of a binary tree. It is controlled and configured via
  14 .BR bspc .
  15 .SH CONFIGURATION
  16 .B bspwm
  17 have only two sources of informations: the
  18 .B X
  19 events it receives and the messages it reads on a dedicated socket.
  20 .P
  21 Those messages are sent via
  22 .BR bspc .
  23 .P
  24 If the
  25 .I BSPWM_SOCKET
  26 environment variable is defined, it will be used as the socket path, otherwise
  27 .I /tmp/bspwm-socket
  28 is used.
  29 .P
  30 The recommended way of defining keyboard shortcuts is to use
  31 .BR xbindkeys .
  32 .P
  33 The only way to configure
  34 .B bspwm
  35 is by sending
  36 .I set
  37 messages via the client, hence
  38 .BR bspwm \'s
  39 configuration file is an executable called
  40 .I autostart
  41 which lives in
  42 .IR $XDG_CONFIG_HOME/bspwm/ .
  43 .SH SPLITTING MODES
  44 There is only two splitting modes:
  45 .IR automatic " and " manual .
  46 .P
  47 The default mode is
  48 .IR automatic .
  49 The
  50 .I manual
  51 mode is entered by sending a
  52 .B presel
  53 message.
  54 .P
  55 Example: insertion of a new node (number 4) into the given tree in
  56 .I automatic
  57 mode:
  58
  59                  b                                   c
  60                 / \\                                 / \\
  61                3   a              -->              4   b
  62                ^  / \\                              ^  / \\
  63                  2   1                               3   a
  64                                                         / \\
  65                                                        2   1
  66     +-------------------------+         +-------------------------+
  67     |            |            |         |            |            |
  68     |            |     2      |         |            |     3      |
  69     |            |            |         |            |            |
  70     |     3      |------------|   -->   |     4      |------------|
  71     |     ^      |            |         |     ^      |     |      |
  72     |            |     1      |         |            |  1  |  2   |
  73     |            |            |         |            |     |      |
  74     +-------------------------+         +-------------------------+
  75
  76 .P
  77 Same departure, but the mode is
  78 .IR manual ,
  79 and a
  80 .BI presel " up"
  81 message was sent beforehand:
  82
  83                  b                                   b
  84                 / \\                                 / \\
  85                3   a              -->              c   a
  86                ^  / \\                             / \\ / \\
  87                  2   1                           4  3 2  1
  88                                                  ^
  89     +-------------------------+         +-------------------------+
  90     |            |            |         |            |            |
  91     |            |     2      |         |     4      |     2      |
  92     |            |            |         |     ^      |            |
  93     |     3      |------------|   -->   |------------|------------|
  94     |     ^      |            |         |            |            |
  95     |            |     1      |         |     3      |     1      |
  96     |            |            |         |            |            |
  97     +-------------------------+         +-------------------------+
  98
  99 .SH MESSAGES
 100 .TP
 101 .BI get " SETTING"
 102 Return the value of the given setting.
 103 .TP
 104 .BI set " SETTING VALUE"
 105 Set the value of the given setting.
 106 .TP
 107 .BI list
 108 Output the internal representation of the window tree.
 109 .TP
 110 .BI list_desktops " [--quiet]"
 111 Perform a dump of each desktop for the current monitor.
 112 .TP
 113 .BI list_monitors " [--quiet]"
 114 Perform a dump of each monitor.
 115 .TP
 116 .BI list_windows
 117 Return the list of managed windows (i.e. their identifiers).
 118 .TP
 119 .BI presel " left|right|up|down"
 120 Switch to manual mode and select the splitting direction.
 121 .TP
 122 .BI cancel
 123 Switch to automatic mode.
 124 .TP
 125 .BI ratio " VALUE"
 126 Set the splitting ratio of the focused window.
 127 .TP
 128 .BI focus " left|right|up|down"
 129 Focus the neighbor window situated in the given direction.
 130 .TP
 131 .BI shift " left|right|up|down"
 132 Exchange the current window with the given neighbor.
 133 .TP
 134 .BI push " left|right|up|down"
 135 Push the fence located in the given direction.
 136 .TP
 137 .BI pull " left|right|up|down"
 138 Pull the fence located in the given direction.
 139 .TP
 140 .BI cycle " next|prev [--skip-floating|--skip-tiled|--skip-class-equal|--skip-class-differ]"
 141 Focus the next or previous window matching the given constraints.
 142 .TP
 143 .BI nearest " older|newer [--skip-floating|--skip-tiled|--skip-class-equal|--skip-class-differ]"
 144 Focus the nearest window matching the given constraints.
 145 .TP
 146 .BI toggle_fullscreen
 147 Toggle the fullscreen state of the current window.
 148 .TP
 149 .BI toggle_floating
 150 Toggle the floating state of the current window.
 151 .TP
 152 .BI toggle_locked
 153 Toggle the locked state of the current window (locked windows will not respond to the
 154 .B close
 155 message).
 156 .TP
 157 .BI close
 158 Close the focused window.
 159 .TP
 160 .BI kill
 161 Kill the focused window.
 162 .TP
 163 .BI send_to " DESKTOP_NAME"
 164 Send the focused window to the given desktop.
 165 .TP
 166 .BI send_to_monitor " MONITOR_NAME"
 167 Send the focused window to the given monitor.
 168 .TP
 169 .BI use " DESKTOP_NAME"
 170 Select the given desktop.
 171 .TP
 172 .BI use_monitor " MONITOR_NAME"
 173 Select the given monitor.
 174 .TP
 175 .BI alternate
 176 Alternate between the current and the last focused window.
 177 .TP
 178 .BI alternate_desktop
 179 Alternate between the current and the last focused desktop.
 180 .TP
 181 .BI alternate_monitor
 182 Alternate between the current and the last focused monitor.
 183 .TP
 184 .BI add " DESKTOP_NAME ..."
 185 Make new desktops with the given names.
 186 .TP
 187 .BI add_in " MONITOR_NAME DESKTOP_NAME ..."
 188 Make new desktops with the given names in the given monitor.
 189 .TP
 190 .BI rename_monitor " CURRENT_NAME NEW_NAME"
 191 Rename the monitor named CURRENT_NAME to NEW_NAME.
 192 .TP
 193 .BI rename " CURRENT_NAME NEW_NAME"
 194 Rename the desktop named CURRENT_NAME to NEW_NAME.
 195 .TP
 196 .BI cycle_monitor " next|prev"
 197 Select the next or previous monitor.
 198 .TP
 199 .BI cycle_desktop " next|prev [--skip-free|--skip-occupied]"
 200 Select the next or previous desktop.
 201
 202 .BI layout " monocle|tiled"
 203 Set the layout of the current desktop.
 204 .TP
 205 .BI cycle_layout
 206 Cycle the layout of the current desktop.
 207 .TP
 208 .BI rotate " clockwise|counter_clockwise|full_cycle"
 209 Rotate the tree of the current desktop.
 210 .TP
 211 .BI magnetise " top_left|top_right|bottom_left|bottom_right"
 212 Move all the fences toward the given corner.
 213 .TP
 214 .BI rule " PATTERN floating "
 215 Make a new rule that will float the windows whose class name or instance name equals PATTERN.
 216 .TP
 217 .BI adopt_orphans
 218 Manage all the unmanaged windows remaining from a previous session.
 219 .TP
 220 .BI reload_autostart
 221 Reload the autostart file.
 222 .TP
 223 .BI reload_settings
 224 Reload the default settings.
 225 .TP
 226 .BI reload
 227 Reload the autostart file and the default settings.
 228 .TP
 229 .BI quit
 230 Quit.
 231 .SH SETTINGS
 232 Colors are either
 233 .B X
 234 color names (cf.
 235 .I COLOR NAMES
 236 in
 237 .BR X (7))
 238 or
 239 .I #RRGGBB
 240 , booleans are
 241 .IR "true " "or " false .
 242 .TP
 243 .I focused_border_color
 244 Color of the main border of a focused window of a focused monitor.
 245 .TP
 246 .I active_border_color
 247 Color of the main border of a focused window of an unfocused monitor.
 248 .TP
 249 .I normal_border_color
 250 Color of the main border of an unfocused window.
 251 .TP
 252 .I inner_border_color
 253 Color of the inner border of a window.
 254 .TP
 255 .I outer_border_color
 256 Color of the outer border of a window.
 257 .TP
 258 .I presel_border_color
 259 Color of the
 260 .B presel
 261 message feedback.
 262 .TP
 263 .I focused_locked_border_color
 264 Color of the main border of a focused locked window of a focused monitor.
 265 .TP
 266 .I active_locked_border_color
 267 Color of the main border of a focused locked window of an unfocused monitor.
 268 .TP
 269 .I normal_locked_border_color
 270 Color of the main border of an unfocused locked window.
 271 .TP
 272 .I urgent_border_color
 273 Color of the border of an urgent window.
 274 .TP
 275 .I {inner,main,outer}_border_width
 276 Width of the inner, main and outer borders.
 277 .TP
 278 .I window_gap
 279 Value of the gap that separates windows.
 280 .TP
 281 .I {top,bottom,left,right}_padding
 282 Padding space added at the sides of the screen.
 283 .TP
 284 .I wm_name
 285 The value that shall be used for the
 286 .B _NET_WM_NAME
 287 property of the root window.
 288 .TP
 289 .I button_modifier
 290 The modifier mask used for mouse bindings (possible values:
 291 .BR mod1 " ... " mod5 ).
 292 .TP
 293 .I borderless_monocle
 294 Whether to remove borders for tiled windows in monocle mode.
 295 .TP
 296 .I focus_follows_mouse
 297 Wether to focus the window under the mouse pointer.
 298 .SH MOUSE BINDINGS
 299 .TP
 300 .I button_modifier + left mouse button
 301 Move the window under the pointer.
 302 .TP
 303 .I button_modifier + middle mouse button
 304 Focus the window under the pointer.
 305 .TP
 306 .I button_modifier + right mouse button
 307 Resize the window under the pointer (by moving one of its four corners).
 308 .SH AUTHOR
 309 .EX
 310 Bastien Dejean <baskerville at lavabit.com>
 311 .SH CONTRIBUTORS
 312 .EX
 313 Ivan Kanakarakis <ivan.kanak at gmail.com>
 314 .EE
 315 .SH HOMEPAGE
 316 .TP
 317 https://github.com/baskerville/bspwm
 318 .SH SEE ALSO
 319 .BR monsterwm (1),
 320 .BR tmux (1).