Openbox is a lightweight, powerful, and highly configurable stacking window manager with extensive standards support. It may be built upon and run independently as the basis of a unique desktop environment, or within other integrated desktop environments such as KDE and Xfce, as an alternative to the window managers they provide. The LXDE desktop environment is itself built around Openbox.
- 1 Installation
- 2 Starting
- 3 Configuration
- 4 Openbox reconfiguration
- 5 Keybinds
- 6 Menus
- 7 Desktop theming
- 8 Compositing effects
- 9 Mouse cursor and application icon themes
- 10 Desktop icons and wallpapers
- 11 oblogout
- 12 Openbox for multihead users
- 13 Tips and tricks
- 13.1 Launch a complex command with hotkey
- 13.2 Switch desktops using the mouse
- 13.3 Set default applications / file associations
- 13.4 Stop continous mouse wheel desktop switching
- 13.5 Ad-hoc window transparency
- 13.6 Using obxprop for faster configuration
- 13.7 Xprop values for applications
- 13.8 Switching between keyboard layouts
- 13.9 Set grid layout for virtual desktops
- 13.10 Enable Hot Corners
- 13.11 Window snapping
- 13.12 Smooth display manager transition
- 14 Troubleshooting
- 15 See also
Install the package.
Other desktop environments
Four key files form the basis of the openbox configuration, each serving a unique role. They are:
environment. Although these files are discussed in more detail below, to start configuring Openbox, it will first be necessary to create a local Openbox profile (i.e for your specific user account) based on them. This can be done by copying them from the global
/etc/xdg/openbox profile (applicable to any and all users) as a template:
$ cp -R /etc/xdg/openbox ~/.config/
<keyboard>section of this file, and underneath the
<!-- Keybindings for running aplications -->heading.
~/.config/openbox/rc.xml is the main configuration file, responsible for determining the behaviour and settings of the overall session, including:
- Keyboard shortcuts (e.g. starting applications; controlling the volume)
- Desktop and Virtual desktop settings, and
- Application Window settings
This file is also pre-configured, meaning that it will only be necessary to amend existing content in order to customise behaviour to suit personal preference.
~/.config/openbox/menu.xml defines the type and behaviour of the desktop menu, accessable by right-clicking the background. Although the default provided is a static menu (meaning that it will not automatically update when new applications are installed), it is possible to employ the use of dynamic menus that will automatically update as well.
The available options are discussed extensively below in the #Menus section.
Openbox's own autostart mechanism:
Issues regarding commands in
~/.config/openbox/autostart being executed out of order (or skipped altogether) are often resolved by the addition of small delays. For instance:
xset -b (sleep 3s && nm-applet) & (sleep 3s && conky) &
~/.config/openbox/environment can be used to export and set relevant environmental variables such as to:
- Define new pathways (e.g. execute commands that would otherwise require the entire pathway to be listed with them)
- Change language settings, and
- Define other variables to be used (e.g. the fix for GTK theming could be listed here)
Several GUI applications are available to quickly and easily configure your Openbox desktop.
- ObConf — A GTK2 based configuration tool for the Openbox window manager.
- LXAppearance ObConf — Plugin for LXAppearance to configure Openbox. Note that not all options to configure Openbox are available in this plugin, so you might want to install obconf anyway.
- LXInput — LXDE keyboard and mouse configuration
- LXRandR — LXDE monitor configuration.
- obkey — Configure Openbox keyboard shortcuts
- ob-autostart — A simple autostart application for Openbox.
- http://pastebin.com/012YgXTk || AUR
- obapps — Graphical tool for configuring application settings in Openbox.
Programs and applications relating to the configuration of Openbox's desktop menu are discussed in the Menus section.
Openbox will not always automatically reflect any changes made to its configuration files within a session. As a consequence, it will be necessary to manually reload those files after they have been edited. To do so, enter the following command:
$ openbox --reconfigure
Where intending to add this command as a keybind to
~/.config/openbox/rc.xml, it will only be necessary to list the command as
reconfigure. An example has been provided below, using the
<keybind key="W-F11"> <action name="Reconfigure"/> </keybind>
All keybinds must be added to the
~/.config/openbox/rc.xml file, and below the
<!-- Keybindings for running aplications --> heading. Although a brief overview has been provided here, a more in-depth explanation of keybindings can be found at openbox.org.
Keybinds can be added to the configuration file using the following syntax:
<keybind key="my-key-combination"> <action name="my-action"> ... </action> </keybind>
The action name for running an external command is Execute. Use the following syntax to define an external command to execute:
<action name="Execute"> <command>my-command</command> </action>
See the Openbox wiki for a list of all available actions.
While the use of standard alpha-numeric keys for keybindings is self-explanatory, special names are assigned to other types of keys, such as
multimedia keys and
Modifier keys play an important role in keybindings (e.g. holding down the
CTRL / control key in combination with another key to undertake an action). Using modifiers helps to prevent conflicting keybinds, whereby two or more actions are linked to the same key or combination of keys. The syntax to use a modifier with another key is:
The modifier codes are as follows:
C: Control / CTRL
W: Super / Windows
H: Hyper (If it is bound to something)
Where available, it is possible to set the appropriate
multimedia keys to perform their intended functions, such as to control the volume and/or the screen brightness. These will usually be integrated into the
function keys, and are identified by their appropriate symbols. See Extra keyboard keys for details.
The volume and brightness multimedia codes are as follows (note that commands will still have to be assigned to them to actually function):
XF86AudioRaiseVolume: Increase volume
XF86AudioLowerVolume: Decrease volume
XF86AudioMute: Mute / unmute volume
XF86MonBrightnessUp: Increase screen brightness
XF86MonBrightnessDown: Decrease screen brightness
For a full list of XF86 multimedia keys, see the LinuxQuestions wiki.
- ALSA: see Advanced Linux Sound Architecture#Keyboard volume control.
- PulseAudio: see PulseAudio#Keyboard volume control
- OSS: see OSS#Using multimedia keys with OSS.
These are the directional / arrow keys, usually used to move the cursor up, down, left, or right. The (self-explanatory) navigation codes are as follows:
It is possible to employ three types of menu in Openbox:
pipes (dynamic), and
generators (static or dynamic). They may also be used alone or in any combination.
As the name would suggest, this default type of menu does not change in any way, and may be manually edited and/or (re)generated automatically through the use on an appropriate software package.
Fast and efficient, while this type of menu can be used to select applications, it can also be useful to access specific functions and/or perform specific tasks (e.g. desktop configuration), leaving the access of applications to another process (e.g. theor applications).
~/.config/openbox/menu.xml file will be the sole source of static desktop menu content.
xml menus for several window managers, including Openbox, Fluxbox, IceWM and Xfce. It will search for all installed executable programs and consequently create a menu file for them. It is also possible to configure MenuMaker to exclude certain application types (e.g. relating to GNOME or KDE), if desired.
Once installed and executed, it will automatically generate a new
~/.config/openbox/menu.xml file. To avoid overwriting an existing file, enter:
$ mmaker -v OpenBox3
Otherwise, to overwrite an existing file, add the
force argument (
$ mmaker -vf OpenBox3
Once a new
~/.config/openbox/menu.xml file has been generated it may then be manually edited, or configured using a GUI menu editor, such as .
obm-xdg- a pipe menu to generate a list of GTK+ and GNOME applications - is also provided with obmenu. However, it has long-running bugs whereby it may produce an invalid output, or even not function at all. Consequently it has been omitted from discussion.
is a "user-friendly" GUI application to edit
~/.config/openbox/menu.xml, without the need to code in
will automatically generate a menu based on
xdg files contained within the
/etc/xdg/ directory for numerous Window Managers, including Openbox. Review the Xdg-menu#OpenBox article for further information.
~/.config/openbox/menu.xml file can be edited in order to provide a sub-menu with the same options as provided by oblogout. The sample script below will provide all of these options, with the exception of the ability to lock the screen:
<menu id="exit-menu" label="Exit"> <item label="Log Out"> <action name="Execute"> <command>openbox --exit</command> </action> </item> <item label="Shutdown"> <action name="Execute"> <command>systemctl poweroff</command> </action> </item> <item label="Restart"> <action name="Execute"> <command>systemctl reboot</command> </action> </item> <item label="Suspend"> <action name="Execute"> <command>systemctl suspend</command> </action> </item> <item label="Hibernate"> <action name="Execute"> <command>systemctl hibernate</command> </action> </item> </menu>
Once the entries have been composed, add the following line to present the sub-menu where desired within the main desktop menu (usually as the last entry):
This type of menu is in essence a script that provides dynamic, refreshed lists on-the-fly as and when run. These lists may be used for multiple purposes, including to list applications, to provide information, and to provide control functions. Pre-configured pipe menus can be installed, although not from the official repositories. More experienced users can also modify and/or create their own custom scripts. Again,
~/.config/openbox/menu.xml may and commonly will contain several pipe menus.
- AUR: fast xdg-menu converter to xml-pipe-menu
- AUR: Application and file browser
- Udisks AUR: Management of removable media with
- wifi pipe menu: Wireless networking using Netctl
Openbox.org also provides a further list of pipe menus.
This type of menu is akin to those provided by the taskbars of desktop environments such as Xfce or LXDE. Automatically updating on-the-fly, this type of menu can be powerful and very convenient. It may also be possible to add custom categories and menu entries; read the documentation for your intended dynamic menu to determine if and how this can be done.
A menu generator will have to be executed from the
official homepage provides further information and screenshots.AUR is highly recommended despite being an unofficial package. With the ability to be used as a static or dynamic menu, it is highly configurable, powerful, and versatile. Menu categories and individual entries may also be easily hidden, customised, and/or added with ease. The
Below is an example of how obmenu-generator would be dynamically executed without icons in
<?xml version="1.0" encoding="utf-8"?> <openbox_menu> <menu id="root-menu" label="OpenBox 3" execute="/usr/bin/obmenu-generator"> </menu> </openbox_menu>
To automatically iconify entries, the
-i option would be added:
<menu id="root-menu" label="OpenBox 3" execute="/usr/bin/obmenu-generator -i">
To show icons next to menu entries, it will be necessary to ensure they are enabled in the
<menu> section of the
Where using a static menu, it will then be necessary to edit the
~/.config/openbox/menu.xml file to provide both the
icon = command, along with the full path and icon name for each entry. An example of the syntax used to provide an icon for a category is:
<menu id="apps-menu" label="[label name]" icon="[pathway to icon]/[icon name]">
is a package that can issue commands to simulate key presses / keybinds, meaning that it is possible to use it to invoke keybind-related actions without having to actually press their assigned keys. As this includes the ability to invoke an assigned keybind for the Openbox desktop menu, it is therefore possible to use XDoTool to turn the Openbox desktop menu into a panel menu. Especially where the desktop menu is heavily customised and feature-rich, this may prove very useful to:
- Replace an existing panel menu
- Implement a panel menu where otherwise not provided or possible (e.g. for Tint2)
- Compensate where losing access to the desktop menu due to the use of an application like xfdesktop to manage the desktop.
Once XDoTool has been installed - if not already present - it will be necessary to create a keybind to access the root menu in
~/.config/openbox/rc.xml, and again below the
<!-- Keybindings for running aplications --> heading. For example, the following code will bring up the menu by pressing
<keybind key="C-m"> <action name="ShowMenu"> <menu>root-menu</menu> </action> </keybind>
Openbox must then be re-configured. In this instance, XDoTool will be used to simulate the
m keypress to access the desktop menu with the following command (note the use of
+ in place of
xdotool key control+m
How this command may be used as a panel launcher / icon is largely dependent on the features of panel used. While some panels will allow the above command to be executed directly in the process of creating a new launcher, others may require the use of an executable script. As an example, a custom executable script called
obpanelmenu.sh will be created in the
$ text editor ~/.config/obpanelmenu.sh
Once the empty file has been opened, the appropriate XDoTool command must be added to the empty file (i.e. to simulate the
m keypress for this example):
xdotool key control+m
After the file has been saved and closed, it may then be made into an executable script with the following command:
$ chmod +x ~/.config/obpanelmenu.sh
Executing it will bring up the Openbox desktop menu. Consequently, where using a panel that supports drag-and-drop functionality to add new launchers, simply drag the executable script onto it before changing the icon to suit personal taste.
A xdg compliant menu is based on the freedesktop.org standard. The menu is defined in menu-files which reside in /etc/xdg/menus. New applications will occur automatically in the menu.
- californium: xdg menu based on the LXQt main menu and easily themable
~/.gtkrc-2.0file (see GTK+#Themes).
It is important to note that a substantial range of both Openbox-specific and generalised, Openbox-compatible GTK themes are available to change the look of window decorations and the desktop menu. Generalised themes are designed to be simultaneously compatible with a range of popular desktop environments and/or window managers, commonly including Openbox. See these package descriptions for examples.
Installation: official and AUR
A good selection of themes are available in thepackage.
Both Openbox-specific and Openbox-compatible themes installed will be automatically installed to the
/usr/share/themes directory. Both will also be immediately available for selection.
Installation: other sources
There are two particular problems that may be encountered on rare occasions, especially where downloading themes from unsupported websites. These have been addressed below.
Theme cannot be used
If for any reason the newly extracted theme cannot be selected, open the theme directory to first ensure that it is indeed compatible with Openbox by determining that an
openbox-3 directory is present, and that within this directory a
themerc file is also present. An
.obt (OpenBox Theme) file may also be present in some instances, which can then be manually loaded in .
Where expected files and directories are present and correct, then on occasion it is possible that the theme author has not correctly set permission to access the file (e.g. permission may still be for the account of the author, rather than for root). To eliminate this possibility, ensure the folder and file permissions are for root:
# chown -R root /user/share/themes
Theme looks broken
Of course, the first line of enquiry would be to check that it is not just a badly made, broken theme! Otherwise, ensure that the Openbox GTK fix[broken link: invalid section][dead link 2014-11-28] has been implemented, and then re-start the session. Unfortunately some older themes can simply break if not maintained sufficiently to keep pace with the changes incurred by GTK updates. To avoid such occurrences, it is best to check that desired themes have recently been created or at least updated / patched.
Edit or create new themes
The process of creating new or modifying existing themes is covered extensively at the official openbox.org website. AUR is a user-friendly GUI for doing so.
Openbox does not provide native support for compositing, and thus requires an external compositor for this purpose.
Although compositing is not a necessary component, it may specifically avoid issues such as screen distortion with oblogout, and visual glitches with terminal window transparency. See Xorg#Composite for common choices.
Mouse cursor and application icon themes
Desktop icons and wallpapers
Openbox does not natively support the use of desktop icons or wallpapers. As a consequence, it will be necessary to install additional applications for this purpose, where desired.
Desktop management using file managers
Some file managers have the capacity to fully manage the desktop, meaning that they may be used to provide wallpapers and enable the use of icons on the desktop. The LXDE desktop environment itself uses PCManFM for this purpose.
While there are programs dedicated to enabling desktop icons alone, it would seem that they have greater drawbacks than the utilisation of file managers for the task. These programs are discussed briefly, below.
idesk is a simple program that can enable icons in addition to managing wallpaper. It will be necessary to create an
~/.idesktop directory, and desktop icons must also be manually created. To use idesk to provide icons, add the following command to the
As such, it will consequently be necessary to access it by other means, such as by creating a keybind[broken link: invalid section], and/or by - where permitted - re-configuring an installed panel to use the desktop menu as a panel menu. To use xfdesktop to provide icons, add the following command to the
Particularly where using a file manager to manage the desktop, it will be necessary to edit
~/.conkyrc to change the
own_window_type command in order for conky to continue to be displayed (where used). The revised command that should be used is:
See the Oblogout article for an overview on how to use this useful, graphical logout script.
Openbox for multihead users
While Openbox provides better than average multihead support on its own, Xmonad web site. Also, please see README.MULTIHEAD for a more comprehensive description of the new features and configuration options found in Openbox Multihead.AUR provides a development branch called Openbox Multihead that gives multihead users per-monitor desktops. This model is not commonly found in floating window managers, but exists mainly in tiling window managers. It is explained well on the
Openbox Multihead will function like normal Openbox when only a single head is available.
A downside to using Openbox Multihead is that it breaks the EWMH assumption that one and only one desktop is visible at any time. Thus, existing pagers will not work well with it. To remedy this, you can install broken link: archived in aur-mirror] alongside Openbox Multihead. It will work without Openbox Multihead if only one monitor is active.AUR[
Tips and tricks
Launch a complex command with hotkey
If you need to execute a complex command, use shell functionality.
Special character replacement are as follows:
This example will turn off display immediately and lock screen with this thread.. It was taken from
<keybind key="W-l"> <action name="Execute"> <command>sh -c 'slock & (sleep .5 && xset dpms force off)'</command> </action> </keybind>
Sometimes one need to specify environment variable for application:
<keybind key="A-F7"> <action name="Execute"> <command>sh -c "LC_ALL=C obconf"</command> </action> </keybind>
Another example will launch application preserving all stdout and stderr output to file:
<keybind key="A-f"> <action name="Execute"> <command>sh -c sh -c "exec gimp >/tmp/gimp.out 2>&1"</command> </action> </keybind>
Switch desktops using the mouse
It is possible to switch desktop by moving the mouse cursor to the edges of the screen. First install
xdotool behave_screen_edge --delay 500 left set_desktop --relative -- -1 & xdotool behave_screen_edge --delay 500 right set_desktop --relative -- +1 &
Set default applications / file associations
See the Default applications article.
Stop continous mouse wheel desktop switching
By default Openbox switches from the last desktop back to the first desktop on mouse wheel scroll. Use
<wrap>no</wrap> in the
mousebind section to disable this behaviour.
<context name="Desktop"> <mousebind button="Up" action="Click"> <action name="GoToDesktop"> <to>previous</to> <wrap>no</wrap> </action> </mousebind> <mousebind button="Down" action="Click"> <action name="GoToDesktop"> <to>next</to> <wrap>no</wrap> </action> </mousebind> </context>
Ad-hoc window transparency
The programcan enable window transparency on-the-fly.
For example, using the following code in the
<mouse> section of the
~/.config/openbox/rc.xml file will enable control of application window transparency by hovering the mouse-pointer over the title bar and scrolling with the middle button:
<context name="Titlebar"> ... <mousebind button="Up" action="Click"> <action name= "Execute" > <execute>transset-df -p .2 --inc </execute> </action> </mousebind> <mousebind button="Down" action="Click"> <action name= "Execute" > <execute>transset-df -p .2 --dec </execute> </action> </mousebind> ... </context>
Using obxprop for faster configuration
obxprop binary that can parse relevant values for applications settings in
obxprop | grep "^_OB_APP" is recommended for this task. Start the process by running the command shown, then click a window to see its properties in the terminal.
Xprop values for applications
Bash Alias may be useful: dy:can be used to relay property values for selected applications. Where frequently using per-application settings, the following
alias xp='xprop | grep "WM_WINDOW_ROLE\|WM_CLASS" && echo "WM_CLASS(STRING) = \"NAME\", \"CLASS\""'
To use Xorg-XProp, run using the alias given
xp, and click on the active program desired to define with per-application settins. The results displayed will only be the information that Openbox itself requires, namely the
WM_CLASS (name and class) values:
WM_WINDOW_ROLE(STRING) = "roster" WM_CLASS(STRING) = "gajim.py", "Gajim.py" WM_CLASS(STRING) = "NAME", "CLASS"
For whatever reason, Firefox and like-minded equivalents ignore application rules (e.g. <desktop>) unless
class="Firefox*" is used. This applies irrespective of whatever values xprop may report for the program's
Switching between keyboard layouts
See the article section switching between keyboard layouts for instructions.
Set grid layout for virtual desktops
InstallAUR. To set a 2x2 grid for example:
obsetlayout 0 2 2 0
Run it without arguments to know what the arguments mean.
Enable Hot Corners
lead provides hot corners for openbox and other lightweight window managers. Start the application with a entry in the autostart-file:
Commands can be edited in the configuration file
[eDP1] bottom= bottomLeft=chromium bottomRight=thunar left= right= top= topLeft=mlde.californium toggle topRight=skippy-xd
Many desktop environments and window managers support window snapping (e.g. Windows 7 Aero snap), whereby they will automatically snap into place when moved to the edge of the screen. This effect can also be simulated in Openbox through the use of keybinds on focused windows.
As illustrated in the example below, percentages must be used to determine window sizes (see openbox.org for further information). In this instance, The
super key is used in conjunction with the
<keybind key="W-Left"> <action name="UnmaximizeFull"/> <action name="MaximizeVert"/> <action name="MoveResizeTo"> <width>50%</width> </action> <action name="MoveToEdge"><direction>west</direction></action> </keybind> <keybind key="W-Right"> <action name="UnmaximizeFull"/> <action name="MaximizeVert"/> <action name="MoveResizeTo"> <width>50%</width> </action> <action name="MoveToEdge"><direction>east</direction></action> </keybind>
However, it should be noted that once a window has been 'snapped' to an edge, it will remain vertically maximised unless subsequently maximised and then restored. The solution is to implement additional keybinds - in this instance using the
up keys - to do so. This will also make pulling 'snapped' windows from screen edges faster as well:
<keybind key="W-Down"> <action name="Unmaximize"/> </keybind> <keybind key="W-Up"> <action name="Maximize"/> </keybind>
This Ubuntu forum thread provides more information. Applications such as AUR are also available to automatically simulate window snapping behaviour without the use of keybinds.
Another option is to use AUR which provides
bl-aerosnap --left and
bl-aerosnap --right commands which will snap active window on left or right edge respectively if it's not snapped and restore it to original size and position otherwise. Just bind these commands to the key combination of your choosing.
Smooth display manager transition
Users of display managers might experience a flickering during the transition between the display manager and the Openbox desktop. The flickering comes from Openbox setting the root window's color during startup. Therefore there's a brief moment when the display flashes in a grey color, between the display manager's background and the desktop's wallpaper.
Setting the root window's background color can be disabled by editing the Openbox startup script found in
/usr/lib/openbox/openbox-autostart. Simply comment out (or delete) the block starting with
# Set a background color.
Windows load behind the active window
Some application windows (such as Firefox windows) may load behind the currently active window, causing you to need to switch to the window you just created to focus it. To fix this behavior add this to your
~/.config/openbox/rc.xml file, inbetween the
<applications> <application class="*"> <focus>yes</focus> </application> </applications>