.\" Title: bspwm
.\" Author: [see the "Author" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 07/19/2014
+.\" Date: 11/26/2015
.\" Manual: Bspwm Manual
-.\" Source: Bspwm 0.8.9
+.\" Source: Bspwm 0.9
.\" Language: English
.\"
-.TH "BSPWM" "1" "07/19/2014" "Bspwm 0\&.8\&.9" "Bspwm Manual"
+.TH "BSPWM" "1" "11/26/2015" "Bspwm 0\&.9" "Bspwm Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.RS 4
Use the given configuration file\&.
.RE
-.SH "CONFIGURATION"
-.sp
-\fBbspwm\fR has only two sources of informations: the X events it receives and the messages it reads on a dedicated socket\&.
-.sp
-The default configuration file is \fI$XDG_CONFIG_HOME/bspwm/bspwmrc\fR\&.
-.sp
-Keyboard and pointer bindings are defined with sxhkd\&.
-.sp
-Example configuration files can be found in the \fBexamples\fR directory\&.
-.SH "SPLITTING MODES"
-.sp
-New windows are inserted in the tree as close as possible to the focused window\&.
-.sp
-There is only two splitting modes: \fIautomatic\fR and \fImanual\fR\&.
-.sp
-The default mode is \fIautomatic\fR\&. The \fImanual\fR mode is entered by sending a \fBpreselection\fR message\&.
-.sp
-Example: insertion of a new node (number 4) into the given tree in \fIautomatic\fR mode:
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
- b c
- / \e / \e
- 3 a \-\-> 4 b
- ^ / \e ^ / \e
- 2 1 3 a
- / \e
- 2 1
- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
- | | | | | |
- | | 2 | | | 3 |
- | | | | | |
- | 3 |\-\-\-\-\-\-\-\-\-\-\-\-| \-\-> | 4 |\-\-\-\-\-\-\-\-\-\-\-\-|
- | ^ | | | ^ | | |
- | | 1 | | | 1 | 2 |
- | | | | | | |
- +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
-.fi
-.if n \{\
-.RE
-.\}
-.sp
-Same departure, but the mode is \fImanual\fR, and a \fBwindow \-\-presel up\fR message was sent beforehand:
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
- b b
- / \e / \e
- 3 a \-\-> c a
- ^ / \e / \e / \e
- 2 1 4 3 2 1
- ^
-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
-| | | | | |
-| | 2 | | 4 | 2 |
-| | | | ^ | |
-| 3 |\-\-\-\-\-\-\-\-\-\-\-\-| \-\-> |\-\-\-\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-|
-| ^ | | | | |
-| | 1 | | 3 | 1 |
-| | | | | |
-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
-.fi
-.if n \{\
-.RE
-.\}
-.SH "CONTAINERS"
-.sp
-Each monitor contains at least one desktop\&.
-.sp
-Each desktop contains at most one tree\&.
.SH "COMMON DEFINITIONS"
.sp
.if n \{\
.RE
.\}
.sp
-For obvious reasons, neither desktops nor monitors names may be valid descriptive selectors\&.
+For obvious reasons, neither desktop nor monitor names may be valid descriptive selectors\&.
+.sp
+An exclamation mark can be prepended to certain modifiers in order to reverse their meaning\&.
.SS "Window"
.sp
Select a window\&.
.RS 4
.\}
.nf
-WINDOW_SEL := <window_id>
- | (DIR|CYCLE_DIR|biggest|last|focused|older|newer)[\&.floating|\&.tiled][\&.like|\&.unlike][\&.manual|\&.automatic][\&.urgent][\&.local]
+WINDOW_SEL := (<window_id>|DIR|CYCLE_DIR|biggest|last|focused|older|newer)[\&.[!]automatic][\&.[!](tiled|pseudo_tiled|floating|fullscreen)][\&.[!](below|normal|above)][\&.[!]local][\&.[!]same_class][\&.[!]focused][\&.[!](urgent|sticky|private|locked)]
.fi
.if n \{\
.RE
\fBModifiers\fR
.RS 4
.PP
-floating
+[!](tiled|pseudo_tiled|floating|fullscreen)
.RS 4
-Only consider floating windows\&.
+Only consider windows having or not having the given state\&.
.RE
.PP
-tiled
+[!]automatic
.RS 4
-Only consider tiled windows\&.
+Only consider windows in automatic or manual insertion mode\&.
.RE
.PP
-like
+[!]focused
.RS 4
-Only consider windows that have the same class as the current window\&.
+Only consider focused or unfocused windows\&.
.RE
.PP
-unlike
+[!]same_class
.RS 4
-Only consider windows that have a different class than the current window\&.
+Only consider windows that have or don\(cqt have the same class as the current window\&.
.RE
.PP
-manual
+[!]local
.RS 4
-Only consider windows in manual splitting mode\&.
+Only consider windows in or not in the current desktop\&.
.RE
.PP
-automatic
+[!](private|urgent|sticky|locked)
.RS 4
-Only consider windows in automatic splitting mode\&.
+Only consider windows that have or don\(cqt have the given flag set\&.
.RE
.PP
-local
+[!](below|normal|above)
.RS 4
-Only consider windows of the current desktop\&.
-.RE
-.PP
-urgent
-.RS 4
-Only consider urgent windows\&.
+Only consider windows in or not in the given layer\&.
.RE
.RE
.SS "Desktop"
.RS 4
.\}
.nf
-DESKTOP_SEL := <desktop_name>
- | [MONITOR_SEL:]^<n>
- | (CYCLE_DIR|last|[MONITOR_SEL:]focused|older|newer)[\&.occupied|\&.free][\&.urgent][\&.local]
+DESKTOP_SEL := (<desktop_name>|[MONITOR_SEL:](focused|^<n>)CYCLE_DIR|last|older|newer)[\&.[!]occupied][\&.[!]focused][\&.[!]urgent][\&.[!]local]
.fi
.if n \{\
.RE
\fBModifiers\fR
.RS 4
.PP
-occupied
+[!]occupied
.RS 4
-Only consider occupied desktops\&.
+Only consider occupied or free desktops\&.
.RE
.PP
-free
+[!]focused
.RS 4
-Only consider free desktops\&.
+Only consider focused or unfocused desktops\&.
.RE
.PP
-urgent
+[!]urgent
.RS 4
-Only consider urgent desktops\&.
+Only consider urgent or non urgent desktops\&.
.RE
.PP
-local
+[!]local
.RS 4
-Only consider desktops of the current monitor\&.
+Only consider inside or outside of the current monitor\&.
.RE
.RE
.SS "Monitor"
.RS 4
.\}
.nf
-MONITOR_SEL := <monitor_name>
- | ^<n>
- | (DIR|CYCLE_DIR|last|primary|focused|older|newer)[\&.occupied|\&.free]
+MONITOR_SEL := (<monitor_name>|^<n>|DIR|CYCLE_DIR|last|primary|focused|older|newer)[\&.[!]occupied][\&.[!]focused]
.fi
.if n \{\
.RE
\fBModifiers\fR
.RS 4
.PP
-occupied
+[!]occupied
.RS 4
-Only consider monitors where the focused desktop is occupied\&.
+Only consider monitors where the focused desktop is occupied or free\&.
.RE
.PP
-free
+[!]focused
.RS 4
-Only consider monitors where the focused desktop is free\&.
+Only consider focused or unfocused monitors\&.
.RE
.RE
.SH "WINDOW STATES"
.PP
-floating
+tiled
.RS 4
-Is above any tiled window and can be moved/resized freely\&. Although it doesn\(cqt occupy any tiling space, it is still part of the window tree\&.
+Its size and position are determined by the splitting type and ratio of each node of its path in the window tree\&.
.RE
.PP
pseudo_tiled
.RS 4
-Has a libre size while being centered in its tiling space\&.
+Has an unrestricted size while being centered in its tiling space\&.
+.RE
+.PP
+floating
+.RS 4
+Can be moved/resized freely\&. Although it doesn\(cqt occupy any tiling space, it is still part of the window tree\&.
.RE
.PP
fullscreen
.RS 4
-Fills its monitor rectangle, is above all the other windows and has no borders\&.
+Fills its monitor rectangle and has no borders\&. It is send in the ABOVE layer by default\&.
.RE
+.SH "WINDOW FLAGS"
.PP
locked
.RS 4
Ignores the
-\fBclose\fR
+\fBwindow \-\-close\fR
message\&.
.RE
.PP
.RS 4
Tries to keep the same tiling position/size\&.
.RE
+.PP
+urgent
+.RS 4
+Has its urgency hint set\&. This flag is set externally\&.
+.RE
+.SH "STACKING LAYERS"
+.sp
+There\(cqs three stacking layers: BELOW, NORMAL and ABOVE\&.
+.sp
+In each layer, the window are orderered as follow: tiled & pseudo\-tiled < fullscreen < floating\&.
.SH "COMMANDS"
.SS "Window"
.sp
Focus the selected or given window\&.
.RE
.PP
+\fB\-a\fR, \fB\-\-activate\fR [\fIWINDOW_SEL\fR]
+.RS 4
+Activate the selected or given window\&.
+.RE
+.PP
\fB\-d\fR, \fB\-\-to\-desktop\fR \fIDESKTOP_SEL\fR
.RS 4
Send the selected window to the given desktop\&.
Rotate the tree holding the edge located in the given direction in relation to the selected window\&.
.RE
.PP
-\fB\-t\fR, \fB\-\-toggle\fR floating|fullscreen|pseudo_tiled|locked|sticky|private[=on|off]
+\fB\-t\fR, \fB\-\-state\fR tiled|pseudo_tiled|floating|fullscreen
+.RS 4
+Set the state of the selected window\&.
+.RE
+.PP
+\fB\-g\fR, \fB\-\-flag\fR locked|sticky|private[=on|off]
.RS 4
-Set or toggle the given state for the selected window\&.
+Set or toggle the given flag for the selected window\&.
+.RE
+.PP
+\fB\-l\fR, \fB\-\-layer\fR below|normal|above
+.RS 4
+Set the stacking layer of the selected window\&.
.RE
.PP
\fB\-c\fR, \fB\-\-close\fR
Swap the selected desktop with the given desktop\&.
.RE
.PP
+\fB\-b\fR, \fB\-\-bubble\fR \fICYCLE_DIR\fR
+.RS 4
+Bubble the selected desktop in the given direction\&.
+.RE
+.PP
\fB\-r\fR, \fB\-\-remove\fR
.RS 4
Remove the selected desktop\&.
.RS 4
Circulate the leaves of the tree of the selected desktop\&.
.RE
-.PP
-\fB\-t\fR, \fB\-\-toggle\fR floating[=on|off]
-.RS 4
-Set or toggle the given state for the selected desktop\&.
-.RE
.RE
.SS "Monitor"
.sp
.PP
\fB\-W\fR, \fB\-\-windows\fR
.RS 4
-List matching windows\&.
+List the IDs of the matching windows\&.
.RE
.PP
\fB\-D\fR, \fB\-\-desktops\fR
.RS 4
-List matching desktops\&.
+List the names of the matching desktops\&.
.RE
.PP
\fB\-M\fR, \fB\-\-monitors\fR
.RS 4
-List matching monitors\&.
+List the names of the matching monitors\&.
.RE
.PP
\fB\-T\fR, \fB\-\-tree\fR
.RS 4
-Print tree rooted at query\&.
+Print a JSON representation of the matching item\&.
.RE
.PP
\fB\-H\fR, \fB\-\-history\fR
.RS 4
-Print the history as it relates to the query\&.
+Print the focus history as it relates to the query\&.
.RE
.PP
\fB\-S\fR, \fB\-\-stack\fR
Enable or disable the recording of window focus history\&.
.RE
.PP
-\fB\-\-subscribe\fR
+\fB\-\-subscribe\fR (all|report|monitor|desktop|window|\&...)*
.RS 4
-Continuously print status informations\&.
+Continuously print status information\&. See the
+\fBEVENTS\fR
+section for the detailed description of each event\&.
.RE
.PP
\fB\-\-get\-status\fR
.RS 4
-Print the current status informations\&.
+Print the current status information\&.
.RE
.RE
.SS "Pointer"
\fBOptions\fR
.RS 4
.PP
-\fB\-a\fR, \fB\-\-add\fR <class_name>|<instance_name>|* [\fB\-o\fR|\fB\-\-one\-shot\fR] [monitor=MONITOR_SEL|desktop=DESKTOP_SEL|window=WINDOW_SEL] [(floating|fullscreen|pseudo_tiled|locked|sticky|private|center|follow|manage|focus)=(true|false)] [split_dir=DIR]
+\fB\-a\fR, \fB\-\-add\fR <class_name>|<instance_name>|* [\fB\-o\fR|\fB\-\-one\-shot\fR] [monitor=MONITOR_SEL|desktop=DESKTOP_SEL|window=WINDOW_SEL] [state=STATE] [layer=LAYER] [split_dir=DIR] [split_ratio=RATIO] [(locked|sticky|private|center|follow|manage|focus|border)=(on|off)]
.RS 4
Create a new rule\&.
.RE
.RE
.SH "SETTINGS"
.sp
-Colors are either X color names or \fI#RRGGBB\fR, booleans are \fItrue\fR or \fIfalse\fR\&.
+Colors are either \fI#RRGGBB\fR or X color names, booleans are \fItrue\fR, \fIon\fR, \fIfalse\fR or \fIoff\fR\&.
.sp
-All the boolean settings are \fIfalse\fR by default\&.
+All the boolean settings are \fIfalse\fR by default unless stated otherwise\&.
.SS "Global Settings"
.PP
\fIfocused_border_color\fR
\fIpresel_border_color\fR
.RS 4
Color of the
-\fBpresel\fR
+\fBwindow \-\-presel\fR
message feedback\&.
.RE
.PP
command)\&.
.RE
.PP
+\fIinitial_polarity\fR
+.RS 4
+On which child should a new window be attached when adding a window on a single window tree in automatic mode\&. Accept the following values:
+\fBfirst_child\fR,
+\fBsecond_child\fR\&.
+.RE
+.PP
\fIhistory_aware_focus\fR
.RS 4
Give priority to the focus history when focusing nodes\&.
.PP
\fIborderless_monocle\fR
.RS 4
-Remove borders for tiled windows in monocle mode\&.
+Remove borders of tiled windows for the
+\fBmonocle\fR
+desktop layout\&.
.RE
.PP
\fIgapless_monocle\fR
.RS 4
-Remove gaps for tiled windows in monocle mode\&.
+Remove gaps of tiled windows for the
+\fBmonocle\fR
+desktop layout\&.
.RE
.PP
-\fIfocus_follows_pointer\fR
+\fIleaf_monocle\fR
.RS 4
-Focus the window under the pointer\&.
+Set the desktop layout to
+\fBmonocle\fR
+if there\(cqs only one tiled window in the tree\&.
.RE
.PP
-\fIpointer_follows_monitor\fR
+\fIfocus_follows_pointer\fR
.RS 4
-When focusing a monitor, put the pointer at its center\&.
+Focus the window under the pointer\&.
.RE
.PP
-\fIauto_alternate\fR
+\fIpointer_follows_focus\fR
.RS 4
-Interpret two consecutive identical
-\fBuse\fR
-messages as an
-\fBalternate\fR
-message\&.
+When focusing a window, put the pointer at its center\&.
.RE
.PP
-\fIauto_cancel\fR
+\fIpointer_follows_monitor\fR
.RS 4
-Interpret two consecutive identical
-\fBpresel\fR
-messages as a
-\fBcancel\fR
-message\&.
+When focusing a monitor, put the pointer at its center\&.
.RE
.PP
-\fIapply_floating_atom\fR
+\fIignore_ewmh_focus\fR
.RS 4
-Set the value of the
-\fI_BSPWM_FLOATING_WINDOW\fR
-atom of each window according to its floating state\&.
+Ignore EWMH focus requests coming from applications\&.
.RE
.PP
-\fIignore_ewmh_focus\fR
+\fIcenter_pseudo_tiled\fR
.RS 4
-Ignore EWMH focus requests coming from applications\&.
+Center pseudo tiled windows into their tiling rectangles\&. Defaults to
+\fItrue\fR\&.
.RE
.PP
\fIremove_disabled_monitors\fR
.RS 4
Size of the gap that separates windows\&.
.RE
-.SH "STATUS FORMAT"
+.SH "EVENTS"
+.PP
+\fIreport\fR
+.RS 4
+See the next section for the description of the format\&.
+.RE
+.PP
+\fImonitor_add <monitor_name> <monitor_id> <monitor_geometry>\fR
+.RS 4
+A monitor is added\&.
+.RE
+.PP
+\fImonitor_rename <old_name> <new_name>\fR
+.RS 4
+A monitor is renamed\&.
+.RE
+.PP
+\fImonitor_remove <monitor_name>\fR
+.RS 4
+A monitor is removed\&.
+.RE
+.PP
+\fImonitor_focus <monitor_name>\fR
+.RS 4
+A monitor is focused\&.
+.RE
+.PP
+\fImonitor_geometry <monitor_name> <monitor_geometry>\fR
+.RS 4
+The geometry of a monitor changed\&.
+.RE
+.PP
+\fIdesktop_add <monitor_name> <desktop_name>\fR
+.RS 4
+A desktop is added\&.
+.RE
+.PP
+\fIdesktop_rename <monitor_name> <old_name> <new_name>\fR
+.RS 4
+A desktop is renamed\&.
+.RE
+.PP
+\fIdesktop_remove <monitor_name> <desktop_name>\fR
+.RS 4
+A desktop is removed\&.
+.RE
+.PP
+\fIdesktop_swap <src_monitor_name> <src_desktop_name> <dst_monitor_name> <dst_desktop_name>\fR
+.RS 4
+A desktop is swapped\&.
+.RE
+.PP
+\fIdesktop_transfer <src_monitor_name> <src_desktop_name> <dst_monitor_name>\fR
+.RS 4
+A desktop is transferred\&.
+.RE
+.PP
+\fIdesktop_focus <monitor_name> <desktop_name>\fR
+.RS 4
+A desktop is focused\&.
+.RE
+.PP
+\fIdesktop_layout <monitor_name> <desktop_name> tiled|monocle\fR
+.RS 4
+The layout of a desktop changed\&.
+.RE
+.PP
+\fIwindow_manage <monitor_name> <desktop_name> <window_id> <ip_id>\fR
+.RS 4
+A window is managed\&.
+.RE
+.PP
+\fIwindow_unmanage <monitor_name> <desktop_name> <window_id>\fR
+.RS 4
+A window is unmanaged\&.
+.RE
+.PP
+\fIwindow_swap <src_monitor_name> <src_desktop_name> <src_window_id> <dst_monitor_name> <dst_desktop_name> <dst_window_id>\fR
+.RS 4
+A window is swapped\&.
+.RE
+.PP
+\fIwindow_transfer <src_monitor_name> <src_desktop_name> <src_window_id> <dst_monitor_name> <dst_desktop_name> <dst_window_id>\fR
+.RS 4
+A window is transferred\&.
+.RE
+.PP
+\fIwindow_focus <monitor_name> <desktop_name> <window_id>\fR
+.RS 4
+A window is focused\&.
+.RE
+.PP
+\fIwindow_activate <monitor_name> <desktop_name> <window_id>\fR
+.RS 4
+A window is activated\&.
+.RE
+.PP
+\fIwindow_geometry <monitor_name> <desktop_name> <window_id> <window_geometry>\fR
+.RS 4
+The geometry of a window changed\&.
+.RE
+.PP
+\fIwindow_state <monitor_name> <desktop_name> <window_id> tiled|pseudo_tiled|floating|fullscreen on|off\fR
+.RS 4
+The state of a window changed\&.
+.RE
+.PP
+\fIwindow_flag <monitor_name> <desktop_name> <window_id> sticky|private|locked|urgent on|off\fR
+.RS 4
+One of the flags of a window changed\&.
+.RE
+.PP
+\fIwindow_layer <monitor_name> <desktop_name> <window_id> below|normal|above\fR
+.RS 4
+The layer of a window changed\&.
+.RE
.sp
-Status informations are composed of items separated by colons\&.
+Please note that \fBbspwm\fR initializes monitors before it reads messages on its socket, therefore the initial monitor events can\(cqt be received\&.
+.SH "REPORT FORMAT"
+.sp
+Each report event message is composed of items separated by colons\&.
.sp
Each item has the form \fI<type><value>\fR where \fI<type>\fR is the first character of the item\&.
.PP
\fBbspc\fR
and
\fBbspwm\fR\&. If it isn\(cqt defined, then the following path is used:
-\fI/tmp/bspwm<display_name>\-socket\fR\&.
-.RE
-.SH "PANELS"
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Any EWMH compliant panel (e\&.g\&.:
-\fItint2\fR,
-\fIbmpanel2\fR, etc\&.)\&.
-.RE
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-A custom panel if the
-\fI\-s\fR
-flag is used (have a look at the files in
-\fIexamples/panel\fR)\&.
-.RE
-.SH "KEY FEATURES"
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Configured and controlled through messages\&.
-.RE
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Multiple monitors support (via
-\fIRandR\fR)\&.
-.RE
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-EWMH support (\fBtint2\fR
-works)\&.
-.RE
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Hybrid tiling\&.
+\fI/tmp/bspwm<host_name>_<display_number>_<screen_number>\-socket\fR\&.
.RE
.SH "CONTRIBUTORS"
.sp
.SH "AUTHOR"
.sp
Bastien Dejean <nihilhill at gmail\&.com>
-.SH "MAILING LIST"
-.sp
-bspwm at librelist\&.com
projects / bspwm.git / blobdiff