Mercurial > prosody-modules

comparison mod_pubsub_text_interface/README.markdown @ 3410:a0e0ec729aab

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_pubsub_text_interface/README: Normalize Markdown syntax
author Kim Alvefur <zash@zash.se>
date Sat, 22 Dec 2018 18:53:48 +0100
parents 2b888a7aa21c
children c479e39ff547
comparison
equal deleted inserted replaced
3409:1900280e2a90 3410:a0e0ec729aab
1 # Introduction 1 # Introduction
2 2
3 This module lets you manage subscriptions to pubsub nodes via simple 3 This module lets you manage subscriptions to pubsub nodes via simple
4 chat messages. Subscriptions are always added based on bare JID. The 4 chat messages. Subscriptions are always added based on bare JID. The
5 `include_body` flag is enabled so that a plain text body version of events 5 `include_body` flag is enabled so that a plain text body version of
6 can be included, where supported. 6 events can be included, where supported.
7 7
8 # Configuring 8 # Configuring
9 9
10 ```lua 10 ``` {.lua}
11 Component "pubsub.example.com" "pubub" 11 Component "pubsub.example.com" "pubub"
12 modules_enabled = { 12 modules_enabled = {
13 "pubsub_text_interface", 13 "pubsub_text_interface",
14 } 14 }
15 ``` 15 ```
19 The following commands are supported. Simply send a normal chat message 19 The following commands are supported. Simply send a normal chat message
20 to the PubSub component where this module is enabled. When subscribing 20 to the PubSub component where this module is enabled. When subscribing
21 or unsubscribing, be sure to replace `node` with the node you want to 21 or unsubscribing, be sure to replace `node` with the node you want to
22 subscribe to or unsubscribe from. 22 subscribe to or unsubscribe from.
23 23
24 - `help` - a help message, listing these commands 24 - `help` - a help message, listing these commands
25 - `list` - list available nodes 25 - `list` - list available nodes
26 - `subscribe node` - subscribe to a node 26 - `subscribe node` - subscribe to a node
27 - `unsubscribe node` - unsubscribe from a node 27 - `unsubscribe node` - unsubscribe from a node