From: Ben Hutchings Date: Mon, 6 Aug 2007 23:35:51 +0000 (+0000) Subject: Merged README into ion3.README.Debian and updated that. X-Git-Tag: 20070720-2~3 X-Git-Url: https://git.decadent.org.uk/gitweb/?a=commitdiff_plain;ds=inline;h=bfe963382889292e7294decbb95e9be5c6fac662;hp=-c;p=ion3.git Merged README into ion3.README.Debian and updated that. --- bfe963382889292e7294decbb95e9be5c6fac662 diff --git a/debian/README b/debian/README deleted file mode 100644 index 7476773..0000000 --- a/debian/README +++ /dev/null @@ -1,67 +0,0 @@ -Debug symbols - -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. - -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" - } - -Adding configuration files to the defaults - -Ion3 extension packages may add and remove configuration files to -those included by cfg_defaults.lua. The configuration files must be -installed under /etc/X11/ion3. Run "install-ion3-cfg cfg_foo" in the -postinst script to add the configuration file -/etc/X11/ion3/cfg_foo.lua. Run "install-ion3-cfg --remove cfg_foo" in -the prerm script to remove it. diff --git a/debian/ion3.README.Debian b/debian/ion3.README.Debian index 0e4b90f..cff5fd2 100644 --- a/debian/ion3.README.Debian +++ b/debian/ion3.README.Debian @@ -1,15 +1,90 @@ Ion3 ----- +==== -Instructions for using Ion can be found in the manual page -("man ion3"). There's documentation for the configuration files in the -ion3-doc package. +This is a release candidate for version 3.0 and should be quite +stable. There have been substantial changes from earlier development +snapshots. -Note that this is a development snapshot. Some of the examples, and -some of the documentation, is out of date. Most notably, the binding -configuration syntax has changed. +Instructions for using Ion3 can be found in the manual page ("man +ion3"). Additional documentation is included in the ion3-doc package: +"Configuring and extending Ion3 with Lua" and "Ion: Notes for the +module and patch writer". There is an FAQ online at +. -Ion2 included some nice scripts, which have been moved into a separate package -for Ion3, called ion3-scripts. +Some scripts extending Ion3 are available in the ion3-scripts package, +though this is not currently maintained. - -- Norbert Tretkowski Sat, 6 Aug 2005 20:19:25 +0200 +There is an unofficial module adding Xinerama support in the +mod-xinerama-for-ion package. + +Debug symbols +------------- + +Binaries in this package are unstripped since 20050322-4 at the +upstream author's request. There is no separate -dbg package. + +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" + } + +Adding configuration files to the defaults +------------------------------------------ + +Ion3 extension packages may add and remove configuration files to +those included by cfg_defaults.lua. The configuration files must be +installed under /etc/X11/ion3. Run "install-ion3-cfg cfg_foo" in the +postinst script to add the configuration file +/etc/X11/ion3/cfg_foo.lua. Run "install-ion3-cfg --remove cfg_foo" in +the prerm script to remove it. + + -- Ben Hutchings , Tue, 7 Aug 2007 00:35:02 +0100