author | Kim Alvefur <zash@zash.se> |
Fri, 04 Sep 2015 00:23:46 +0200 | |
changeset 1831 | 9376e870f0e1 |
parent 1824 | 8de50be756e5 |
permissions | -rw-r--r-- |
1807 | 1 |
--- |
2 |
labels: |
|
3 |
- 'Stage-Beta' |
|
4 |
summary: Manage rosters through prosodyctl |
|
5 |
... |
|
6 |
||
7 |
Introduction |
|
8 |
------------ |
|
9 |
||
10 |
This module allows you to perform various actions on user rosters via |
|
11 |
prosodyctl. |
|
12 |
||
13 |
Details |
|
14 |
------- |
|
15 |
||
16 |
After putting this module in your modules directory you can use it via |
|
17 |
prosodyctl like this: |
|
18 |
||
1824
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
19 |
prosodyctl mod_roster_command COMMAND [OPTIONS...] |
1807 | 20 |
|
21 |
**Note:** Do not add mod\_roster\_command to your Prosody config file. |
|
22 |
This is unnecessary because it will automatically be loaded by |
|
23 |
prosodyctl when you use it. |
|
24 |
||
25 |
### Commands |
|
26 |
||
1824
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
27 |
subscribe user@host contact@host |
1807 | 28 |
|
29 |
Subscribes the user to the contact's presence. That is, the user will |
|
30 |
see when the contact is online (but the contact won't see the user). |
|
31 |
||
1824
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
32 |
subscribe_both user@host contact@host |
1807 | 33 |
|
34 |
The same as the 'subscribe' command, but performs the subscription in |
|
35 |
both directions, so that both the contact and user will always see each |
|
36 |
other online. |
|
37 |
||
1824
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
38 |
unsubscribe user@host contact@host |
1807 | 39 |
|
40 |
Removes a subscription to the contact's presence. |
|
41 |
||
1824
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
42 |
unsubscribe_both user@host contact@host |
1807 | 43 |
|
44 |
Same as unsubscribe, but also revokes a contact's subscription to the |
|
45 |
user's presence. |
|
46 |
||
1824
8de50be756e5
Various README files: Correct indentation levels, fix syntax and other small fixes
Kim Alvefur <zash@zash.se>
parents:
1807
diff
changeset
|
47 |
rename user@host contact@host [name] [group] |
1807 | 48 |
|
49 |
Sets or updates a name for a contact in the user's roster, and moves the |
|
50 |
contact to the given group, if specified. |
|
51 |
||
52 |
Compatibility |
|
53 |
------------- |
|
54 |
||
55 |
----- ------- |
|
56 |
0.9 Works |
|
57 |
0.8 Works |
|
58 |
----- ------- |