2 Copyright (c) Tom Payne 2003
3 Copyright (c) Per Olofsson 2003
5 by Tom Payne <ion@tompayne.org>
6 based on code by Per Olofsson <pelle@dsv.su.se>
10 This module provides a dock for the Ion window manager.
13 - supports most dockapps
15 - configurable dockapp order
16 - supports shaped dockapps
17 - uses ion's drawing engine
25 1. Copy the configuration files cfg_dock.lua and dock-draw.lua to
26 your ~/.ion3 directory. Edit cfg_dock.lua and dock-draw.lua to
27 suit your preferences.
29 2. Add load_module("mod_dock") to ~/.ion3/cfg_ion.lua.
31 3. Add include("dock-draw.lua") near the end of ~/.ion3/draw.lua,
38 See the comments in cfg_dock.lua and dock-draw.lua.
42 Not all dockapps dock. This is because dockapps use a variety of methods
43 to signal that they are dockapps and the dock doesn't yet
44 recognise all of them. If your favourite dockapp does not work then
45 please inform the author (email address at top of file).
47 The following dockapps are known to have problems:
49 - gkrellm2 can have the wrong shape if it is started after the dock
52 - wmxmms needs a winprop{...}. See the example cfg_dock.lua. Ion
53 complains: Client window "wmxmms" has broken transient_for hint.
54 ("Extended WM hints" multi-parent brain damage?).
58 If you would like to help improve the dock then the following
59 notes might be useful.
61 You should use folding in your editor when you edit/view the source
62 code. The code follows ion's coding standards, but there are many more
63 folds. VIM and Emacs both support folding.
65 Dockapps use a variety of methods to signal to the window manager that
66 they are a dockapp. Ion automatically detects some (see
67 manage_clientwin() in ioncore/clientwin.c), and the dock detects
68 some others (see dock_clientwin_is_dockapp() in dock.c). Adding more
69 dockapp types will require editing these functions and possibly writing
70 type-specific management code.
72 The dock should really implement region_save_to_file()/region_load() to
73 maintain state over a restart and session management. However, over
74 restart a new dock will also be created by cfg_dock.lua, meaning that there
75 will be multiple docks on the same screen. The solution is probably to
76 automatically create docks as they are required, with cfg_dock.lua
77 specifying the default configuration of new docks but not actually
80 As far as I can tell the gkrellm2 problem is a race condition and the
81 sequence of events is as follows:
82 1. gkrellm2 starts and gets added to the dock with is initial geom.
83 2. gkrellm2 grows as it loads plugins.
84 3. The dock allocates more space to gkrellm2 and requests
85 gkrellm2's new shape, but gkrellm2 reports its old shape.
86 4. Further requests to gkrellm2 return is new (actual) shape, but by
88 Any assistance in fixing this bug would be much appreciated.
92 Tom Payne <ion@tompayne.org>
93 Per Olofsson <pelle@dsv.su.se>
97 This program is licensed under the terms of the Lesser General Public
98 License (LGPL) version 2.1. See the file COPYING for details.