#@+leo-ver=4
#@+node:@file INSTALL
#@@language
------------------------------------------------------
INSTALL file for PYWM - Python Window Manager
http://pywm.sourceforge.net
------------------------------------------------------
*** RUNTIME REQUIREMENTS

To run PYWM, you will need:

 * Python 2.2.1 or later
 * FLTK graphical toolkit version <2 but preferably =>1.1.4
   library. If your distro does not have
   it, you can get it from http://fltk.sourceforge.net
 * Everything else should depended on by fltk, but report
   if that's not the case
 
------------------------------------------------------
*** INSTALLING BINARY PACKAGE

 * There is no binary offered in this package (with the 
   old binary distributed in the 0.1 release there's
   a version mismatch with current python, f.ex.), so building
   from source is encouraged. I'll gladly help, or might even
   send a binary if asked nicely=). If you'd like to try
   the old binary, it's in the original 0.1 release (read 
   the instructions in that particular package).

------------------------------------------------------
*** BUILDING FROM SOURCE

This section describes how to compile PYWM completely
from source and install it to your system.

------------------------------------------------------
**** COMPILATION REQUIREMENTS

Building from source will require the following:

  * python 2.2.1 or later
  
  * FLTK graphical toolkit version >2 but preferably =>1.1.4
    at least the linkable libraries and header files.
    FLTK is available from http://fltk.sourceforge.net
    Make sure you have FLTK version 1.0 installed before
    trying to build PYWM.
  * Pyrex - Python<->C interface generator. Best thing
    since Python itself. Install either the Debian package
    python-pyrex, search your distros packages or from:
    http://www.cosc.canterbury.ac.nz/~greg/python/Pyrex/
  * g++
  * Development versions of the following libraries:
    xlibmesa[3], libgl[1], xlibs

------------------------------------------------------
*** COMPILATION INSTRUCTIONS

If you have successfully [built and] installed FLTK, you
can log in as root and type:
    
    'python setup.py install' (or 'python setup.py build', and link to
    it by means of a site.py, etc)

If the install completes successfully, you will have:
 
  * The PYWM launcher utility, installed as
    /usr/bin/pywm-run.py
    This program pops up a window of available window
    manager scripts, as well as an xterm fallback
    
  * The directory 'pywm' installed in your Python
    site-packages directory. Note that within this pywm
    directory is a copy of the examples directory.

------------------------------------------------------
*** HOW DO I RUN A WINDOW MANAGER?

Perhaps the most comfortable way to do this is to put
into your ~/.xinitrc file the command:

    pywm-run.py

When you restart your X server, you should see a menu on
the screen listing 2 options - 'example1' and 'X-Term'.

To add your own window manager scripts to this menu,
simply place or symlink these scripts into ~/.pywm.

Note that if you are adding a Python file, you will
need to copy or symlink it in with a .py or .pyc
extension. Anything with a different extension will be
ignored, while anything without an extension will be
launched with a shell instead of with python.
    
Look in the examples/ directory for some working
examples, which should give you some ideas for building
your own heavenly window managers.

Refer to the README file, plus the API reference manual
(in the html/ directory, generated by 'make doc') for more information.

*** ALTERNATELY

You could simply put into your ~/.xinit file the command
  python /path/to/my/pywm/examples/example1.py
(replace example1.py with whatever script you are using).
#@-node:@file INSTALL
#@-leo