Make AddMouseRegion's index unsigned
[dockapps.git] / wmcp / README
blobe164031478bfef85fea9b7f89c12af767d92a260
3 wmcp ( Window Maker Crappy Pager )
5 Version 1.2.8
7         Origional Author:
8                 Ben Cohen <buddog@aztec.asu.edu>
10     Contributors: ( ** Thanks alot to them !! ** )
11        Thomas Nemeth <tnemeth@multimania.com>  -- Pushed button highlighting
12        Craig Maloney <craig@ic.net>            -- CTRL + ALT + key option
13        Gert Beumer <Gert@scintilla.utwente.nl> -- Dynamic button sizes
17 A simple dockable pager for use in Window Maker.
18 ---------------------------------------------------------------------------
21 INSTALL:
22 --------
24         Unzip the file: gunzip wmcp-1.2.8.tar.gz
25         Untar the file: tar xvf wmcp-1.2.8.tar
26         CD to src dir:  cd wmcp-1.2.8
28         do one of these makes:
29         make            -- make wmcp using the default button scheme (scalpel)
30     make scalpel    -- make wmcp using the scalpel style button colors
31     make gv         -- make wmcp using the ghostview style button colors
33         copy wmcp to some directory in your $PATH.
34         ( ie: cp wmcp /usr/local/bin )
36         type wmcp
38         Grab the appicon and move it to the dock.
40         If make doesn't work, you may need to fiddle with the settings in
41         the Makefile.
43         Tested on:
44                 WindowMaker-0.20.3
45                 WindowMaker-0.50.2
46                 X Clients: Red Hat 5.0, Red Hat 6.0, HP-UX 10.20
47                 X Servers: XFree86, Exceed, AccelX
51 USAGE:
52 ------
54 usage: wmcp [-g geometry] [-d dpy] [-n workspaces] [-a alt key] [-v]
55             [-c] [-w i/n/w] [-s y/n] [-x #] [-y #] [-h]
57 -g    geometry:    ie: 64x64+10+10
58 -d    dpy:         Display. ie: 127.0.0.1:0.0
59 -n    workspaces:  How many buttons to start with.
60 -a    alt key:     integer 1-4 defining ModXMask (default 1 Mod1Mask).
61 -w    i/n/w:       Window State: Iconic, Normal, Withdrawn (default Withdrawn)
62 -s    y/n:         Shaped window: yes or no (default y)
63 -c                 Sends CTRL + ALT + Key (default only sends ALT + key)
64 -v                 Verbose. 0=off, 1=on (default 0)
65 -x    #            Number of buttons on the x-direction (1,2,3 or 4)
66 -y    #            Number of buttons in the y-direction (1,2,3 or 4)
67 -h                 Help. This screen.
70 Left mouse button:
71         Selects the workspace to switch to.
73 Right / Middle mouse buttons:
74         Change the number of buttons displayed.
77 EXAMPLES:
78 ---------
79     Use all defaults. Good for WindowMaker.
80     mwdl
82         Normal X window, non shaped window, send CTRL + ALT + key
83     wmdl -w n -s n -c
85         2x2 button grid:
86         wmdl -x 2 -y 2
88         2x3 button grid:
89         wmdl -x 2 -y 3
92 NOTES:
93 ------
95 This pager works by sending synthetic ALT + number key press events to the
96 root window.  The "-c" command line switch makes the application send
97 a CNTRL + ALT + number key which might be of use in another window manager.
99 Because the ALT key may have different key codes on different X servers,
100 you can use the -a command line switch to change which meta key is used.
101 I doubt anyone will ever have to do this though. The Mod1Mask which is the
102 program's default seems to work on most if not all systems.
104 I don't know of any Window Maker hooks for determining things like how
105 may workspaces are actually in use. If any one know about this stuff, please
106 let me know.
108 It is very easy to change the look of wmcp by editing the colors in the
109 pixmap files. Someday we'll add an official 'skins' ability but for now
110 just edit the xpm files to change the colors etc.
112 This program is released under the GPL license and has been created by looking
113 a lot at the code for wmppp, wmtime, wmload and various other Window Maker
114 resources and info on the Web and Usenet.
117 BTW, the one true enlightened way is "Sloppy Focus."
120 CHANGE LOG:
121 -----------
123 1.2.8  May 25, 1999 -- Gert Beumer
124        Added -x and -y functionality to configure the amount of buttons.
125        Changed the rendering of the buttons from the pixmap
126        (to suport multiple button startup)
128 1.2.6  Feb 11, 1999
129        Once again changed the button XPM styling.
130        Added window state = Iconic, Normal, or Withdrawn.
131        Added shaped window = yes or no.
132        CTRL + ALT code added by -- Craig Maloney <craig@ic.net>.
134 1.2.5  Jan 25, 1999
135                 Made buttons flat style ala Ghostview 3.5.8
137 1.2    Jan 24, 1999
138            Pushed button images added by Thomas Nemeth <tnemeth@multimania.com>
140 1.1    Dec 24ish, 1998
141            Origional version.
143 TODO:
144 -----
146 Add a simple method for changing 'skins' other than just editing the XPM
147 files by hand.
149 Add catching Window Maker's events to know how to refresh the pager when
150 the current workspace is changed via the clip, and how to get the number
151 of workspaces actually in use.
154 Please send comments, flames, etc to buddog@aztec.asu.edu
156 - Ben Cohen