           OBPager - Copyright (C) 2004 by Roy Wood, rrwood@users.sourceforge.net

----

    This software is OSI Certified Open Source Software.
    OSI Certified is a certification mark of the Open Source Initiative.

----

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    See the COPYING file for a copy of the GNU General Public License.

----



OBPager:
========

OBPager is a simple pager dockapp designed for use with netwm-compliant window managers like OpenBox.  OBPager
shows a miniature representation of the windows on a virtual desktop, as well as the desktop number.  Clicking
on an OBPager requests a switch to that desktop by the window manager.

OBPager is very lightweight, requiring only glibc++ and Xlib; no Gnome or KDE necessary, thank you very much.
The general rationale is that if you are running something like OpenBox, you don't want all that extra baggage
anyway.


Unlike other pagers, OBPager is designed to manage a single virtual desktop, so it is expected that you
will run multiple instances of the applet-- one for each virtual desktop.  This was done intentionally,
since it looks better, IMNSHO, and it eats up what is otherwise wasted real estate in the dock/slit.  If
you don't like that, then change it, or use a different pager.


The syntax of OBPager is as follows:

	obpager [--activefont <fontname>] [--inactivefont <fontname>] [--forcesync] [desktop-number]
	
	
As you can see, the user may specify the font to use to indicate the desktop number in the pager.  A different
font is used for the active and inactive desktop numbers drawn.

If the desktop number is not explicitly specified, obpager attempts to determine the number of virtual desktops
and spawn an instance of itself to monitor each desktop.

The "forcesync" option is really only useful for debugging funky X problems, so don't worry about it.


Installing:
===========

1) Unpack the tarball: tar -xvzf obpager-X.Y.tar.gz
2) Build the obpager executable: make
3) Install the executable as root: sudo make install
4) Tweak your .xinitrc so that obpager is executed when you startx

Note that obpager is installed in /usr/local/bin by default.  If you want it installed somewhere else,
tweak the Makefile's "INSTALLDIR" setting.


TO-DO:
======

- User-specified colours?
- Implement a ".rc" config file?



