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 shkd " or " 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 " [DESKTOP_NAME]"
 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 pad " MONITOR_NAME [TOP_PADDING [RIGHT_PADDING [BOTTOM_PADDING [LEFT_PADDING]]]]"
 129 Set the padding of the given monitor.
 130 .TP
 131 .BI focus " left|right|up|down"
 132 Focus the neighbor window situated in the given direction.
 133 .TP
 134 .BI shift " left|right|up|down"
 135 Exchange the current window with the given neighbor.
 136 .TP
 137 .BI push " left|right|up|down"
 138 Push the fence located in the given direction.
 139 .TP
 140 .BI pull " left|right|up|down"
 141 Pull the fence located in the given direction.
 142 .TP
 143 .BI cycle " next|prev [--skip-floating|--skip-tiled|--skip-class-equal|--skip-class-differ]"
 144 Focus the next or previous window matching the given constraints.
 145 .TP
 146 .BI nearest " older|newer [--skip-floating|--skip-tiled|--skip-class-equal|--skip-class-differ]"
 147 Focus the nearest window matching the given constraints.
 148 .TP
 149 .BI circulate " forward|backward"
 150 Circulate the leaves in the given direction.
 151 .TP
 152 .BI toggle_fullscreen
 153 Toggle the fullscreen state of the current window.
 154 .TP
 155 .BI toggle_floating
 156 Toggle the floating state of the current window.
 157 .TP
 158 .BI toggle_locked
 159 Toggle the locked state of the current window (locked windows will not respond to the
 160 .B close
 161 message).
 162 .TP
 163 .BI close
 164 Close the focused window.
 165 .TP
 166 .BI kill
 167 Kill the focused window.
 168 .TP
 169 .BI send_to " DESKTOP_NAME"
 170 Send the focused window to the given desktop.
 171 .TP
 172 .BI send_to_monitor " MONITOR_NAME"
 173 Send the focused window to the given monitor.
 174 .TP
 175 .BI use " DESKTOP_NAME"
 176 Select the given desktop.
 177 .TP
 178 .BI use_monitor " MONITOR_NAME"
 179 Select the given monitor.
 180 .TP
 181 .BI alternate
 182 Alternate between the current and the last focused window.
 183 .TP
 184 .BI alternate_desktop
 185 Alternate between the current and the last focused desktop.
 186 .TP
 187 .BI alternate_monitor
 188 Alternate between the current and the last focused monitor.
 189 .TP
 190 .BI add " DESKTOP_NAME ..."
 191 Make new desktops with the given names.
 192 .TP
 193 .BI add_in " MONITOR_NAME DESKTOP_NAME ..."
 194 Make new desktops with the given names in the given monitor.
 195 .TP
 196 .BI rename_monitor " CURRENT_NAME NEW_NAME"
 197 Rename the monitor named CURRENT_NAME to NEW_NAME.
 198 .TP
 199 .BI rename " CURRENT_NAME NEW_NAME"
 200 Rename the desktop named CURRENT_NAME to NEW_NAME.
 201 .TP
 202 .BI cycle_monitor " next|prev"
 203 Select the next or previous monitor.
 204 .TP
 205 .BI cycle_desktop " next|prev [--skip-free|--skip-occupied]"
 206 Select the next or previous desktop.
 207 .TP
 208 .BI layout " monocle|tiled [DESKTOP_NAME ...]"
 209 Set the layout of the given desktops (current if none given).
 210 .TP
 211 .BI cycle_layout
 212 Cycle the layout of the current desktop.
 213 .TP
 214 .BI rotate " clockwise|counter_clockwise|full_cycle"
 215 Rotate the tree of the current desktop.
 216 .TP
 217 .BI rule " PATTERN [DESKTOP_NAME] [floating] "
 218 Create a new rule (PATTERN must match the class or instance name).
 219 .TP
 220 .BI adopt_orphans
 221 Manage all the unmanaged windows remaining from a previous session.
 222 .TP
 223 .BI reload_autostart
 224 Reload the autostart file.
 225 .TP
 226 .BI reload_settings
 227 Reload the default settings.
 228 .TP
 229 .BI reload
 230 Reload the autostart file and the default settings.
 231 .TP
 232 .BI quit
 233 Quit.
 234 .SH SETTINGS
 235 Colors are either
 236 .B X
 237 color names (cf.
 238 .I COLOR NAMES
 239 in
 240 .BR X (7))
 241 or
 242 .I #RRGGBB
 243 , booleans are
 244 .IR "true " "or " false .
 245 .TP
 246 .I focused_border_color
 247 Color of the main border of a focused window of a focused monitor.
 248 .TP
 249 .I active_border_color
 250 Color of the main border of a focused window of an unfocused monitor.
 251 .TP
 252 .I normal_border_color
 253 Color of the main border of an unfocused window.
 254 .TP
 255 .I inner_border_color
 256 Color of the inner border of a window.
 257 .TP
 258 .I outer_border_color
 259 Color of the outer border of a window.
 260 .TP
 261 .I presel_border_color
 262 Color of the
 263 .B presel
 264 message feedback.
 265 .TP
 266 .I focused_locked_border_color
 267 Color of the main border of a focused locked window of a focused monitor.
 268 .TP
 269 .I active_locked_border_color
 270 Color of the main border of a focused locked window of an unfocused monitor.
 271 .TP
 272 .I normal_locked_border_color
 273 Color of the main border of an unfocused locked window.
 274 .TP
 275 .I urgent_border_color
 276 Color of the border of an urgent window.
 277 .TP
 278 .I {inner,main,outer}_border_width
 279 Width of the inner, main and outer borders.
 280 .TP
 281 .I window_gap
 282 Value of the gap that separates windows.
 283 .TP
 284 .I {top,right,bottom,left}_padding
 285 Padding space added at the sides of the current monitor.
 286 .TP
 287 .I wm_name
 288 The value that shall be used for the
 289 .B _NET_WM_NAME
 290 property of the root window.
 291 .TP
 292 .I button_modifier
 293 The modifier mask used for mouse bindings (possible values:
 294 .BR shift ", " control ", " lock ", " mod1 " ... " mod5 ).
 295 .TP
 296 .I numlock_modifier
 297 The modifier holding Num_Lock (cf.
 298 .BR xmodmap (1)).
 299 .TP
 300 .I capslock_modifier
 301 The modifier holding Lock.
 302 .TP
 303 .I borderless_monocle
 304 Whether to remove borders for tiled windows in monocle mode.
 305 .TP
 306 .I gapless_monocle
 307 Whether to remove gaps for tiled windows in monocle mode.
 308 .TP
 309 .I focus_follows_mouse
 310 Wether to focus the window under the mouse pointer.
 311 .TP
 312 .I adaptative_raise
 313 Prevent floating windows from being raised when they might cover other floating windows.
 314 .TP
 315 .I status_stdout
 316 Output the status of monitors and desktops on stdout.
 317 .SH MOUSE BINDINGS
 318 .TP
 319 .I button_modifier + left mouse button
 320 Move the window under the pointer.
 321 .TP
 322 .I button_modifier + middle mouse button
 323 Focus the window under the pointer.
 324 .TP
 325 .I button_modifier + right mouse button
 326 Resize the window under the pointer (by moving one of its four corners).
 327 .SH AUTHOR
 328 .EX
 329 Bastien Dejean <baskerville at lavabit.com>
 330 .SH CONTRIBUTORS
 331 .EX
 332 Ivan Kanakarakis <ivan.kanak at gmail.com>
 333 .EE
 334 .SH HOMEPAGE
 335 .TP
 336 https://github.com/baskerville/bspwm
 337 .SH SEE ALSO
 338 .BR monsterwm (1),
 339 .BR tmux (1).