wmbutton/README

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