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.
20 Docks and system trays
21 ----------------------
23 Ion3 is compatible with the docking protocols used by WindowMaker and
24 KDE. It can place docked applications windows either in a corner
25 dock, or in a "system tray" in the status bar.
27 For a corner dock, add:
31 to cfg_ion.lua or cfg_modules.lua and edit cfg_dock.lua to your
32 preferences. The dock window's visibility can be toggled using
35 For a system tray, edit cfg_statusbar.lua to include:
37 mod_statusbar.create {
40 template="... %systray"
43 You can also configure specific windows to appear in the status bar:
47 class = "foo-window-class",
51 -- In cfg_status_bar.lua:
52 mod_statusbar.create {
54 template="... %systray_foo"
57 GNOME unfortunately uses a different dock protocol. However, the
58 docker program can adapt from this to the WindowMaker protocol. So you
59 can include a GNOME system tray in your status bar by including docker
60 in your X session and this in your Ion3 configuration:
68 -- In cfg_statusbar.lua:
69 mod_statusbar.create {
71 template="... %systray_dock"
74 Adding configuration files to the defaults
75 ------------------------------------------
77 Ion3 extension packages may add and remove configuration files to
78 those included by cfg_defaults.lua. The configuration files must be
79 installed under /etc/X11/ion3. Run "install-ion3-cfg cfg_foo" in the
80 postinst script to add the configuration file
81 /etc/X11/ion3/cfg_foo.lua. Run "install-ion3-cfg --remove cfg_foo" in
82 the prerm script to remove it.
84 -- Ben Hutchings <ben@decadent.org.uk>, Thu, 27 Sep 2007 22:27:11 +0100