README
1 OBPager - Copyright (C) 2004 by Roy Wood, rrwood@users.sourceforge.net
2
3----
4
5 This software is OSI Certified Open Source Software.
6 OSI Certified is a certification mark of the Open Source Initiative.
7
8----
9
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
19
20 See the COPYING file for a copy of the GNU General Public License.
21
22----
23
24
25
26OBPager:
27========
28
29OBPager is a simple pager dockapp designed for use with netwm-compliant window managers like OpenBox. OBPager
30shows a miniature representation of the windows on a virtual desktop, as well as the desktop number. Clicking
31on an OBPager requests a switch to that desktop by the window manager.
32
33OBPager is very lightweight, requiring only glibc++ and Xlib; no Gnome or KDE necessary, thank you very much.
34The general rationale is that if you are running something like OpenBox, you don't want all that extra baggage
35anyway.
36
37
38Unlike other pagers, OBPager is designed to manage a single virtual desktop, so it is expected that you
39will run multiple instances of the applet-- one for each virtual desktop. This was done intentionally,
40since it looks better, IMNSHO, and it eats up what is otherwise wasted real estate in the dock/slit. If
41you don't like that, then change it, or use a different pager.
42
43
44The syntax of OBPager is as follows:
45
46 obpager [--activefont <fontname>] [--inactivefont <fontname>] [--forcesync] [desktop-number]
47
48
49As you can see, the user may specify the font to use to indicate the desktop number in the pager. A different
50font is used for the active and inactive desktop numbers drawn.
51
52If the desktop number is not explicitly specified, obpager attempts to determine the number of virtual desktops
53and spawn an instance of itself to monitor each desktop.
54
55The "forcesync" option is really only useful for debugging funky X problems, so don't worry about it.
56
57
58Installing:
59===========
60
611) Unpack the tarball: tar -xvzf obpager-X.Y.tar.gz
622) Build the obpager executable: make
633) Install the executable as root: sudo make install
644) Tweak your .xinitrc so that obpager is executed when you startx
65
66Note that obpager is installed in /usr/local/bin by default. If you want it installed somewhere else,
67tweak the Makefile's "INSTALLDIR" setting.
68
69
70TO-DO:
71======
72
73- User-specified colours?
74- Implement a ".rc" config file?
75
76
77
78