documentation updates and addition of xlock action
[wmiirc-lua.git] / doc / bundled-plugins
blob2e95f2e39ad345cd40a1406bb39c044b7d678689
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-3.5/plugins/ and are documented in more detail through comments.
7 browser
8 ========
9   This plugin adds two actions (alt-a):
11     - "browser" - passes argument or clipboard contents to browser.
12     - "google" - passes argument or clipboard contents to browser as a
13       search query.
15   This plugin currently requires that you have xclip utility installed.
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.
23 dstat_load
24 ===========
25   Uses the dstat utility to generate a load ticker.
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.
32   Example:
34     tail -f /var/log/messages | xargs -n1 wmiir xwrite /event msg
40 vim: set ts=8 et sw=8 tw=72