*Title: OroboROX User Manual
*Author: By Guido Schimmels and Jonatan Liljedahl
*Image-center: ../.DirIcon

#---PASS-HTML <div class="chapter">
_Table of contents_
*TOC
#---PASS-HTML </div>

* Introduction

_OroboROX is a window-manager_ and nothing else. It has no panel/taskbar,
desktop icons or root-menu. OroboROX is meant to be used with ROX-Filer,
which provides all these.

OroboROX features a capable pixmap theme engine, mostly backwards
compatible with Xfwm4, which has a few enhancements not yet available in
OroboROX. Easily portable are also themes created for OroborOSX, the
window-manager Apple ships with MacOS X (X11.app). Thus a wealth of
themes is readily available from the start. 14 high-quality themes are
included in this distribution.

Title fonts are freely configurable. The title may be centered, left
aligned or right aligned. Button layout is also freely configurable. 
Color schemes may be defined independent from the themes. There is lots
of settings that can be changed by right- clicking the OroboROX icon and
choosing 'Options...'

OroboROX is fully keyboard controllable. Shortcuts can be freely defined
in the ''KeyBindings options''.

* Mouse buttons

The focus and raise behaviour is
configurable in the ''Windows options''.

The left (1) button on the window title always moves the window,
the window will be raised or kept at the same stacking level depending on
the ''Raise policy setting''.
Middle (2) and right (3) buttons are individually configurable to
move/resize window and to raise/lower/keep the stacking level.

All actions available when clicking or dragging on the window title is also
available anywhere in a window by holding down the Window-ops-modifier key,
configurable in the ''KeyBindings options''.

Some window title buttons have extra functions when clicked with
mousebutton 2 or 3:

	[Minimize] Button 3 toggles Shaded.
	[Sticky] Button 3 toggles OnTop.
	[Close] Button 3 does hard kill of client (use with care).
	[Maximize] Button 2/3 does Vertical/Horizontal maximize.

ScrollWheel on window title shades/unshades.

* Theme and Scheme AppDir's

Themes and Schemes are packaged as ''AppDir's'' and are relocatable.

To create a Theme-AppDir, just put your theme in a dir and copy
LoadTheme.sh to AppRun and make it executable, and put a .DirIcon
preview image and an AppInfo.xml inside the AppDir as usual... Same thing for
Schemes, but use LoadScheme.sh instead.

OroboROX themes consist of a number of bitmap graphics elements (tiles)
in XPM format. These are the four corner pieces,  the three elements 
which form the left, right and bottom of the frame, and the titlebar 
made of five elements, to allow for fancy and assymetrical themes.
Each frame element must be provided for the active and inactive state.
When you want an element to look similar in both states, you achieve this
by copying or symlinking the pixmap file to the proper name.

OroboROX supports five types of titlebar buttons with three distinct states,
the active and inactive states like with the other frame elements, plus 
the pressed state. Again you can use the copying or symlinking trick, if you
don't intend to make these states visually distinct.

Supported Button Types:

	* shade (roll-up)
	* hide (minimize/iconify)
	* close
	* maximize 
	* stick (show on all workspaces)

