.\" Title: bspwm
.\" Author: [see the "Author" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 11/09/2015
+.\" Date: 11/26/2015
.\" Manual: Bspwm Manual
.\" Source: Bspwm 0.9
.\" Language: English
.\"
-.TH "BSPWM" "1" "11/09/2015" "Bspwm 0\&.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 are 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 action, 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 \{\
.\}
.sp
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)[\&.manual|\&.automatic][\&.tiled|nontiled][\&.pseudotiled|\&.nonpseudotiled][\&.floating|\&.nonfloating][\&.fullscreen|\&.nonfullscreen][\&.below|\&.normal|\&.above][\&.local|\&.foreign][\&.like|\&.unlike][\&.focused|\&.unfocused][\&.urgent|\&.nonurgent][\&.sticky|\&.nonsticky][\&.public|\&.private][\&.locked|\&.unlocked]
+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
-tiled
-.RS 4
-Only consider tiled windows\&.
-.RE
-.PP
-nontiled
-.RS 4
-Only consider tiled windows\&.
-.RE
-.PP
-pseudotiled
-.RS 4
-Only consider pseudo\-tiled windows\&.
-.RE
-.PP
-nonpseudotiled
-.RS 4
-Only consider non pseudo\-tiled windows\&.
-.RE
-.PP
-floating
-.RS 4
-Only consider floating windows\&.
-.RE
-.PP
-nonfloating
-.RS 4
-Only consider non floating windows\&.
-.RE
-.PP
-fullscreen
-.RS 4
-Only consider fullscreen windows\&.
-.RE
-.PP
-nonfullscreen
-.RS 4
-Only consider non fullscreen windows\&.
-.RE
-.PP
-manual
-.RS 4
-Only consider windows in manual splitting mode\&.
-.RE
-.PP
-automatic
-.RS 4
-Only consider windows in automatic splitting mode\&.
-.RE
-.PP
-focused
-.RS 4
-Only consider focused windows\&.
-.RE
-.PP
-unfocused
-.RS 4
-Only consider unfocused windows\&.
-.RE
-.PP
-below
-.RS 4
-Only consider windows of the BELOW layer\&.
-.RE
-.PP
-normal
-.RS 4
-Only consider windows of the NORMAL layer\&.
-.RE
-.PP
-above
-.RS 4
-Only consider windows of the ABOVE layer\&.
-.RE
-.PP
-like
-.RS 4
-Only consider windows that have the same class as the current window\&.
-.RE
-.PP
-unlike
-.RS 4
-Only consider windows that have a different class than the current window\&.
-.RE
-.PP
-local
-.RS 4
-Only consider windows of the current desktop\&.
-.RE
-.PP
-foreign
-.RS 4
-Only consider windows outside of the current desktop\&.
-.RE
-.PP
-private
-.RS 4
-Only consider private windows\&.
-.RE
-.PP
-public
+[!](tiled|pseudo_tiled|floating|fullscreen)
.RS 4
-Only consider non private windows\&.
+Only consider windows having or not having the given state\&.
.RE
.PP
-urgent
+[!]automatic
.RS 4
-Only consider urgent windows\&.
+Only consider windows in automatic or manual insertion mode\&.
.RE
.PP
-nonurgent
+[!]focused
.RS 4
-Only consider non urgent windows\&.
+Only consider focused or unfocused windows\&.
.RE
.PP
-sticky
+[!]same_class
.RS 4
-Only consider sticky windows\&.
+Only consider windows that have or don\(cqt have the same class as the current window\&.
.RE
.PP
-nonsticky
+[!]local
.RS 4
-Only consider non sticky windows\&.
+Only consider windows in or not in the current desktop\&.
.RE
.PP
-locked
+[!](private|urgent|sticky|locked)
.RS 4
-Only consider locked windows\&.
+Only consider windows that have or don\(cqt have the given flag set\&.
.RE
.PP
-unlocked
+[!](below|normal|above)
.RS 4
-Only consider non locked 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|\&.nonurgent][\&.local|\&.foreign]
+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
-nonurgent
+[!]local
.RS 4
-Only consider non urgent desktops\&.
-.RE
-.PP
-local
-.RS 4
-Only consider desktops of the current monitor\&.
-.RE
-.PP
-foreign
-.RS 4
-Only consider desktops outside 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"
locked
.RS 4
Ignores the
-\fBclose\fR
+\fBwindow \-\-close\fR
message\&.
.RE
.PP
.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
\fIpresel_border_color\fR
.RS 4
Color of the
-\fBpresel\fR
+\fBwindow \-\-presel\fR
message feedback\&.
.RE
.PP
When focusing a monitor, put the pointer at its center\&.
.RE
.PP
-\fIauto_alternate\fR
-.RS 4
-Interpret two consecutive identical
-\fBuse\fR
-messages as an
-\fBalternate\fR
-message\&.
-.RE
-.PP
-\fIauto_cancel\fR
-.RS 4
-Interpret two consecutive identical
-\fBpresel\fR
-messages as a
-\fBcancel\fR
-message\&.
-.RE
-.PP
-\fIapply_floating_atom\fR
-.RS 4
-Set the value of the
-\fI_BSPWM_FLOATING_WINDOW\fR
-atom of each window according to its floating state\&.
-.RE
-.PP
\fIignore_ewmh_focus\fR
.RS 4
Ignore EWMH focus requests coming from applications\&.
A window is managed\&.
.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\&.
\fBbspwm\fR\&. If it isn\(cqt defined, then the following path is used:
\fI/tmp/bspwm<host_name>_<display_number>_<screen_number>\-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 (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\&.
-.RE
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-EWMH support\&.
-.RE
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Hybrid tiling\&.
-.RE
.SH "CONTRIBUTORS"
.sp
.RS 4
.SH "AUTHOR"
.sp
Bastien Dejean <nihilhill at gmail\&.com>
-.SH "MAILING LIST"
-.sp
-bspwm at librelist\&.com
projects / bspwm.git / blobdiff