README
1Description
2-------------------------------------------------------------
3wmDrawer is a dock application (dockapp) which provides a
4drawer (retractable button bar) to launch applications.
5
6Homepage : http://people.easter-eggs.org/~valos/wmdrawer/
7IRC : irc.freenode.net, #wmdrawer
8
9# The drawer is retractable and animated.
10# Several columns of buttons can be defined in the drawer.
11# The config file is automaticaly reloaded if it changes.
12# Multiple instances of the program can run at the same time.
13# The buttons can be highlighted under the mouse cursor.
14# A tooltip can be defined for each button.
15# The drawer can be transparent (need SHAPE extension).
16# Ability to launch several apps at once from the drawer.
17 By holding down the key Shift or by using mouse buttons
18 middle or right instead of left, you can keep the drawer
19 opened.
20# Adjustable behaviors:
21 - dock's image (logo)
22 - dock's width and height (for both min=12, max=128)
23 - automatic/manual opening and closing of the drawer
24 - timeout value in miliseconds if automatic closing selected
25 - drawer's opening direction and animation speed
26 - mouse cursor type in the drawer
27 - drawer's pseudo-transparency
28 - icons' background image (only if transparency isn't activated)
29 - buttons' size (min=12, max=128)
30 - buttons' highlight type (0:none, 1:target, 2:shading)
31 - image used as highlight (target type only)
32 - color and darkening level for highlight (shading type only)
33 - drawer's border size
34 - buttons' tooltips and tooltips' font
35
36Bugs
37-------------------------------------------------------------
38If you discover any bug in this software, please send a
39bugreport to vfebvre@easter-eggs.com and describe the problem with
40as many details as possible.
41
42Copyright
43-------------------------------------------------------------
44wmDrawer is Copyright (C) 2002-2004 by Valery Febvre, FRANCE
45
46wmDrawer is licensed through the GNU General Public License.
47Read the COPYING file for the complete GNU license.
48
49Usage
50-------------------------------------------------------------
51Simply launch wmdrawer binary:
52$ wmdrawer
53You need to write a config file (.wmdrawerrc) and put it in
54your home directory (look at INSTALL and wmdrawerrc.example
55files for futher information).
56
57To launch wmDrawer with a specific configuration file (useful
58if you want to launch several instances of wmDrawer)
59$ wmdrawer -c config_file [-n instance_name]
60
61To launch wmDrawer in windowed mode (useful for AfterStep,
62Fvwm, Sawfish or KDE users)
63$ wmdrawer -w
64
65To display the version of wmDrawer
66$ wmdrawer -v
67