From: Ben Hutchings <ben@decadent.org.uk>
Date: Mon, 9 Jul 2007 00:00:17 +0000 (+0000)
Subject: Reworded explanation of unstripped binaries.
X-Git-Tag: 20070708-1~4
X-Git-Url: https://git.decadent.org.uk/gitweb/?p=ion3.git;a=commitdiff_plain;h=7c392448b0d2efcc6bb959063dcaa8b2c5ea0964

Reworded explanation of unstripped binaries.
Documented docks and system trays more fully, based on my earlier blog entry.
---

diff --git a/debian/README b/debian/README
index 0efd782..8d97835 100644
--- a/debian/README
+++ b/debian/README
@@ -1,11 +1,58 @@
-ion3 (20060326-1) unstable; urgency=low
+Debug symbols
 
-  * Binaries in this package are not stripped since 20050322-4, because of
-	upstreams request. The reason why there's no separate -dbg package is
-	because ion3 is the development branch.
-  * Ion3 has support KDE system tray icons natively, but the implementation
-	is KDE-specific. Unfortunately, this makes non-KDE (GNOME) system tray
-	icons appear broken, when they really aren't. To get a Gaim (and maybe
-	others) system tray icon, use the "docker" package.
+Binaries in this package are unstripped since 20050322-4 at the
+upstream author's request.  There is no separate -dbg package.  Ion3
+is currently a development branch and not considered entirely stable.
 
- -- Norbert Tretkowski <nobse@debian.org>  Sun, 26 Mar 2006 12:21:35 +0200
+Docks and system trays
+
+Ion3 is compatible with the docking protocols used by WindowMaker and
+KDE.  It can place docked applications windows either in a corner
+dock, or in a "system tray" in the status bar.
+
+For a corner dock, add:
+
+    dopath("mod_dock")
+
+to cfg_ion.lua or cfg_modules.lua and edit cfg_dock.lua to your
+preferences.  The dock window's visibility can be toggled using
+MOD1+D.
+
+For a system tray, edit cfg_statusbar.lua to include:
+
+    mod_statusbar.create {
+       ...
+       systray=true,
+       template="... %systray"
+    }
+
+You can also configure specific windows to appear in the status bar:
+
+    -- In cfg_ion.lua:
+    defwinprop {
+       class = "foo-window-class",
+       statusbar = "foo"
+    }
+
+    -- In cfg_status_bar.lua:
+    mod_statusbar.create {
+       ...
+       template="... %systray_foo"
+    }
+
+GNOME unfortunately uses a different dock protocol. However, the
+docker program can adapt from this to the WindowMaker protocol. So you
+can include a GNOME system tray in your status bar by including docker
+in your X session and this in your Ion3 configuration:
+
+    -- In cfg_ion.lua:
+    defwinprop {
+       class = "Docker",
+       statusbar = "dock"
+    }
+
+    -- In cfg_statusbar.lua:
+    mod_statusbar.create {
+       ...
+       template="... %systray_dock"
+    }