1
0
mirror of https://github.com/weechat/weechat.git synced 2026-06-26 04:46:37 +02:00

Add doc about relay plugin in user guide

This commit is contained in:
Sebastien Helleu
2010-12-06 12:00:32 +01:00
parent c1b3c3bd33
commit 2a3d3c95e5
5 changed files with 192 additions and 8 deletions
+2 -2
View File
@@ -1,7 +1,7 @@
WeeChat ChangeLog
=================
Sébastien Helleu <flashcode@flashtux.org>
v0.3.4-dev, 2010-12-01
v0.3.4-dev, 2010-12-06
Version 0.3.4 (under dev!)
@@ -70,7 +70,7 @@ Version 0.3.4 (under dev!)
* irc: add signal "irc_input_send"
* rmodifier: new plugin "rmodifier": alter modifier strings with regular
expressions (bug #26964)
* relay: beta version of IRC proxy
* relay: beta version of IRC proxy, now relay plugin is compiled by default
* scripts: add missing function "infolist_reset_item_cursor" in API (bug #31057)
* python: add info "python2_bin" (path to python 2.x interpreter)
* lua: fix crash when unloading script
+53 -6
View File
@@ -932,6 +932,8 @@ Standarderweiterungen:
| fifo | FIFO Pipe die zur Fernsteuerung von WeeChat genutzt werden kann
| irc | IRC Chat-Protokoll
| logger | erstellt Protokolldateien von Buffern
// TRANSLATION MISSING
| relay | Relay data via network (IRC proxy)
| rmodifier | wandelt Schlüsselwörter mit regulären Ausdrücken
| perl | Perl-Skript API
| python | Python-Skript API
@@ -1566,9 +1568,54 @@ In einer Baumstruktur sieht es dann wie folgt aus:
| #chan2.weechatlog
........................................
// TRANSLATION MISSING
[[relay_plugin]]
Relay Erweiterung
~~~~~~~~~~~~~~~~~
The Relay plugin is used to relay data via network, using different protocols.
Currently, only "irc" protocol is supported (IRC proxy).
[[relay_options]]
Optionen (relay.conf)
^^^^^^^^^^^^^^^^^^^^^
include::autogen/user/relay_options.txt[]
[[relay_commands]]
Befehle
^^^^^^^
include::autogen/user/relay_commands.txt[]
// TRANSLATION MISSING
[[relay_irc_proxy]]
IRC proxy
^^^^^^^^^
The Relay plugin can act as an IRC proxy: you can define one port by IRC server
and use a password for clients.
For example:
----------------------------------------
/set relay.network.password "mypass"
/relay add irc.freenode 8000
----------------------------------------
Now you can connect on port 8000 with any IRC client (WeeChat, xchat,
irssi, ..), using server password "mypass".
You can limit number of allowed clients:
----------------------------------------
/set relay.network.max_clients 1
----------------------------------------
[[rmodifier_plugin]]
Rmodifier plugin
~~~~~~~~~~~~~~~~
Rmodifier Erweiterung
~~~~~~~~~~~~~~~~~~~~~
Mittels der Rmodifer Erweiterung kann man Schlüsselwörter mittels regulären Ausdrücken
wandeln. Ein typischer Anwendungsfall ist das Passwörter bei der Eingabe verborgen werden,
@@ -1577,14 +1624,14 @@ Ein einfaches Anwendungsbeispiel. Es ist möglich jedes einzelne Zeichen eines P
durch das Zeichen "*" zu ersetzen.
[[rmodifier_options]]
Options (rmodifier.conf)
^^^^^^^^^^^^^^^^^^^^^^^^
Optionen (rmodifier.conf)
^^^^^^^^^^^^^^^^^^^^^^^^^
include::autogen/user/rmodifier_options.txt[]
[[rmodifier_commands]]
Commands
^^^^^^^^
Befehle
^^^^^^^
include::autogen/user/rmodifier_commands.txt[]
+44
View File
@@ -932,6 +932,7 @@ Default plugins are:
| fifo | FIFO pipe used to remotely send commands to WeeChat
| irc | IRC chat protocol
| logger | Log buffers to files
| relay | Relay data via network (IRC proxy)
| rmodifier | Alter modifier strings with regular expressions
| perl | Perl scripting API
| python | Python scripting API
@@ -1551,6 +1552,49 @@ You'll have following files:
| #chan2.weechatlog
........................................
[[relay_plugin]]
Relay plugin
~~~~~~~~~~~~
The Relay plugin is used to relay data via network, using different protocols.
Currently, only "irc" protocol is supported (IRC proxy).
[[relay_options]]
Options (relay.conf)
^^^^^^^^^^^^^^^^^^^^
include::autogen/user/relay_options.txt[]
[[relay_commands]]
Commands
^^^^^^^^
include::autogen/user/relay_commands.txt[]
[[relay_irc_proxy]]
IRC proxy
^^^^^^^^^
The Relay plugin can act as an IRC proxy: you can define one port by IRC server
and use a password for clients.
For example:
----------------------------------------
/set relay.network.password "mypass"
/relay add irc.freenode 8000
----------------------------------------
Now you can connect on port 8000 with any IRC client (WeeChat, xchat,
irssi, ..), using server password "mypass".
You can limit number of allowed clients:
----------------------------------------
/set relay.network.max_clients 1
----------------------------------------
[[rmodifier_plugin]]
Rmodifier plugin
~~~~~~~~~~~~~~~~
+46
View File
@@ -955,6 +955,7 @@ Les extensions par défaut sont :
| fifo | Tube FIFO pour envoyer des commandes à distance vers WeeChat
| irc | Discussion avec le protocole IRC
| logger | Enregistrement des tampons dans des fichiers
| relay | Relai de données via le réseau (proxy IRC)
| rmodifier | Modification des chaînes de "modifier" avec des expressions régulières
| perl | Interface (API) pour scripts Perl
| python | Interface (API) pour scripts Python
@@ -1596,6 +1597,51 @@ Vous obtiendrez les fichiers suivants :
| #chan2.weechatlog
........................................
[[relay_plugin]]
Relay plugin
~~~~~~~~~~~~
L'extension Relay est utilisée pour relayer des données via le réseau, en
utilisant divers protocoles.
Actuellement, seul le protocole "irc" est supporté (proxy IRC).
[[relay_options]]
Options (relay.conf)
^^^^^^^^^^^^^^^^^^^^
include::autogen/user/relay_options.txt[]
[[relay_commands]]
Commandes
^^^^^^^^^
include::autogen/user/relay_commands.txt[]
[[relay_irc_proxy]]
IRC proxy
^^^^^^^^^
L'extension Relay peut agir comme un proxy IRC : vous pouvez définir un port
par serveur IRC et utiliser un mot de passe pour les clients.
Par exemple :
----------------------------------------
/set relay.network.password "mypass"
/relay add irc.freenode 8000
----------------------------------------
Maintenant vous pouvez vous connecter sur le port 8000 avec n'importe quel
client IRC (WeeChat, xchat, irssi, etc...), en utilisant le mot de passe
"mypass".
Vous pouvez limiter le nombre de clients autorisés :
----------------------------------------
/set relay.network.max_clients 1
----------------------------------------
[[rmodifier_plugin]]
Extension Rmodifier
~~~~~~~~~~~~~~~~~~~
+47
View File
@@ -949,6 +949,8 @@ I plugin predefiniti sono:
| fifo | pipe FIFO utilizzata per inviare comandi da remoto su WeeChat
| irc | protocollo chat per IRC
| logger | Registra i buffer su file
// TRANSLATION MISSING
| relay | Relay data via network (IRC proxy)
| rmodifier | Cambia le stringhe del modificatore con espressioni regolari
| perl | API per lo scripting in Perl
| python | API per lo scripting in Python
@@ -1587,6 +1589,51 @@ Si avranno i seguenti file:
| #canale2.weechatlog
........................................
// TRANSLATION MISSING
[[relay_plugin]]
Relay plugin
~~~~~~~~~~~~
The Relay plugin is used to relay data via network, using different protocols.
Currently, only "irc" protocol is supported (IRC proxy).
[[relay_options]]
Opzioni (relay.conf)
^^^^^^^^^^^^^^^^^^^^
include::autogen/user/relay_options.txt[]
[[relay_commands]]
Comandi
^^^^^^^
include::autogen/user/relay_commands.txt[]
// TRANSLATION MISSING
[[relay_irc_proxy]]
IRC proxy
^^^^^^^^^
The Relay plugin can act as an IRC proxy: you can define one port by IRC server
and use a password for clients.
For example:
----------------------------------------
/set relay.network.password "mypass"
/relay add irc.freenode 8000
----------------------------------------
Now you can connect on port 8000 with any IRC client (WeeChat, xchat,
irssi, ..), using server password "mypass".
You can limit number of allowed clients:
----------------------------------------
/set relay.network.max_clients 1
----------------------------------------
[[rmodifier_plugin]]
Plugin Rmodifier
~~~~~~~~~~~~~~~~