debian/particleman.README.Debian

   1 ParticleMan
   2 ===========
   3
   4 This is based on a release candidate for Ion version 3.0 and should be
   5 quite stable.  There have been substantial changes from earlier
   6 development snapshots.
   7
   8 Instructions for using ParticleMan can be found in the manual page
   9 ("man particleman").  Additional documentation is included in the
  10 ion3-doc package: "Configuring and extending Ion3 with Lua" and
  11 "Ion: Notes for the module and patch writer".  There is an FAQ online
  12 at <http://modeemi.fi/~tuomov/ion/faq.html>.
  13
  14 Some scripts extending ParticleMan are available in the ion3-scripts
  15 package, though this is not currently maintained.
  16
  17 There is a module adding Xinerama support in the mod-xinerama-for-ion
  18 package.
  19
  20 Docks and system trays
  21 ----------------------
  22
  23 ParticleMan is compatible with the docking protocols used by
  24 WindowMaker and KDE.  It can place docked applications windows either
  25 in a corner dock, or in a "system tray" in the status bar.
  26
  27 For a corner dock, add:
  28
  29     dopath("mod_dock")
  30
  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
  33 MOD1+D.
  34
  35 For a system tray, edit cfg_statusbar.lua to include:
  36
  37     mod_statusbar.create {
  38        ...
  39        systray=true,
  40        template="... %systray"
  41     }
  42
  43 You can also configure specific windows to appear in the status bar:
  44
  45     -- In cfg_ion.lua:
  46     defwinprop {
  47        class = "foo-window-class",
  48        statusbar = "foo"
  49     }
  50
  51     -- In cfg_status_bar.lua:
  52     mod_statusbar.create {
  53        ...
  54        template="... %systray_foo"
  55     }
  56
  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 ParticleMan configuration:
  61
  62     -- In cfg_ion.lua:
  63     defwinprop {
  64        class = "Docker",
  65        statusbar = "dock"
  66     }
  67
  68     -- In cfg_statusbar.lua:
  69     mod_statusbar.create {
  70        ...
  71        template="... %systray_dock"
  72     }
  73
  74 Adding configuration files to the defaults
  75 ------------------------------------------
  76
  77 Ion3/ParticleMan extension packages may add and remove configuration
  78 files to those included by cfg_defaults.lua.  The configuration files
  79 must be installed under /etc/X11/ion3.  Run "install-ion3-cfg cfg_foo"
  80 in the 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.
  83
  84  -- Ben Hutchings <ben@decadent.org.uk>, Sun, 11 Nov 2007 16:37:15 +0000