# HG changeset patch
# User MWild1
# Date 1318294707 0
# Node ID e661e843f08364362d970ecd23547ff03de50998
# Parent  b5e2876a6320bc43de5a99d3b1741d19018f1163
Created wiki page through web user interface.

diff -r b5e2876a6320 -r e661e843f083 mod_roster_command.wiki
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_roster_command.wiki	Tue Oct 11 00:58:27 2011 +0000
@@ -0,0 +1,49 @@
+#summary Manage rosters through prosodyctl
+#labels Stage-Beta
+
+= Introduction =
+
+This module allows you to perform various actions on user rosters via prosodyctl.
+
+= Details =
+
+After putting this module in your modules directory you can use it via prosodyctl like this:
+
+{{{
+    prosodyctl mod_roster_command COMMAND [OPTIONS...]
+}}}
+
+== Commands ==
+
+{{{
+    subscribe user@host contact@host
+}}}
+
+Subscribes the user to the contact's presence. That is, the user will see when the contact is online (but the contact won't see the user).
+
+{{{
+    subscribe_both user@host contact@host
+}}}
+The same as the 'subscribe' command, but performs the subscription in both directions, so that both the contact and user will always see each other online.
+
+{{{
+    unsubscribe user@host contact@host
+}}}
+
+Removes a subscription to the contact's presence.
+
+{{{
+    unsubscribe_both user@host contact@host
+}}}
+
+Same as unsubscribe, but also revokes a contact's subscription to the user's presence.
+
+{{{
+    rename user@host contact@host [name] [group]
+}}}
+
+Sets or updates a name for a contact in the user's roster, and moves the contact to the given group, if specified.
+
+= Compatibility =
+|| 0.8 || Works ||
+|| 0.7 || Should work ||
\ No newline at end of file