1
0
mirror of https://github.com/weechat/weechat.git synced 2026-07-10 11:43:13 +02:00

doc: add weechat protocol in relay plugin

This commit is contained in:
Sebastien Helleu
2011-12-27 18:50:31 +01:00
parent 5ee0e798b1
commit e9baa5910c
4 changed files with 89 additions and 8 deletions
+21 -2
View File
@@ -1816,9 +1816,12 @@ You'll have following files:
Relay plugin
~~~~~~~~~~~~
The Relay plugin is used to relay data via network, using different protocols.
The Relay plugin is used to relay data via network, using different protocols:
Currently, only "irc" protocol is supported (IRC proxy).
* 'irc': IRC proxy: used to share connections to IRC servers with one or many
other IRC clients
* 'weechat': protocol used by remote interfaces to display and interact with
WeeChat (for example QWeeChat)
[[relay_options]]
Options (relay.conf)
@@ -1855,6 +1858,22 @@ You can limit number of allowed clients:
/set relay.network.max_clients 1
----------------------------------------
[[relay_weechat_protocol]]
WeeChat protocol
^^^^^^^^^^^^^^^^
The Relay plugin can send data to remote interface using WeeChat protocol.
For example:
----------------------------------------
/set relay.network.password "mypass"
/relay add weechat.* 9000
----------------------------------------
Now you can connect on port 9000 with a remote interface (like QWeeChat),
using password "mypass".
[[rmodifier_plugin]]
Rmodifier plugin
~~~~~~~~~~~~~~~~