4 This is a release candidate for version 3.0 and should be quite
5 stable. There have been substantial changes from earlier development
8 Instructions for using Ion3 can be found in the manual page ("man
9 ion3"). Additional documentation is included in the ion3-doc package:
10 "Configuring and extending Ion3 with Lua" and "Ion: Notes for the
11 module and patch writer". There is an FAQ online at
12 <http://modeemi.fi/~tuomov/ion/faq.html>.
14 Some scripts extending Ion3 are available in the ion3-scripts package,
15 though this is not currently maintained.
17 There is an unofficial module adding Xinerama support in the
18 mod-xinerama-for-ion package.
23 Binaries in this package are unstripped since 20050322-4 at the
24 upstream author's request. There is no separate -dbg package.
26 Docks and system trays
27 ----------------------
29 Ion3 is compatible with the docking protocols used by WindowMaker and
30 KDE. It can place docked applications windows either in a corner
31 dock, or in a "system tray" in the status bar.
33 For a corner dock, add:
37 to cfg_ion.lua or cfg_modules.lua and edit cfg_dock.lua to your
38 preferences. The dock window's visibility can be toggled using
41 For a system tray, edit cfg_statusbar.lua to include:
43 mod_statusbar.create {
46 template="... %systray"
49 You can also configure specific windows to appear in the status bar:
53 class = "foo-window-class",
57 -- In cfg_status_bar.lua:
58 mod_statusbar.create {
60 template="... %systray_foo"
63 GNOME unfortunately uses a different dock protocol. However, the
64 docker program can adapt from this to the WindowMaker protocol. So you
65 can include a GNOME system tray in your status bar by including docker
66 in your X session and this in your Ion3 configuration:
74 -- In cfg_statusbar.lua:
75 mod_statusbar.create {
77 template="... %systray_dock"
80 Adding configuration files to the defaults
81 ------------------------------------------
83 Ion3 extension packages may add and remove configuration files to
84 those included by cfg_defaults.lua. The configuration files must be
85 installed under /etc/X11/ion3. Run "install-ion3-cfg cfg_foo" in the
86 postinst script to add the configuration file
87 /etc/X11/ion3/cfg_foo.lua. Run "install-ion3-cfg --remove cfg_foo" in
88 the prerm script to remove it.
90 -- Ben Hutchings <ben@decadent.org.uk>, Tue, 7 Aug 2007 00:35:02 +0100