view mod_adhoc.wiki @ 112:058ede538839

Clarified documentation, config and dependency on something else for viewing the logs.
author MWild1
date Mon, 01 Feb 2010 17:28:54 +0000
parents 039a141a9c03
children 040360195e00
line wrap: on
line source

#summary XEP-0050: Ad-Hoc Commands
#labels Stage-Beta

= Introduction =

implementation of [http://xmpp.org/extensions/xep-0050.html XEP-0050: Ad-Hoc Commands].



= Details =

Will offer any adhoc command registered via 'module:add_item("adhoc", ....)'.



= Usage =

First copy (or symlink) the directory "adhoc" which contains mod_adhoc to your plugins directory.
Load mod_adhoc and then any module which provides an adhoc command, such as 
mod_adhoc_cmd_ping.

If you want to build your own adhoc command, just register your adhoc command module with 
module:add_item and a descriptor for your command.

E.g.
A descriptor can be created like this:
{{{
local adhoc_new = module:require "adhoc".new;
local descriptor = adhoc_new("Name", "node", handler);
module:add_item ("adhoc", descriptor)
}}}

For a simple module and details have a look at mod_adhoc_cmd_ping.

= Compatibility =
||trunk||Works||
||0.6||Most commands work||