doc/bundled-plugins

   1 About
   2 ======
   3 wmiirc-lua bundles some plugins with the distribution and this document
   4 briefly describes each.  The plugin files themselves are located in
   5 ~/.wmii-lua/plugins/ and are documented in more detail through comments.
   6
   7 browser
   8 ========
   9   This plugin adds two actions (alt-a):
  10
  11     - "browser" - passes argument or clipboard contents to browser.
  12     - "google" - passes argument or clipboard contents to browser as a
  13       search query.
  14
  15   This plugin currently requires that you have xclip utility installed.
  16
  17 clock
  18 ======
  19   Adds a widget named, 999_clock, which puts it at the right most
  20   location.  Clock is driven by a timer which fires once a second by
  21   default.  Both timer tick and clock format can be set in wmiirc.
  22
  23 loadavg
  24 =======
  25   Reads /proc/loadavg to display load average
  26
  27 messages
  28 =========
  29   Processes 'msg' events and sends them to the middle of the bar.  This
  30   can be used by external tools to generate events for wmii.
  31
  32   Example:
  33
  34     tail -f /var/log/messages | xargs -n1 wmiir xwrite /event msg
  35
  36
  37 battery
  38 =======
  39   Monitor percentage of battery capacity remaining in bar.  Supports warning on
  40   low and critical status, and display of multiple batteries.
  41
  42
  43
  44
  45 vim: set ts=8 et sw=8 tw=72