wmpager/README

   1 $Id: README,v 1.4 2002/08/16 17:24:43 essmann Exp $
   2
   3 ----------------------------------------------------------------------
   4 WMPAGER
   5 ----------------------------------------------------------------------
   6
   7 wmpager is a simple pager docklet for the Window Maker.
   8
   9 wmpager has the offers the following features:
  10 - allows workspace switching for up to nine workspaces
  11 - automatically configures according to the number of workspaces
  12 - automagically adjusts to the current workspace
  13 - configurable look and feel
  14 - workspace tooltips
  15
  16
  17 ----------------------------------------------------------------------
  18 INSTALLATION
  19 ----------------------------------------------------------------------
  20
  21 To build and install wmpager perform the following steps:
  22
  23 1. Modify the Makefile to suit your needs
  24 2. % make
  25 3. % make install
  26
  27 Notes:
  28
  29 In order for wmpager to work properly you need to have your Window
  30 Maker compiled with Gnome support. (I don't know if this is the case
  31 for the precompiled Window Makers usually found in Linux distributions
  32 since I usually build my Window Maker myself.)
  33
  34 wmpager uses the Gnome support messages sent out by Window Maker to
  35 display the currently active workspace. Without Gnome support the
  36 pager will not automatically adjust the currently active desktop.
  37
  38
  39 ----------------------------------------------------------------------
  40 USAGE
  41 ----------------------------------------------------------------------
  42
  43 usage: wmpager [options]
  44
  45 where options include:
  46   -h --help           display usage and version information
  47   -v --verbose        verbose message output
  48   -d --display        <name> the display to use (defaults to the
  49                       'DISPLAY' environment variable)
  50   -s --size           <w>x<h> number of buttons (default depends on the
  51                       number of workspaces you have, i.e. 2x2 for 4
  52                       workspaces, 2x3 for 6, maximum is 3x3)
  53   -w --workspaces     <count> number of workspace buttons to display
  54                       (default is the number of workspaces you have,
  55                       maximum is 9)
  56   -t --theme          <theme.xpm> the button theme to use, extension
  57                       '.xpm' is optional, for more information about
  58                       themes see docu (default is the built-in theme)
  59   -i --installdir     <dir> specifies the installation directory location,
  60                       this location is automatically searched for themes
  61                       (defaults to the '/usr/local/share/wmpager/'
  62                       and the user specific '~/.wmpager' directory)
  63   --disable-tooltips  do not display any tooltip windows
  64   --tooltip-font      <font> use the specified font as tooltip font
  65                       (default is helvetica, bold, roman, 12 point)
  66   --tooltip-delay     <millis> set the delay before the tooltip window
  67                       is popped up (default is 750 milliseconds)
  68   --tooltip-reshow    <millis> set the tooltip reshow delay (triggered
  69                       when moving from button to button (default is
  70                       1500 milliseconds)
  71   --tooltip-outside   display tooltip window outside of docklet
  72
  73
  74 ----------------------------------------------------------------------
  75 BUTTON THEMES
  76 ----------------------------------------------------------------------
  77
  78 Depending on your WindowMaker theme you might want to use another
  79 theme for wmpager as well. Use option '-t' or '--theme' to specify
  80 the location of an XPM file (the extension '.xpm' is optional, it has
  81 to be an XPM file though). If you use option '-i', '--installdir' or
  82 have set the environment variable WMPAGER to the installation location
  83 of the wmpager themes, then you may also skip the path to the theme.
  84
  85 Predefined themes: Well, I'm not much of an artist therefore I've only
  86 included some themes to give you an idea of how a real nice theme
  87 might be done. Naturally, I use the built-in theme and theme support
  88 is only there because I have been asked to include it...
  89
  90 Creating your own themes: If you want to create your own theme simply
  91 take one of the included XPM theme files and modify it to your needs.
  92 If you really want to know, the format of the file is described below.
  93
  94 If you create a theme yourself please send it to me and I'll include it
  95 in the next build.
  96
  97 The list of predefined themes in this release includes:
  98 - blue (the built-in theme)
  99 - fire
 100 - gray
 101 - steel
 102
 103 XPM file format: The XPM file has to be at least 102 by 71 pixels in
 104 size. The area 0,0 to 50,50 describes the background for the selected
 105 workspace, the area 51,0 to 101,50 for unselected work spaces. The
 106 area has to include a one-pixel border that is used for all workspace
 107 buttons. From 0,51 to 89,60 are the digits used for the selected
 108 workspace (each 10x10 pixels, 1-9 from left to right) and from 0,61 to
 109 89,70 are the digits for unselected workspaces. The digits may have
 110 a transparent background.
 111
 112
 113 ----------------------------------------------------------------------
 114 RELEASE NOTES
 115 ----------------------------------------------------------------------
 116
 117 Release 1.0
 118
 119 I've already been asked a couple of times why I wrote wmpager (along
 120 the lines of "wmcp is working for me isn't it for you?"). Well, yes
 121 the other pagers available are working, even for me. Main reason to
 122 write it was to play around with C/X11 a bit -- I haven't done this
 123 for a couple of years now and I simply felt like it. I know that the
 124 code is in a bad shape, but hey, I only spent a couple of hours on
 125 this thingy. :-)
 126
 127 2001 Aug 28
 128 // Bruno Essmann
 129
 130
 131 Release 1.1
 132
 133 For those of you with different Window Maker themes the wmpager now
 134 also supports themes. Check out options '--theme' and '--installdir'.
 135
 136 2001 Oct 12
 137 // Bruno Essmann
 138
 139
 140 Release 1.2
 141
 142 As of release 1.2 the wmpager is hosted at sourceforge. Its new
 143 homepage is located at 'http://wmpager.sourceforge.net/'.
 144
 145 To report a bug please use the sourceforge bugtracker for the wmpager
 146 located at 'http://sourceforge.net/projects/wmpager/'. Thanks!
 147
 148 In addition to the new location the only thing that has changed is
 149 that wmpager no longer supports the WMPAGER environment variable. Use
 150 '--installdir' to specify its installation location or copy the theme
 151 file to your home directory '$HOME/.wmpager/'.
 152
 153 2002 Aug 16
 154 // Bruno Essmann <essmann@users.sourceforge.net>
 155
 156 PS: Don't be surprised that the build number has restarted. I simply
 157 threw away the old revision history and switched to cvs.
 158
 159
 160 ----------------------------------------------------------------------
 161 LICENSE INFORMATION
 162 ----------------------------------------------------------------------
 163
 164 Copyright (c) 2001-2002 Bruno Essmann <essmann@users.sourceforge.net>
 165 All rights reserved.
 166
 167 Redistribution and use in source and binary forms, with or without
 168 modification, are permitted provided that the following conditions
 169 are met:
 170
 171 1. Redistributions of source code must retain the above copyright
 172    notice, this list of conditions and the following disclaimer.
 173
 174 2. Redistributions in binary form must reproduce the above
 175    copyright notice, this list of conditions and the following
 176    disclaimer in the documentation and/or other materials provided
 177    with the distribution.
 178
 179 3. The name of the author may not be used to endorse or promote
 180    products derived from this software without specific prior
 181    written permission.
 182
 183 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
 184 OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 185 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 186 ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 187 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 188 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 189 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 190 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 191 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 192 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 193 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 194