Mercurial > prosody-modules

comparison mod_roster_command/README.markdown @ 1820:8de50be756e5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Various README files: Correct indentation levels, fix syntax and other small fixes
author Kim Alvefur <zash@zash.se>
date Wed, 02 Sep 2015 17:30:33 +0200
parents 4d73a1a6ba68
children
comparison
equal deleted inserted replaced
1819:1b08597b5e6f 1820:8de50be756e5
14 ------- 14 -------
15 15
16 After putting this module in your modules directory you can use it via 16 After putting this module in your modules directory you can use it via
17 prosodyctl like this: 17 prosodyctl like this:
18 18
19 prosodyctl mod_roster_command COMMAND [OPTIONS...] 19 prosodyctl mod_roster_command COMMAND [OPTIONS...]
20 20
21 **Note:** Do not add mod\_roster\_command to your Prosody config file. 21 **Note:** Do not add mod\_roster\_command to your Prosody config file.
22 This is unnecessary because it will automatically be loaded by 22 This is unnecessary because it will automatically be loaded by
23 prosodyctl when you use it. 23 prosodyctl when you use it.
24 24
25 ### Commands 25 ### Commands
26 26
27 subscribe user@host contact@host 27 subscribe user@host contact@host
28 28
29 Subscribes the user to the contact's presence. That is, the user will 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). 30 see when the contact is online (but the contact won't see the user).
31 31
32 subscribe_both user@host contact@host 32 subscribe_both user@host contact@host
33 33
34 The same as the 'subscribe' command, but performs the subscription in 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 35 both directions, so that both the contact and user will always see each
36 other online. 36 other online.
37 37
38 unsubscribe user@host contact@host 38 unsubscribe user@host contact@host
39 39
40 Removes a subscription to the contact's presence. 40 Removes a subscription to the contact's presence.
41 41
42 unsubscribe_both user@host contact@host 42 unsubscribe_both user@host contact@host
43 43
44 Same as unsubscribe, but also revokes a contact's subscription to the 44 Same as unsubscribe, but also revokes a contact's subscription to the
45 user's presence. 45 user's presence.
46 46
47 rename user@host contact@host [name] [group] 47 rename user@host contact@host [name] [group]
48 48
49 Sets or updates a name for a contact in the user's roster, and moves the 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. 50 contact to the given group, if specified.
51 51
52 Compatibility 52 Compatibility