Help:Contents

From Openbox

(Difference between revisions)
Jump to: navigation, search
(Guides)
(Openbox as a Desktop Environment)
 
(132 intermediate revisions by 45 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.
  
== Guides ==
+
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]].
  
See the [[Help:Getting started| getting started guide]] for instructions on getting Openbox up and running.
+
==rc.xml==
 
+
===[[Help:Configuration|Configuration]]===
The [[Help:Upgrading to 3.4| 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 configuratioon to access.
+
*The configuration documentation has details on the various options you can set in ''rc.xml''.
 
+
===[[Help:Applications| Application settings]]===
This guide to [[Help:Using Openbox in GNOME| using Openbox in GNOME]] has instructions for running Openbox in the GNOME desktop environment and getting things to work how you want.
+
*Customize properties such as borders, geometry, workspace presence, layering etc. on a per-application basis.
 
+
=== Mouse & keybindings ===
This guide to [[Help:Using Openbox in KDE| using Openbox in KDE]] has instructions for running Openbox in K Desktop Environment.
+
====[[Help:Bindings| Binding documentation]]====
 
+
*Improve productivity and customize the function of your desktop by binding actions to key/mouse buttons (commonly called hot keys).
The [[Help:DefaultConfiguration| details of the default configuration]] page lists all the default key bindings.
+
====[[Help:Actions| Actions]]====
 
+
*Comprehensive documentation of all actions available for key and mouse bindings and the options which can affect their behavior.
The [[Help:Compiling| compiling guide]] details what you need to build the latest version of Openbox, and how to install it correctly.
+
== Menus ==
 
+
=== [[Help:Menus|Menu documentation]]===
The [[Help:Autostart| autostart guide]] gives instructions on how to launch programs with Openbox at startup.
+
*Describes how to set up your own menus in Openbox.
 
+
===[[Help:Actions#Introduction|Actions]]===
Pipe menus are menus that are generated dynamically when you open them. The [[Help:Pipemenus| pipe menu guide]] shows by example how to make and use a pipe menu in Openbox.
+
*The actions documentation lists all of the actions available for use in Openbox menus.
 
+
===[[Help:Menus#Pipe_menus|Pipe menus]]===
If you use focus-follows-mouse, here is an [[Help:MouseFocusExample| example configuration file]] that may be helpful in setting up your own configuration.
+
*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.
  
 
== Themes ==
 
== Themes ==
The complete [[Help:Themes| theme specification]] details all of the elements found in an Openbox theme.
+
===[[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.)
  
== Documentation ==
+
== Desktop Environments ==
A [[Help:Features| list of some features]] found in Openbox.
+
=== [[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.
  
The [[Help:Actions|actions documentation]] lists all of the actions available for [[Help:Bindings|key and mouse bindings]] and the options which can affect their behavior.
+
== 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:Menus| Menu documentation]]
+
== 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:FAQ| Frequently asked questions]]
+
===[[Help:Features|Feature list]]===
 +
*A list of features found in the Openbox windowmanager.
  
== Configuration ==
+
===[[Help:FAQ| Frequently asked questions]]===
[[ObConf:About| ObConf]] provides a simple interface to configuring much of Openbox.
+
  
The [[Help:Bindings| key and mouse bindings guide]] shows how to bind [[Help:Actions|actions]] to keys and mouse buttons.
+
===[[Help:Compiling|Compiling from source]]===
 +
*Details what you need to build the latest version of Openbox, and how to install it correctly.
  
An [[Help:MouseFocusExample| example configuration file]] for using focus-follows-mouse with more suitable bindings, which don't raise windows as often.
+
===[[Help:UsingGit|Using Git]]===
 +
*Explains how to get bleeding-edge Openbox code for testing or developing with.
  
A [[Help:ClaysViStyleSpatial|configuration file for vi-styled bindings]] (by [[User:Rcbarnes|Clay Barnes]]).
+
===[[ObConf:About| ObConf]]===
 +
*Obconf provides a simple graphical user interface to ease configuration for new Openbox users.
  
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]]).
+
=== [[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.
  
 
== 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://www.kde-look.org/content/show.php?content=12097 kooldock]
+
<!-- ??? is this necessary? - Spoiledbroth
 +
== Installing Openbox on Foresight Linux ==
  
[http://freshmeat.net/projects/wbar/ wbar]
+
To install the latest version of Openbox on [http://www.foresightlinux.org Foresight Linux], from the command line, execute:
  
[http://idesk.sourceforge.net/ idesk]
+
sudo conary update openbox obconf obmenu
  
[http://perlpanel.org/ perlpanel]
+
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]
  
[http://fbpanel.sourceforge.net/ fbpanel]
+
== Installing Openbox on PCLinuxOS ==
  
[http://pypanel.sourceforge.net/ pypanel]
+
To install the latest version of Openbox on [http://pclinuxos.com/ PCLinuxOS], from the command line, execute:
  
[http://www.xfce.org/ xfce4-panel]
+
apt-get install openbox
 
+
-->
[http://gdesklets.de/ gDesklets]
+
 
+
[http://netdragon.sourceforge.net/ssuperkaramba.html Super Karamba]
+
 
+
[http://adesklets.sourceforge.net/ adesklets]
+
 
+
[http://freshmeat.net/projects/torsmo/ torsmo]
+
 
+
[http://bbtools.sourceforge.net/ bbtools]
+
 
+
You can find lots of dockapps at [http://www.dockapps.org dockapps.org].
+
Some nice ones are wmCalClock, wmnd, wmix and wmpinboard.
+
 
+
== Installing Openbox on Foresight Linux ==
+
To install the latest version of Openbox on [http://www.foresightlinux.org Foresight Linux], from the command line, execute:  sudo conary update openbox
+

Latest revision as of 10: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