wmbutton/README

   1 wmbutton Ver. 0 Rel 6.1
   2 -------------------------------------------------------------
   3    Code is based on wmppp, wmload, wmtime, wmcp, and asbutton
   4    Author: Edward H. Flora <ehf_dockapps@cox.net>
   5            This version is released by:
   6            Christian 'Greek0' Aichinger <Greek0@gmx.net>
   7    Ver 0 Rel 6.1    Jan 23, 2005
   8
   9 DESCRIPTION:
  10 ------------
  11 wmbutton is a simple application launching program that sits in the
  12 dock in WindowMaker, can be swallowed by Wharf in Afterstep, and
  13 should be fairly configurable.
  14
  15 LICENSING:
  16 ----------
  17 This program is released under the GPL license.  A copy (in case you
  18 don't already have hundreds of them floating around) can be found in
  19 this distribution in the file COPYING
  20
  21 CONTRIBUTORS:
  22 -------------
  23               Christian 'Greek0' Aichinger <Greek0@gmx.net>
  24                   Did some code cleanup and fixed several memory leaks.
  25               Ralf Horstmann <ralf.horstmann@gmx.de>
  26                   Added ability to load pixmaps at startup,
  27                   without having to re-compile
  28               Michael Cohrs <camico@users.sourceforge.net>
  29                   Added Tool Tips, and updated graphics
  30               Bruno Essmann <essmann@users.sourceforge.net>)
  31                   Creator of wmpager
  32               Ben Cohen <buddog@aztec.asu.edu>
  33                   original author of wmcp (et al.)
  34               Thomas Nemeth <tnemeth@multimania.com>
  35                   contributor to wmcp
  36               Casey Harkins <charkins@cs.wisc.edu>
  37                   Bug fix reading config file path - 3/6/99
  38                   Added button-presses, and other - denoted by *charkins*
  39               Michael Henderson <mghenderson@lanl.gov>
  40                   Application ideas, suggestions
  41               Ryan ?? <pancake@mindspring.com>
  42                   Modified wmbutton to asbutton.
  43                   Note: asbutton is a seperate program, not associated
  44                         with wmbutton (just as wmbutton is not associated
  45                         with wmcp)
  46               Jon Bruno
  47                   Web Page Development
  48 The contributors listed above are not necessarily involved with the
  49 development of wmbutton.  I'm listing them here partially as thanks for
  50 helping out, catching bugs in the code, etc.
  51
  52 INSTALLATION:
  53 -------------
  54         Untar the file:
  55                 tar xvzf wmbutton-0.6.1.tar.gz
  56
  57         CD to source directory:
  58                 cd wmbutton-0.6.1
  59
  60         Edit background xpm, and buttons.xpm to your preferences
  61         There are icon files in ./icons to work from
  62
  63         Compile it:
  64                 make clean; make
  65
  66         Copy the config file:
  67                 cp .wmbutton ~
  68
  69         Put the executable somewhere in your path:
  70                 mv wmbutton /usr/local/bin (or anyhere in your path)
  71
  72         Run it:
  73                 wmbutton &
  74
  75         Grab the appicon and move it to the dock.
  76         Change the settings to start with Windowmaker
  77
  78         Afterstep Wharf 1.6.??:
  79         *Wharf wmbutton -Swallow "wmbutton" wmbutton &
  80
  81     ***Note***:
  82         The appicon has only a two pixel border where you can grab
  83         and move it.
  84
  85         If make doesn't work, you may need to fiddle with the settings in
  86         the Makefile.
  87
  88         Tested on: (Well, it runs, I don't know if 'Tested' is quite right...)
  89                 WindowMaker-0.80.1
  90                 Afterstep 1.6.?
  91                 Fluxbox 0.9.9
  92                 Clients: Red Hat 8.x, Kernel 2.4.18
  93
  94
  95 USAGE:
  96 ------
  97 wmbutton [-g geom] [-d dpy] [-f cfgfile] [-b btnfile] [-F <font>]
  98          [-v] [-s] [-n]
  99
 100  wmbutton Ver 0 Rel 6.1
 101
 102 -g <geometry>  Window Geometry - ie: 64x64+10+10
 103 -d <display>   Display -  ie: 127.0.0.1:0.0
 104 -f <filename>  Full path to configuration file.
 105 -b <filename>  Full path to button xpm.
 106 -F <font>      Custom tooltip font (e.g. -b\&h-lucidatypewriter-medium-*-*-*-12-*)
 107 -v             Verbose Mode.
 108 -h             Help. This message.
 109 -m             Disable Middle Mouse functionality.
 110 -s             Swap tooltip colors.
 111 -n             Turn off tooltips.
 112
 113 Left mouse button:
 114         Selects the application to launch, numbered 1 through 9
 115
 116 Middle mouse button: (unless disabled (-m))
 117         Selects the application to launch, numbered 11 through 19
 118
 119 Right mouse button:
 120         Selects the application to launch, numbered 21 through 29
 121
 122 NOTES:
 123 ------
 124 This is a simple application launching tool for use in WindowMaker, and
 125 possibly Afterstep.  (Who knows, it should run for other window managers too,
 126 by why bother??  It is taken from wmcp, by Ben Cohen, and modified just
 127 enough to run applications rather than send ALT-[1..9] key sequences to
 128 WindowMaker.  It has also taken some ideas from asbuttons, and
 129 included them back into the original.  There may still be some code
 130 left over from wmcp that is no longer needed, but...
 131
 132 The mini-icons must be combined into a single graphic, buttons.xpm.  The
 133 background border is defined in backdrop.xpm.  Both must be edited in your
 134 favorite graphics editor (GIMP??), and then recompiled.  wmbuttons uses a
 135 configuration file (usually ~/.wmbutton) for which applications to launch.
 136 There is no need to restart wmbuttons when simply changing the configuration,
 137 as wmbutton searches the file whenever a button is pressed.
 138
 139 As of release 0.5, you can also pass in your own pixmap file for the
 140 buttons, to override the buttons that are compiled it.  This file should
 141 still have the same height and width so that it will make sense,
 142 though really you give it any XPM you want, but it will only display
 143 the upper left 54x54 pixel corner.
 144
 145
 146 An example file is included, related to the the buttons.xpm graphic file.
 147
 148
 149 CHANGE LOG:
 150 -----------
 151 0.6.1 Minor changes to the Makefile.
 152 0.6 Code cleanup and fixes for memory leaks by Christian 'Greek0' Aichinger.
 153 0.5     Added Modifications submitted by Ralf Horstmann.
 154           Load different pixmaps at start-up time, rather than having
 155           to compile them in.  This also makes it much easier to run
 156           multiple copies.
 157         Added Modifications submitted by Michael Cohrs.
 158           Added Tool-Tips
 159         Updated default buttons.xpm graphics
 160         General Code clean-up, including export must functions to
 161           seperate C file, to reduce clutter.
 162
 163 0.4     Added Modifications submitted by Casey Harkins.
 164           Start application on mouse button release,
 165           Only start app if cursor is still on application button
 166           Added 3-D button press look
 167         Added new .wmbutton configuration file
 168
 169 0.3     Graphics changed to incorporate most changes made by asbutton
 170         Removed Middle/Right mouse click on button to turn off buttons
 171           after it.
 172         Added Middle and Right mouse buttons to run more Applications
 173           (Yes, you can now really run 27 different Apps from a single
 174           instance of wmbuttons, if you would want too...)
 175         Fixed bug for finding config file .wmbutton.
 176           It used to not look in the home directory, but in the
 177           startup directory.  Thanks to Casey harkins for the fix.
 178         Included the icons directory from the asbutton distribution,
 179           plus a few more.
 180
 181 0.2     Added single configuration file, user selectable.
 182
 183 0.1     Origional version.
 184           Shamelessly taken from wmcp 1.2.5,
 185           by Ben Cohen <buddog@aztec.asu.edu>
 186
 187 TODO:
 188 -----
 189 Add ability (via config file) to use discrete 16x16 pixel icons for
 190   the buttons, rather than having to paste them all into the existing file.
 191 Make changing icons and/or background graphics easier.
 192 Allow for less than 9 icons, 4 would be nicer on the mini-icon size.
 193
 194 BUGS:
 195 -----
 196 Remember, they're just undocumented FEATURES!!!
 197
 198 Probably Lots.  Send comments (preferably with fixes) to
 199 <ehf_dockapps@cox.net>
 200
 201
 202 Good Luck.
 203
 204
 205 "C code.  C code run.  Run, code, run.
 206                         PLEASE!?!?!?!?!?!?"
 207
 208