wmii/README

Abstract
--------
window manager improved 2 is a dynamic window manager for X11.
It supports classic and tiled window management with extended
keyboard, mouse, and 9P-based [2] remote control.
It consists of the wmiiwm(1) window manager, the wmiir(1)
remote access utility, and a tiny wmiimenu(1).


Requirements
------------
In order to build wmii you need the Xlib header files.
Furthermore, the wmii configuration scripts rely on the 9base package [3]
which contains ports of various Plan 9 standard tools, in particular the
rc shell.  However, if you already have plan9ports installed, then you
can use this instead of 9base.  In any case, make sure that 9PREFIX in
wmii's config.mk points to the right location.


Installation
------------
Edit config.mk to match your local setup. wmii is installed into
the /usr/local hierarchy by default. If your system is Mac OS X,
then remove the '-static' flag in cmd/Makefile. If your system is
Solaris, grep recursively for 'Solaris' and uncomment all occurences
to make wmii compile or ask Sun to make their system POSIX compliant.

Afterwards enter the following command to build and install wmii (if
necessary as root):

    make clean install


Running wmii
------------
Add the following line to your .xinitrc to start wmii using startx:

    exec wmii

In order to connect wmii or wmiir to a specific display, make sure that
the DISPLAY environment variable is set correctly, e.g.:

    DISPLAY=foo.bar:1 exec wmii

This will start wmii on display :1 of the host foo.bar.


Configuration
-------------
The configuration of wmii is done by customizing the wmiirc script,
which remotly controls the window manager and handles various events
the window manager reports while runtime.
To customize the wmiirc, copy the file from PREFIX/etc/wmii-3
(usually /usr/local/etc/wmii-3) to $HOME/.wmii-3 and edit it to fit
your needs.  You should be familiar with rc, though.  The rc manpage
(included in 9base) is quite small and there's also a paper available
[4].


Credits
-------
The following people have contributed especially to wmii in various ways:

- Christoph Wegscheider <christoph dot wegscheider at wegi dot net>
- Georg Neis <gn at wmii dot de>
- Uwe Zeisberger <zeisberg at informatik dot uni-freiburg dot de>
- Uriel <uriel at wmii dot de>
- Scot Doyle <scot at scotdoyle dot com>
- Sebastian Hartmann <seb dot wmi at gmx dot de>
- Bernhard Leiner <bleiner at gmail dot com>
- Jonas Domeij <jonas dot domeij at gmail dot com>
- Vincent <10 dot 50 at free dot fr>
- Oliver Kopp <olly at flupp dot de>
- Sebastian Roth <sebastian dot roth at gmail dot com>
- Steve Hoffman <steveh at g2switchworks dot com>
- Christof Musik <christof at senfdax dot de>
- Steffen Liebergeld <perl at gmx dot org>
- Tobias Walkowiak <wal at ivu dot de>
- Sander van Dijk <a dot h dot vandijk at gmail dot com>


References
----------
[1] http://wmii.de
[2] http://www.cs.bell-labs.com/sys/man/5/INDEX.html 
[3] http://wmii.de/repos/9base/
[4] http://www.star.le.ac.uk/~tjg/rc/misc/td