Help:Contents

From Openbox

(Difference between revisions)
Jump to: navigation, search
(Undo revision 3856 by Spoiledbroth (talk))
(Undo revision 3875 by Spoiledbroth (talk))
(11 intermediate revisions by one user not shown)
Line 3: Line 3:
 
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]].
 
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]].
  
== Getting started ==
+
==rc.xml==
====[[Help:Features|Feature list]]====
+
===[[Help:Configuration|Configuration]]===
*A list of features found in the Openbox windowmanager.
+
 
+
====[[Help:FAQ| Frequently asked questions]]====
+
 
+
====[[Help:Compiling|Compiling from source]]====
+
*Details what you need to build the latest version of Openbox, and how to install it correctly.
+
 
+
====[[Help:UsingGit|Using Git]]====
+
*Explains how to get bleeding-edge Openbox code for testing or developing with.
+
 
+
====[[ObConf:About| ObConf]]====
+
*Obconf provides a simple graphical user interface to ease configuration for new Openbox users.
+
 
+
== [[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.
+
 
+
== Documentation ==
+
====[[Help:Configuration|Configuration]]====
+
 
*The configuration documentation has details on the various options you can set in ''rc.xml''.
 
*The configuration documentation has details on the various options you can set in ''rc.xml''.
===== Examples =====
+
===[[Help:Applications| Application settings]]===
*[[Help:DefaultConfiguration|rc.xml Configuration reference]] - Lists all default key bindings and default configuration.
+
*Customize properties such as borders, geometry, workspace presence, layering etc. on a per-application basis.
 
+
=== Mouse & keybindings ===
*[[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:Bindings| Binding documentation]]====
 
+
*[[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:Autostart|Autostart]]====
+
*The autostart documentation gives instructions on how to launch programs with Openbox at startup (when not running Openbox inside a full desktop environment like XFCE or KDE).
+
 
+
====[[Help:Bindings| Key/mouse binding]]====  
+
 
*Improve productivity and customize the function of your desktop by binding actions to key/mouse buttons (commonly called hot keys).
 
*Improve productivity and customize the function of your desktop by binding actions to key/mouse buttons (commonly called hot keys).
 
 
====[[Help:Actions| Actions]]====
 
====[[Help:Actions| Actions]]====
 
*Comprehensive documentation of all actions available for key and mouse bindings and the options which can affect their behavior.
 
*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]]===
 +
*Documentation of the pipe menu function. If you're looking for scripts there are a number of pipe menus available [[Openbox:Pipemenus|on the community page]].
 +
===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#Application_Menus|this section]] for a complete list.
  
====[[Help:Applications| Application settings]]====  
+
== Themes ==
*Customize properties such as borders, geometry, workspace presence, layering etc. on a per-application basis.
+
===[[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.)
  
=== Desktop Environments ===
+
== Desktop Environments ==
====[[Help:Using Openbox in GNOME|Openbox in GNOME]]====
+
=== [[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.
 
*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]]===
====[[Help:Using Openbox in KDE|Openbox in KDE]]====
+
 
*Instructions for running Openbox in K Desktop Environment.
 
*Instructions for running Openbox in K Desktop Environment.
 
+
===[[Help:XFCE/Openbox|Openbox in XFCE]]===
====[[Help:XFCE/Openbox|Openbox in XFCE]]====
+
 
*Instructions for running Openbox in the XFCE desktop enviroment.
 
*Instructions for running Openbox in the XFCE desktop enviroment.
  
====[[Help:Openbox-session|Openbox by itself]]====
+
== No Desktop Environment ==
*Running Openbox outside of common desktop environments, applications/widgets to enhance functionality of Openbox.
+
===[[Help:Openbox-session|openbox-session]]===
 +
*Running Openbox outside of common desktop environments and community maintained list of applications/widgets to enhance functionality of Openbox.
 +
===[[Help:Autostart|Autostart]]===
 +
*The autostart documentation gives instructions on how to launch programs with Openbox at startup (when not running Openbox inside a full desktop environment like XFCE or KDE).
  
=== Themes ===
+
== Miscellaneous ==
====[[Help:Themes|Theme specification]]====
+
=== rc.xml Configuration examples ===
*Comprehensive detail and documentation all of the elements found in an Openbox theme.
+
*[[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:Upgrading_to_3.4#Themes|Openbox 3.4 theme file changes]]====
+
===[[Help:Features|Feature list]]===  
*Details differences between 3.3->3.4 theme files
+
*A list of features found in the Openbox windowmanager.
*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:FAQ| Frequently asked questions]]===
===== [[Help:Menus|Menu documentation]]=====
+
*Describes how to set up your own menus in Openbox.
+
  
===== [[Help:Actions#Introduction|Actions]]=====
+
===[[Help:Compiling|Compiling from source]]===
*The actions documentation lists all of the actions available for use in Openbox menus.
+
*Details what you need to build the latest version of Openbox, and how to install it correctly.
  
=====[[Help:Menus#Pipe_menus|Pipe menus]]=====  
+
===[[Help:UsingGit|Using Git]]===
*Documentation of the pipe menu function. If you're looking for scripts there are a number of pipe menus available [[Openbox:Pipemenus|on the community page]].
+
*Explains how to get bleeding-edge Openbox code for testing or developing with.
  
===== Generating an applications menu =====
+
===[[ObConf:About| ObConf]]===  
*There are a number of pipe menus that can generate your applications menu from what packages are installed on the system. See [[Openbox:Pipemenus#Application_Menus|this section]] for a complete list.
+
*Obconf provides a simple graphical user interface to ease configuration for new Openbox users.
 +
 
 +
=== [[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 ==

Revision as of 20:39, 2 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

rc.xml

Configuration

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

Application settings

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

Mouse & keybindings

Binding documentation

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

Actions

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

Menus

Menu documentation

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

Actions

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

Pipe menus

  • Documentation of the pipe menu function. If you're looking for scripts there are a number of pipe menus available on the community page.

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 this section for a complete list.

Themes

Theme specification

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

Openbox 3.4 theme file changes

Desktop Environments

Openbox in GNOME

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

Openbox in KDE

  • Instructions for running Openbox in K Desktop Environment.

Openbox in XFCE

  • Instructions for running Openbox in the XFCE desktop enviroment.

No Desktop Environment

openbox-session

  • Running Openbox outside of common desktop environments and community maintained list of applications/widgets to enhance functionality of Openbox.

Autostart

  • The autostart documentation gives instructions on how to launch programs with Openbox at startup (when not running Openbox inside a full desktop environment like XFCE or KDE).

Miscellaneous

rc.xml Configuration examples

Feature list

  • A list of features found in the Openbox windowmanager.

Frequently asked questions

Compiling from source

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

Using Git

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

ObConf

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

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

  • 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