README

INTRODUCTION

The design goal for waimea is to create the most efficient desktop working environment available. To achieve this waimea is a fast and highly customizable virtual multiple desktop window manager. It has a very advanced style engine with features like blackbox style support, pixmap style support and transparent textures. Text can be ren­ dered double buffered using both X core fonts and Xft fonts. Waimea also includes a fast lightweight menu sys­ tem with dynamic menus support. The built in action con­ figuration system makes waimea the most configurable win­ dow manager available. It allows the user to set up waimea to behave as any other window manager or in new ways never before possible.

Features already included are: Virtual desktop sizes Multiple desktops Blackbox image rendering engine (blackbox style support) Pixmap styles Translucent textures using Xrender extension Action configuration system Advanced menu system (with dynamic menus support) Standard X core fonts Xft fonts (anti-aliased fonts) Double buffered text Dockapp handler system Task switcher Configurable titlebar buttons KDE3/GNOME2 support Merged windows

DEPENDENCIES

waimea depends on:
	xfree86-4.2.1
waimea will utilize:
	imlib2-1.0.6

INSTALLATION

Install waimea by running the following commands:

----- cut here -----
./configure --prefix=/usr --enable-shape --enable-xinerama \
	--enable-render --enable-randr --enable-xft \
	--enable-pixmap &&
make &&
make install
----- cut here -----

Command explanations

--enable-shape  : This command activates waimea's ability 
to support non-rectangular windows.

--enable-xinerama   :  This  command  activates  waimea's 
ability to support Xinerama screens.

--enable-render   :   This  command  activates   waimea's 
ability to render transparent textures.

--enable-randr  : This command activates waimea's ability
to handle dynamic screen size changes.

--enable-xft : This command activates waimea's ability to
render anti-aliased text.

--enable-pixmap : This command activates waimea's ability
to use pixmap styles.

CONFIGURATION

Config files

~/.waimearc, ~/.waimea/actions/action, 
~/.waimea/styles/Default.style, ~/.waimea/menu

Configuration Information

Be sure to backup your current .xinitrc before proceeding.

----- cut here ----- cat >> ~/.xinitrc << "EOF" exec waimea EOF ----- cut here -----

----- cut here -----
cat >> ~/.waimearc << "EOF"
screenMask:          0 1 2 3
doubleClickInterval: 300

screen0.styleFile:          ~/.waimea/styles/Default.style
screen0.menuFile:           ~/.waimea/menu
screen0.actionFile:         ~/.waimea/actions/action

screen0.numberOfDesktops: 4 screen0.desktopNames: Desktop 1,Desktop 2,Desktop 3,Desktop 4 screen0.doubleBufferedText: True screen0.colorsPerChannel: 8 screen0.cacheMax: 200 screen0.imageDither: True screen0.virtualSize: 3x3 screen0.menuStacking: Normal screen0.transientAbove: True screen0.focusRevertTo: Window screen0.dock0.geometry: -0+0 screen0.dock0.order: n/.*/ screen0.dock0.desktopMask: All screen0.dock0.centered: False screen0.dock0.direction: Vertical screen0.dock0.gridSpace: 2 screen0.dock0.stacking: AlwaysOnTop screen0.dock0.inworkspace: False EOF ----- cut here -----

----- cut here -----
mkdir ~/.waimea &&
mkdir ~/.waimea/styles &&
mkdir ~/.waimea/actions &&
cp /usr/share/waimea/styles/Default.style ~/.waimea/styles/Default.style &&
cp /usr/share/waimea/actions/action ~/.waimea/actions/action &&
cp /usr/share/waimea/menu ~/.waimea/menu
----- cut here -----

Configuration  options are set by  editing `~/.waimearc'. 
Available options  and syntax is  explained in the waimea 
man page.

Key and mouse bindings are set by editing `~/.waimea/act-
ions/action'.  The syntax is explained in the  waimea man 
page.

Menu  Items are  added by  editing `~/.waimea/menu'.  The 
syntax is explained in the waimea man page.

BUGS Bug reports, patches and suggestions are much appreciated, send them to the author.

AUTHOR David Reveman ( david@waimea.org )

The waimea website: http://www.waimea.org