Help:Contents

From Openbox

(Difference between revisions)
Jump to: navigation, search
m (Menus)
(Openbox as a Desktop Environment)
 
(56 intermediate revisions by 14 users not shown)
Line 1: Line 1:
 
Welcome to the community maintained documentation for Openbox! Please help out and add your own articles or improve the ones that are already here.
 
Welcome to the community maintained documentation for Openbox! Please help out and add your own articles or improve the ones that are already here.
  
== Getting started ==
+
In order to get full access and contribute in the wiki, all you need to do is prove you are a person. Please see [[Help:RequestWriteAccess|RequestWriteAccess]].
  
[[Help:Getting started|See the getting started guide]] for instructions on getting Openbox up and running.
+
==rc.xml==
 +
===[[Help:Configuration|Configuration]]===
 +
*The configuration documentation has details on the various options you can set in ''rc.xml''.
 +
===[[Help:Applications| Application settings]]===
 +
*Customize properties such as borders, geometry, workspace presence, layering etc. on a per-application basis.
 +
=== Mouse & keybindings ===
 +
====[[Help:Bindings| Binding documentation]]====
 +
*Improve productivity and customize the function of your desktop by binding actions to key/mouse buttons (commonly called hot keys).
 +
====[[Help:Actions| Actions]]====
 +
*Comprehensive documentation of all actions available for key and mouse bindings and the options which can affect their behavior.
 +
== Menus ==
 +
=== [[Help:Menus|Menu documentation]]===
 +
*Describes how to set up your own menus in Openbox.
 +
===[[Help:Actions#Introduction|Actions]]===
 +
*The actions documentation lists all of the actions available for use in Openbox menus.
 +
===[[Help:Menus#Pipe_menus|Pipe menus]]===
 +
*The pipe menu documentation explains basic use of pipe menus in Openbox. If you're looking for scripts there are many available [[Openbox:Pipemenus|on the community page]].
 +
===Generating an applications menu===
 +
*Scripts may be used to generate an application menu based on the contents of <code>/usr/share/applications</code> or other directories. See [[Openbox:Pipemenus#Application_Menus|this section]] for a complete list.
 +
*There are also instructions available for getting a [[Help:Menus/Debian-menu|working Debian menu]], if yours is not.
  
[[Help:Compiling|The compiling guide]] details what you need to build the latest version of Openbox, and how to install it correctly.
+
== Themes ==
 +
===[[Help:Themes|Theme specification]]===
 +
*Comprehensive detail and documentation all of the elements found in an Openbox theme.
 +
===[[Help:Upgrading_to_3.4#Themes|Openbox 3.4 theme file changes]]===
 +
*Details differences between 3.3->3.4 theme files
 +
*A tool to help with [http://icculus.org/openbox/tools/themeupdate.py converting blackbox/fluxbox themes] to Openbox themes. (For non-xpm-based themes.)
  
[[Help:Upgrading to 3.4|The upgrading to 3.4 guide]] walks through all the changes made since version 3.3, and there is a lot of them. Some of them mean new configuration options and features available to you, that you need to update your configuration to access.
+
== Desktop Environments ==
 +
=== [[Help:Using Openbox in GNOME|Openbox in GNOME]]===
 +
*Instructions for running Openbox in the GNOME desktop environment and getting things to work how you want.
 +
===[[Help:Using Openbox in KDE|Openbox in KDE]]===
 +
*Instructions for running Openbox in K Desktop Environment.
 +
===[[Help:XFCE/Openbox|Openbox in XFCE]]===
 +
*Instructions for running Openbox in the XFCE desktop enviroment.
  
[[Help:Using Openbox in GNOME|This guide to using Openbox in GNOME]] has instructions for running Openbox in the GNOME desktop environment and getting things to work how you want.
+
== Custom Desktop Environments ==
 +
===[[Help:Openbox-session|openbox-session]]===
 +
*Running Openbox as a stand-alone window manager in part of a custom desktop environment.
 +
===[[Help:Autostart|Autostart]]===
 +
*The autostart documentation gives instructions on how to launch programs with Openbox at startup (not applicable unless openbox-session is called from the Desktop Manager/<code>xinit</code>)
  
[[Help:Using Openbox in KDE|This guide to using Openbox in KDE]] has instructions for running Openbox in K Desktop Environment.
+
== Miscellaneous ==
 +
=== rc.xml Configuration examples ===
 +
*[[Help:DefaultConfiguration|rc.xml Configuration reference]] - Lists all default key bindings and default configuration.
 +
*[[Help:MouseFocusExample| Focus-follows-mouse]] - This configuration is similar to the default configuration, but has more suitable mouse bindings for focus-follows-mouse that won't interfere with your windows' stacking order.
 +
*[[Help:ClaysViStyleSpatial|Vi-styled bindings]] - Two examples of Vi-style keybindings (by [[User:Rcbarnes|Clay Barnes]]).
 +
*[[Help:WindowsInteractionWithWindowsKey| "Windows"/Super key control]] - Example of using the "Windows" AKA. Super key to control windows (by [[User:Deters|Deters]]).
 +
*[[Help:IrssiStyleFocus|Irssi-style window switching]]
  
[[Help:XFCE/Openbox|This guide to using Openbox in XFCE]] has instructions for running Openbox in the XFCE desktop enviroment.
+
===[[Help:Features|Feature list]]===
 +
*A list of features found in the Openbox windowmanager.
  
[[Help:DefaultConfiguration|The details of the default configuration]] page lists all the default key bindings.
+
===[[Help:FAQ| Frequently asked questions]]===
  
[[Help:Features|A list of some features]] found in Openbox.
+
===[[Help:Compiling|Compiling from source]]===
 +
*Details what you need to build the latest version of Openbox, and how to install it correctly.
  
[[Help:UsingGit|This guide to using Git]] shows how to get the latest and greatest Openbox code for testing or developing with.
+
===[[Help:UsingGit|Using Git]]===
 +
*Explains how to get bleeding-edge Openbox code for testing or developing with.
  
== FAQ ==
+
===[[ObConf:About| ObConf]]===
[[Help:FAQ| Frequently asked questions]].
+
*Obconf provides a simple graphical user interface to ease configuration for new Openbox users.
  
== Configuration ==
+
=== [[Help:Upgrading to 3.4|Upgrading to 3.4]] ===
 
+
*Walks through all the changes made since version 3.3, and there is a lot of them. Some of them mean new configuration options and features available to you, that you need to update your configuration to access.
[[Configuration| Configuration Guide]]
+
 
+
[[ObConf:About| ObConf]] provides a simple interface to configuring much of Openbox.
+
 
+
[[Help:Autostart| The autostart guide]] gives instructions on how to launch programs with Openbox at startup (when not running Openbox inside KDE or GNOME).
+
 
+
[[Help:Bindings| The key and mouse bindings guide]] shows how to bind actions to keys and mouse buttons.
+
 
+
[[Help:Actions#Introduction| The actions documentation]] lists all of the actions available for key and mouse bindings and the options which can affect their behavior.
+
 
+
[[Help:Applications| Per-app settings]] let you set properties such as borderless or omnipresent on specific apps.
+
 
+
See the inline comments in the [http://git.icculus.org/?p=mikachu/openbox.git;a=blob;f=data/rc.xml;hb=3.4-working default <code>rc.xml</code> file] for now for other options you can set.
+
 
+
=== Examples ===
+
 
+
[[Help:MouseFocusExample| A configuration file for focus-follows-mouse]]. This configuration is similar to the default configuration, but has more suitable mouse bindings for focus-follows-mouse that won't interfere with your windows' stacking order.
+
 
+
[[Help:ClaysViStyleSpatial| A configuration file for vi-styled bindings]] (by [[User:Rcbarnes|Clay Barnes]]).
+
 
+
How to use [[Help:IrssiStyleFocus|Irssi-style window switching]].
+
<!--
+
A [[Help:ClaysViStyleTraditional|second configuration file for vi-styled bindings]] that is less spatially-oriented and which follows traditional vi-bindings much more closely (by [[User:Rcbarnes|Clay Barnes]]).-->
+
 
+
== Themes ==
+
[[Help:Themes|The complete theme specification]] details all of the elements found in an Openbox theme.
+
 
+
[[Help:Upgrading_to_3.4#Themes|Theme file changes in Openbox 3.4]].
+
 
+
A tool to help with [http://icculus.org/openbox/tools/themeupdate.py converting blackbox/fluxbox themes] to Openbox themes. (For non-xpm-based themes.)
+
 
+
== Menus ==
+
[[Help:Menus|The menu documentation]] decribes how to set up your own menus in Openbox.
+
 
+
[[Help:Actions#Introduction|The actions documentation]] lists all of the actions available for use in Openbox menus.
+
 
+
[[Help:Menus#Pipe_menus|Pipe menus]] are menus that are generated dynamically when you open them. There are a number of pipe menus available for [[Openbox:Pipemenus|download through here]].
+
 
+
=== Generating an Applications Menu ===
+
There are a number of pipe menus that can generate your applications menu from what packages are installed on the system.  See [[Openbox:Pipemenus#Desktop_Environment_Integration|this section]] for a complete list.
+
  
 
== Other resources ==
 
== Other resources ==
Many Openbox questions have been answered in forums around the internet. Trying a search may be fruitful.
 
  
See [[Openbox:Community portal]] for other community resources and '''related projects'''.
+
*[http://wiki.archlinux.org/index.php/Openbox The Arch wiki] has a lot of great information on setting up and using Openbox.
  
== Cool programs to run with Openbox ==
+
*Many Openbox questions have been answered in forums around the internet. Trying a search may be fruitful.
  
Besides the programs included in GNOME and KDE...
+
*See [[Openbox:Community portal|community portal]] for other community resources and '''related projects'''.
 
+
[http://rox.sourceforge.net/desktop/static.html ROX Desktop]
+
 
+
[http://awn.wetpaint.com/ Avant Window Navigator]
+
 
+
[http://www.kde-look.org/content/show.php?content=12097 kooldock]
+
 
+
[http://freshmeat.net/projects/wbar/ wbar]
+
 
+
[http://idesk.sourceforge.net/ idesk]
+
 
+
[http://code.l3ib.org/?p=visibility-python.git;a=summary visibility] (click snapshot to download a .tar.gz)
+
 
+
[http://www.gnomefiles.org/app.php/LXPanel lxpanel]
+
 
+
[http://freshmeat.net/projects/perlpanel/ perlpanel]
+
 
+
[http://fbpanel.sourceforge.net/ fbpanel]
+
 
+
[http://pypanel.sourceforge.net/ pypanel] - PyPanel is a lightweight panel/taskbar. It can be easily customized to match any desktop theme or taste.
+
 
+
[http://code.google.com/p/ttm/ Tint Task Manager] (official site)
+
 
+
[http://code.google.com/p/tint2/ Tint Task Manager] (new release) - Tint is a simple panel/taskbar intentionally made for openbox3, but should also work with other window managers
+
 
+
[http://www.xfce.org/ xfce4-panel]
+
 
+
[http://code.google.com/p/superswitcher/ SuperSwitcher]
+
 
+
[http://zelea.com/project/screenpager/introduction.html Screenpager]
+
 
+
[http://hendrik.kaju.pri.ee/screenlets/?q=node/14 Screenlets]
+
 
+
[http://gdesklets.de/ gDesklets]
+
 
+
[http://netdragon.sourceforge.net/ssuperkaramba.html Super Karamba]
+
 
+
[http://adesklets.sourceforge.net/ adesklets]
+
 
+
[http://conky.sourceforge.net/ conky]
+
 
+
[http://obpager.sourceforge.net/ ObPager]
+
 
+
[http://bbtools.sourceforge.net/ bbtools]
+
 
+
[http://projects.l3ib.org/nitrogen/ nitrogen] - Background manager
+
 
+
[http://linuxbrit.co.uk/feh/ feh] - Image viewer
+
 
+
[http://code.google.com/p/oboinus/ Oboinus]
+
 
+
[http://stalonetray.sourceforge.net/ stalonetray]
+
 
+
[http://bbdock.nethence.com/ BBDock] (untested. EWMH capable) Tested by CrossWind, Fully operational!
+
 
+
[http://icculus.org/openbox/tools/setlayout.c Set Layout] - small program to set your desktops into a grid if you do not use a pager
+
 
+
 
+
You can find lots of dockapps at [http://www.dockapps.org dockapps.org].
+
Some nice ones are wmCalClock, wmnd, wmix and wmpinboard.
+
 
+
There are other programs of interest in the [[Openbox:Community_portal|Community portal]].
+
  
 +
<!-- ??? is this necessary? - Spoiledbroth
 
== Installing Openbox on Foresight Linux ==
 
== Installing Openbox on Foresight Linux ==
  
 
To install the latest version of Openbox on [http://www.foresightlinux.org Foresight Linux], from the command line, execute:
 
To install the latest version of Openbox on [http://www.foresightlinux.org Foresight Linux], from the command line, execute:
  
  sudo conary update group-openbox
+
  sudo conary update openbox obconf obmenu
  
Here's a nice user-contributed tutorial, which includes advice on setting up your Openbox desktop: [http://lindox.org/index.php?/archives/3-Installing-OpenBox-3.4.2-in-Foresight-Linux.html Installing Openbox in Foresight Linux]
+
Here's a nice user-contributed tutorial, which includes advice on setting up your Openbox desktop: [http://linux-blog.org/installing-openbox-on-foresight-linux/ Installing Openbox in Foresight Linux]
  
 
== Installing Openbox on PCLinuxOS ==
 
== Installing Openbox on PCLinuxOS ==
Line 151: Line 92:
  
 
  apt-get install openbox
 
  apt-get install openbox
 
+
-->
Or you can use 'synaptic' as usual.
+
 
+
* [http://jrandomhacker.info/Openbox Openbox on jrandomhacker.info] -- One PCLinuxOS user's experience with installing and configuring Openbox.
+

Latest revision as of 09:25, 15 March 2018

Welcome to the community maintained documentation for Openbox! Please help out and add your own articles or improve the ones that are already here.

In order to get full access and contribute in the wiki, all you need to do is prove you are a person. Please see RequestWriteAccess.

Contents

[edit] rc.xml

[edit] Configuration

  • The configuration documentation has details on the various options you can set in rc.xml.

[edit] Application settings

  • Customize properties such as borders, geometry, workspace presence, layering etc. on a per-application basis.

[edit] Mouse & keybindings

[edit] Binding documentation

  • Improve productivity and customize the function of your desktop by binding actions to key/mouse buttons (commonly called hot keys).

[edit] Actions

  • Comprehensive documentation of all actions available for key and mouse bindings and the options which can affect their behavior.

[edit] Menus

[edit] Menu documentation

  • Describes how to set up your own menus in Openbox.

[edit] Actions

  • The actions documentation lists all of the actions available for use in Openbox menus.

[edit] Pipe menus

  • The pipe menu documentation explains basic use of pipe menus in Openbox. If you're looking for scripts there are many available on the community page.

[edit] Generating an applications menu

  • Scripts may be used to generate an application menu based on the contents of /usr/share/applications or other directories. See this section for a complete list.
  • There are also instructions available for getting a working Debian menu, if yours is not.

[edit] Themes

[edit] Theme specification

  • Comprehensive detail and documentation all of the elements found in an Openbox theme.

[edit] Openbox 3.4 theme file changes

[edit] Desktop Environments

[edit] Openbox in GNOME

  • Instructions for running Openbox in the GNOME desktop environment and getting things to work how you want.

[edit] Openbox in KDE

  • Instructions for running Openbox in K Desktop Environment.

[edit] Openbox in XFCE

  • Instructions for running Openbox in the XFCE desktop enviroment.

[edit] Custom Desktop Environments

[edit] openbox-session

  • Running Openbox as a stand-alone window manager in part of a custom desktop environment.

[edit] Autostart

  • The autostart documentation gives instructions on how to launch programs with Openbox at startup (not applicable unless openbox-session is called from the Desktop Manager/xinit)

[edit] Miscellaneous

[edit] rc.xml Configuration examples

[edit] Feature list

  • A list of features found in the Openbox windowmanager.

[edit] Frequently asked questions

[edit] Compiling from source

  • Details what you need to build the latest version of Openbox, and how to install it correctly.

[edit] Using Git

  • Explains how to get bleeding-edge Openbox code for testing or developing with.

[edit] ObConf

  • Obconf provides a simple graphical user interface to ease configuration for new Openbox users.

[edit] Upgrading to 3.4

  • Walks through all the changes made since version 3.3, and there is a lot of them. Some of them mean new configuration options and features available to you, that you need to update your configuration to access.

[edit] Other resources

  • The Arch wiki has a lot of great information on setting up and using Openbox.
  • Many Openbox questions have been answered in forums around the internet. Trying a search may be fruitful.


Personal tools