debian/ion3.README.Debian

   1 Ion3
   2 ====
   3
   4 Ion3 is now considered stable, but there have been substantial changes
   5 from earlier development snapshots.
   6
   7 Instructions for using Ion3 can be found in the manual page ("man
   8 ion3").  Additional documentation is included in the ion3-doc package:
   9 "Configuring and extending Ion3 with Lua" and "Ion: Notes for the
  10 module and patch writer".  There is an FAQ online at
  11 <http://modeemi.fi/~tuomov/ion/faq.html>.
  12
  13 Some scripts extending Ion3 are available in the ion3-scripts package,
  14 though this is not currently maintained.
  15
  16 There is an unofficial module adding Xinerama support in the
  17 mod-xinerama-for-ion package.
  18
  19 Docks and system trays
  20 ----------------------
  21
  22 Ion3 is compatible with the docking protocols used by WindowMaker and
  23 KDE.  It can place docked applications windows either in a corner
  24 dock, or in a "system tray" in the status bar.
  25
  26 For a corner dock, add:
  27
  28     dopath("mod_dock")
  29
  30 to cfg_ion.lua or cfg_modules.lua and edit cfg_dock.lua to your
  31 preferences.  The dock window's visibility can be toggled using
  32 MOD1+D.
  33
  34 For a system tray, edit cfg_statusbar.lua to include:
  35
  36     mod_statusbar.create {
  37        ...
  38        systray=true,
  39        template="... %systray"
  40     }
  41
  42 You can also configure specific windows to appear in the status bar:
  43
  44     -- In cfg_ion.lua:
  45     defwinprop {
  46        class = "foo-window-class",
  47        statusbar = "foo"
  48     }
  49
  50     -- In cfg_status_bar.lua:
  51     mod_statusbar.create {
  52        ...
  53        template="... %systray_foo"
  54     }
  55
  56 GNOME unfortunately uses a different dock protocol. However, the
  57 docker program can adapt from this to the WindowMaker protocol. So you
  58 can include a GNOME system tray in your status bar by including docker
  59 in your X session and this in your Ion3 configuration:
  60
  61     -- In cfg_ion.lua:
  62     defwinprop {
  63        class = "Docker",
  64        statusbar = "dock"
  65     }
  66
  67     -- In cfg_statusbar.lua:
  68     mod_statusbar.create {
  69        ...
  70        template="... %systray_dock"
  71     }
  72
  73 Adding configuration files to the defaults
  74 ------------------------------------------
  75
  76 Ion3 extension packages may add and remove configuration files to
  77 those included by cfg_defaults.lua.  The configuration files must be
  78 installed under /etc/X11/ion3.  Run "install-ion3-cfg cfg_foo" in the
  79 postinst script to add the configuration file
  80 /etc/X11/ion3/cfg_foo.lua.  Run "install-ion3-cfg --remove cfg_foo" in
  81 the prerm script to remove it.
  82
  83 Compatibility with Flash full-screen mode
  84 -----------------------------------------
  85
  86 The official Flash plugin (flashplugin-nonfree) can open full-screen
  87 windows.  Version 9 has a bug in this feature which causes these windows
  88 to close immediately if they are managed by Ion3.  This package includes
  89 a workaround, but it is ugly and is not enabled by default.  If you
  90 need it, add this to cfg_ion.lua:
  91
  92     dopath("cfg_kludge_flash")
  93
  94  -- Ben Hutchings <ben@decadent.org.uk>  Thu, 07 Feb 2008 20:35:27 +0000