Difference between revisions of "Bspwm"
Baskerville (talk | contribs) (Created page with "= Synopsis = '''bspwm''' ['''-h'''|'''-v'''|'''-s''' ''PANEL_FIFO''|'''-p''' ''PANEL_PREFIX''] '''bspc''' ''MESSAGE'' [''ARGUMENTS''][*OPTIONS*] = Description = '''bspwm''...") |
(→Panels) |
||
(28 intermediate revisions by 9 users not shown) | |||
Line 1: | Line 1: | ||
− | + | [[Category:Tiling WMs]] | |
+ | '''bspwm''' is a tiling window manager that represents windows as the leaves of a full binary tree. It has support for [http://standards.freedesktop.org/wm-spec/wm-spec-1.3.html EWMH] and multiple monitors, and is configured and controlled through messages. | ||
− | + | == Installation == | |
− | + | Install {{AUR|bspwm}} or {{AUR|bspwm-git}} from the [[AUR]]. You will also want to install {{AUR|sxhkd}} or {{AUR|sxhkd-git}}, a simple X hotkey daemon used to communicate with bspwm through {{ic|bspc}} as well as launch your applications of choice. With commit {{ic | 948b804}}, {{AUR | xwinfo-git}} is also required by the example configuration files. | |
− | + | To start bspwm on login, add the following to your {{ic|.xinitrc}}: | |
− | + | {{bc| | |
+ | sxhkd & | ||
+ | exec bspwm | ||
+ | }} | ||
− | + | == Configuration == | |
− | + | Example configuration is found on [https://github.com/baskerville/bspwm/blob/master/examples/ GitHub]. | |
− | + | Copy [https://github.com/baskerville/bspwm/blob/master/examples/bspwmrc bspwmrc] to {{ic|~/.config/bspwm/bspwmrc}}, [https://github.com/baskerville/bspwm/blob/master/examples/sxhkdrc sxhkdrc] to {{ic|~/.config/sxhkd/sxhkdrc}} and make bspwmrc executable with {{ic|chmod +x ~/.config/bspwm/bspwmrc}}. | |
− | + | Documentation for bspwm is found by running {{ic|man bspwm}}. | |
− | + | There is also documentation for sxhkd found by running {{ic|man sxhkd}}. | |
− | + | These two files are where you will be setting wm settings and keybindings, respectively. | |
− | = | + | === Rules === |
− | + | As of {{ic|948b804}} window-specific rules were externalized. | |
+ | Rules can be created in a few different ways. Two such methods are below: | ||
− | + | # Using the example scripts provide in [https://github.com/baskerville/bspwm/blob/master/contrib/rules rules], place {{ic | rulc}} and {{ic | ruld}} in a folder that is in your $PATH and make them executable. Start {{ ic | ruld }} on login with something like {{ ic | rulc -l > /dev/null <nowiki>||</nowiki> ruld &}}. You can then use the rules in the example {{ic | bspwmrc }} These scripts require both [https://www.archlinux.org/packages/?sort=&q=lua-posix&maintainer=&flagged= lua-posix] and [https://www.archlinux.org/packages/?sort=&repo=Extra&q=lua&maintainer=&flagged= lua] | |
+ | # Alternatively, create a script that is called in your bspwmrc file that forms the rules. See [https://bbs.archlinux.org/viewtopic.php?pid=1346272#p1346272 Stebalien's post] or [https://gist.github.com/windelicato/7348087 earsplit's config] for examples of how to accomplish this. | ||
− | + | Both of these methods require installing '''xwinfo''' from the [https://aur.archlinux.org/packages/xwinfo-git AUR] or from [https://github.com/baskerville/xwinfo github] | |
− | < | + | If a particular window does not seem to be behaving according to your rules, check the class name of the program. This can be accomplished by running {{ ic | xprop <nowiki>|</nowiki> grep WM_CLASS}} to make sure you're using the proper string. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | === Panels === | |
− | + | Currently, [https://aur.archlinux.org/packages/bar-aint-recursive/ bar] and [https://www.archlinux.org/packages/?sort=&q=dzen2&maintainer=&flagged= dzen2] are supported with bspwm. Check the examples folder on the GitHub page for ideas or the [https://wiki.archlinux.org/index.php/Bar-aint-recursive Bar] wiki page. The panel will be executed by placing {{ic | panel &}} for bar or {{ic | panel dzen2 &}} for dzen2 in your bspwmrc. Check the opt-depends in the bspwm package for dependencies that may be required in either case. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | To display system information on your status bar you can use various system calls. This example will show you how to edit your {{ic | panel }} to get the volume status on your BAR: | |
− | + | {{bc|<nowiki> | |
+ | panel_volume() | ||
+ | { | ||
+ | volStatus=$(amixer get Master | tail -n 1 | cut -d '[' -f 4 | sed 's/].*//g') | ||
+ | volLevel=$(amixer get Master | tail -n 1 | cut -d '[' -f 2 | sed 's/%.*//g') | ||
+ | # is alsa muted or not muted? | ||
+ | if [ "$volStatus" == "on" ] | ||
+ | then | ||
+ | echo "\f6"$volLevel | ||
+ | else | ||
+ | # If it is muted, make the font red | ||
+ | echo "\f1"$volLevel | ||
+ | fi | ||
+ | }</nowiki>}} | ||
− | + | Next, we will have to make sure it is called and piped to {{ic | $PANEL_FIFO}}: | |
− | + | {{bc|<nowiki> | |
− | + | while true; do | |
− | + | echo "S" "$(panel_volume) $(panel_clock) > "$PANEL_FIFO" | |
− | + | sleep 1s | |
− | + | done & | |
− | + | </nowiki>}} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | ; | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | = | + | == Example how to configure after install == |
+ | {{warning | This not yet a finished guide}} | ||
+ | {{warning | Please note that bspwm are under heavy development and can change a lot. This is how I did last time. If something is wrong please correct the faults of it.}} | ||
− | |||
− | + | :1. Copy the supplied '''bspwm_rules''', '''rule_command''', '''ruld''' and '''rulc''' scripts from [https://github.com/baskerville/bspwm/tree/master/examples/external_rules Examples] to {{ic | $XDG_CONFIG_HOME/bspwm/}} and ensure they are executable. | |
− | + | :2. Edit {{ic | $HOME/.profile}} to something similar to this: | |
− | : | + | {{bc|<nowiki>PATH="/usr/games:$HOME/.config/bspwm:$PATH" |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | : | ||
− | |||
− | : | ||
− | |||
− | : | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | = | + | export XDG_CONFIG_HOME="/home/$USER/.config" |
− | + | ## Bspwm | |
− | + | export BSPWM_SOCKET="/tmp/bspwm-socket" | |
+ | export BSPWM_TREE=/tmp/bspwm.tree | ||
+ | export BSPWM_HISTORY=/tmp/bspwm.history | ||
+ | export BSPWM_STACK=/tmp/bspwm.stack | ||
+ | export PANEL_FIFO=/tmp/panel-fifo | ||
+ | export PANEL_HEIGHT=14</nowiki>}} | ||
− | + | :3. Edit {{ic | $HOME/.xinitrc }} and add. | |
+ | source $HOME/.profile & | ||
+ | sxhkd -c $XDG_CONFIG_HOME/bspwm/sxhkdrc & | ||
+ | exec wm | ||
− | + | :4. Add this line to {{ic|$XDG_CONFIG_HOME/bspwm/bspwmrc}}. | |
− | + | {{ic|bspc config rule_command "$(command -v rule_command)"}} | |
− | = | + | :5. Install [https://aur.archlinux.org/packages/xwinfo-git/ xwinfo] from [https://aur.archlinux.org/packages/xwinfo-git AUR] and [https://www.archlinux.org/packages/?sort=&q=lua-posix lua-posix]. Change the rules of {{ic|$XDG_CONFIG_HOME/bspwm/bspwm_rules}} to your likening. |
+ | {{hc|$ man bspc| | ||
+ | ... | ||
+ | rule_command | ||
+ | External command used to retrieve rule consequences. The command will receive the the ID of the | ||
+ | window being processed as its first argument. The output of that command must have the following | ||
+ | format: <nowiki>key1=value1 key2=value2</nowiki> ..., where keyN is one of floating, fullscreen, locked, sticky, | ||
+ | private, frame, center, lower, follow, manage, focus, desktop or monitor. | ||
+ | ...}} | ||
− | + | :To find out the window names you can use [https://www.archlinux.org/packages/?sort=&q=xorg-xprop xorg-xprop]. The lower-case 'vlc' is the instance and the upper-case 'Vlc' is the class. | |
− | + | {{hc|<nowiki>$ xprop | grep WM_CLASS</nowiki>|<nowiki>WM_CLASS(STRING) = "vlc", "Vlc"</nowiki>}} | |
− | |||
− | |||
− | = | + | :6. Restart bspwm and check so the rules have been applied. |
+ | {{hc|$ rulc -l| | ||
+ | class <nowiki>== "Gimp" =>floating=on</nowiki> | ||
+ | class <nowiki>== "Firefox" => desktop=^2</nowiki> | ||
+ | class <nowiki>== "Vlc" => desktop=^3</nowiki> | ||
+ | instance <nowiki>== "rtorrent" => desktop=^3</nowiki> | ||
+ | instance <nowiki>== "URthree" => desktop=^3</nowiki>}} | ||
− | + | == Troubleshooting == | |
− | |||
− | |||
− | + | The following environmental variables may need to be defined: | |
+ | {{bc| | ||
+ | echo $BSPWM_SOCKET | ||
+ | echo $XDG_CONFIG_HOME | ||
+ | }} | ||
− | + | If either of these do not respond with a value, then go to your ''~/.profile'' and add the following lines: | |
+ | {{bc| | ||
+ | export XDG_CONFIG_HOME="$HOME/.config" | ||
+ | export BSPWM_SOCKET="/tmp/bspwm-socket" | ||
+ | }} | ||
+ | {{Note|You may put these anywhere that is sourced for your user. Another sane place to put these would be as part of your user's ~/.xinitrc, or zsh users might choose ~/.zshenv. User your best discretion.}} | ||
− | = | + | == See also == |
− | * | + | * Mailing List: bspwm ''at'' librelist.com. |
− | * | + | * {{ic|#bspwm}} - IRC channel at the irc.freenode.net |
+ | * https://bbs.archlinux.org/viewtopic.php?id=149444 - Arch BBS thread | ||
+ | * https://github.com/baskerville/bspwm - GitHub project | ||
+ | * https://github.com/windelicato/dotfiles/wiki/bspwm-for-dummies - earsplit's "bspwm for dummies" |
Revision as of 00:25, 26 November 2013
bspwm is a tiling window manager that represents windows as the leaves of a full binary tree. It has support for EWMH and multiple monitors, and is configured and controlled through messages.
Contents
Installation
Install bspwmAUR or bspwm-gitAUR from the AUR. You will also want to install sxhkdAUR or sxhkd-gitAUR, a simple X hotkey daemon used to communicate with bspwm through bspc
as well as launch your applications of choice. With commit 948b804
, xwinfo-gitAUR is also required by the example configuration files.
To start bspwm on login, add the following to your .xinitrc
:
sxhkd & exec bspwm
Configuration
Example configuration is found on GitHub.
Copy bspwmrc to ~/.config/bspwm/bspwmrc
, sxhkdrc to ~/.config/sxhkd/sxhkdrc
and make bspwmrc executable with chmod +x ~/.config/bspwm/bspwmrc
.
Documentation for bspwm is found by running man bspwm
.
There is also documentation for sxhkd found by running man sxhkd
.
These two files are where you will be setting wm settings and keybindings, respectively.
Rules
As of 948b804
window-specific rules were externalized.
Rules can be created in a few different ways. Two such methods are below:
- Using the example scripts provide in rules, place
rulc
andruld
in a folder that is in your $PATH and make them executable. Startruld
on login with something likerulc -l > /dev/null || ruld &
. You can then use the rules in the examplebspwmrc
These scripts require both lua-posix and lua - Alternatively, create a script that is called in your bspwmrc file that forms the rules. See Stebalien's post or earsplit's config for examples of how to accomplish this.
Both of these methods require installing xwinfo from the AUR or from github
If a particular window does not seem to be behaving according to your rules, check the class name of the program. This can be accomplished by running xprop | grep WM_CLASS
to make sure you're using the proper string.
Panels
Currently, bar and dzen2 are supported with bspwm. Check the examples folder on the GitHub page for ideas or the Bar wiki page. The panel will be executed by placing panel &
for bar or panel dzen2 &
for dzen2 in your bspwmrc. Check the opt-depends in the bspwm package for dependencies that may be required in either case.
To display system information on your status bar you can use various system calls. This example will show you how to edit your panel
to get the volume status on your BAR:
panel_volume() { volStatus=$(amixer get Master | tail -n 1 | cut -d '[' -f 4 | sed 's/].*//g') volLevel=$(amixer get Master | tail -n 1 | cut -d '[' -f 2 | sed 's/%.*//g') # is alsa muted or not muted? if [ "$volStatus" == "on" ] then echo "\f6"$volLevel else # If it is muted, make the font red echo "\f1"$volLevel fi }
Next, we will have to make sure it is called and piped to $PANEL_FIFO
:
while true; do echo "S" "$(panel_volume) $(panel_clock) > "$PANEL_FIFO" sleep 1s done &
Example how to configure after install
- 1. Copy the supplied bspwm_rules, rule_command, ruld and rulc scripts from Examples to
$XDG_CONFIG_HOME/bspwm/
and ensure they are executable.
- 2. Edit
$HOME/.profile
to something similar to this:
PATH="/usr/games:$HOME/.config/bspwm:$PATH" export XDG_CONFIG_HOME="/home/$USER/.config" ## Bspwm export BSPWM_SOCKET="/tmp/bspwm-socket" export BSPWM_TREE=/tmp/bspwm.tree export BSPWM_HISTORY=/tmp/bspwm.history export BSPWM_STACK=/tmp/bspwm.stack export PANEL_FIFO=/tmp/panel-fifo export PANEL_HEIGHT=14
- 3. Edit
$HOME/.xinitrc
and add.
source $HOME/.profile & sxhkd -c $XDG_CONFIG_HOME/bspwm/sxhkdrc & exec wm
- 4. Add this line to
$XDG_CONFIG_HOME/bspwm/bspwmrc
.
bspc config rule_command "$(command -v rule_command)"
- 5. Install xwinfo from AUR and lua-posix. Change the rules of
$XDG_CONFIG_HOME/bspwm/bspwm_rules
to your likening.
$ man bspc
... rule_command External command used to retrieve rule consequences. The command will receive the the ID of the window being processed as its first argument. The output of that command must have the following format: key1=value1 key2=value2 ..., where keyN is one of floating, fullscreen, locked, sticky, private, frame, center, lower, follow, manage, focus, desktop or monitor. ...
- To find out the window names you can use xorg-xprop. The lower-case 'vlc' is the instance and the upper-case 'Vlc' is the class.
$ xprop | grep WM_CLASS
WM_CLASS(STRING) = "vlc", "Vlc"
- 6. Restart bspwm and check so the rules have been applied.
$ rulc -l
class == "Gimp" =>floating=on class == "Firefox" => desktop=^2 class == "Vlc" => desktop=^3 instance == "rtorrent" => desktop=^3 instance == "URthree" => desktop=^3
Troubleshooting
The following environmental variables may need to be defined:
echo $BSPWM_SOCKET echo $XDG_CONFIG_HOME
If either of these do not respond with a value, then go to your ~/.profile and add the following lines:
export XDG_CONFIG_HOME="$HOME/.config" export BSPWM_SOCKET="/tmp/bspwm-socket"
See also
- Mailing List: bspwm at librelist.com.
-
#bspwm
- IRC channel at the irc.freenode.net - https://bbs.archlinux.org/viewtopic.php?id=149444 - Arch BBS thread
- https://github.com/baskerville/bspwm - GitHub project
- https://github.com/windelicato/dotfiles/wiki/bspwm-for-dummies - earsplit's "bspwm for dummies"