doc: add example of WeeChat command to setup the password in a WeeChat IRC relay client (user's guide)

6 files changed, 63 insertions, 6 deletions

diff --git a/doc/de/weechat_user.de.adoc b/doc/de/weechat_user.de.adoc
index 721d31435..3307fffbf 100644
--- a/doc/de/weechat_user.de.adoc
+++ b/doc/de/weechat_user.de.adoc
@@ -3211,8 +3211,9 @@ verbinden.
 Es kann für jeden IRC Server ein Port definiert werden, oder aber ein Port für
 alle Server.
 
+// TRANSLATION MISSING
 Wird ein Port für alle Server genutzt, dann muss der Client den internen Namen
-des zu nutzenden Servers mit dem IRC Befehl "PASS" anfordern:
+des zu nutzenden Servers mit dem IRC Befehl "PASS" anfordern (see example below):
 
 ----
 PASS server:meinPasswort
@@ -3234,6 +3235,15 @@ Nun kann man eine Verbindung zum Port 8000 mit jedem beliebigen IRC Client
 herstellen, indem man das Server Passwort "meinPasswort" nutzt (oder
 "freenode:meinPasswort" sofern kein Server angegeben wurde).
 
+// TRANSLATION MISSING
+For example if you use WeeChat as IRC client of the relay, with a server called
+"relay" and the relay password "secret", you can setup the password with this
+command:
+
+----
+/set irc.server.relay.password "freenode:secret"
+----
+
 [[relay_weechat_protocol]]
 ==== WeeChat Protokoll
 
diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc
index d2282c179..8c12cfa88 100644
--- a/doc/en/weechat_user.en.adoc
+++ b/doc/en/weechat_user.en.adoc
@@ -3139,7 +3139,7 @@ you can connect to WeeChat with any other IRC client (including WeeChat itself).
 You can define one port by IRC server, or one generic port for all servers.
 
 When using one port for all servers, the client must send the internal name of
-server in the IRC "PASS" command, with this format:
+server in the IRC "PASS" command, with this format (see example below):
 
 ----
 PASS server:password
@@ -3160,6 +3160,14 @@ Example: IRC proxy without SSL only for server "freenode":
 Now you can connect on port 8000 with any IRC client using server password
 "mypassword" (or "freenode:mypassword" if no server was specified in the relay).
 
+For example if you use WeeChat as IRC client of the relay, with a server called
+"relay" and the relay password "secret", you can setup the password with this
+command:
+
+----
+/set irc.server.relay.password "freenode:secret"
+----
+
 [[relay_weechat_protocol]]
 ==== WeeChat protocol
 
diff --git a/doc/fr/weechat_user.fr.adoc b/doc/fr/weechat_user.fr.adoc
index 8501270f6..6e3d491da 100644
--- a/doc/fr/weechat_user.fr.adoc
+++ b/doc/fr/weechat_user.fr.adoc
@@ -3242,7 +3242,8 @@ Vous pouvez définir un port par serveur IRC, ou bien un port générique pour t
 les serveurs.
 
 Lors de l'utilisation d'un port pour tous les serveurs, le client doit envoyer
-le nom interne du serveur dans la commande IRC "PASS", avec le format :
+le nom interne du serveur dans la commande IRC "PASS", avec le format
+(voir l'exemple ci-dessous) :
 
 ----
 PASS serveur:motdepasse
@@ -3264,6 +3265,14 @@ Maintenant vous pouvez vous connecter sur le port 8000 avec n'importe quel
 client IRC en utilisant le mot de passe "motdepasse" (ou "freenode:motdepasse"
 si aucun serveur n'a été spécifié dans le relai).
 
+Par exemple si vous utilisez WeeChat comme client IRC du relai, avec un serveur
+"relay" et un mot de passe relay "secret", vous pouvez configurer le mot de passe
+avec cette commande :
+
+----
+/set irc.server.relay.password "freenode:secret"
+----
+
 [[relay_weechat_protocol]]
 ==== Protocole WeeChat
 
diff --git a/doc/it/weechat_user.it.adoc b/doc/it/weechat_user.it.adoc
index 80ad78330..37d471ff4 100644
--- a/doc/it/weechat_user.it.adoc
+++ b/doc/it/weechat_user.it.adoc
@@ -3350,7 +3350,7 @@ you can connect to WeeChat with any other IRC client (including WeeChat itself).
 You can define one port by IRC server, or one generic port for all servers.
 
 When using one port for all servers, the client must send the internal name of
-server in the IRC "PASS" command, with this format:
+server in the IRC "PASS" command, with this format (see example below):
 
 ----
 PASS server:miapass
@@ -3371,6 +3371,14 @@ Example: IRC proxy without SSL only for server "freenode":
 Now you can connect on port 8000 with any IRC client using server password
 "miapass" (or "freenode:miapass" if no server was specified in the relay).
 
+For example if you use WeeChat as IRC client of the relay, with a server called
+"relay" and the relay password "secret", you can setup the password with this
+command:
+
+----
+/set irc.server.relay.password "freenode:secret"
+----
+
 [[relay_weechat_protocol]]
 ==== Protocollo WeeChat
 
diff --git a/doc/ja/weechat_user.ja.adoc b/doc/ja/weechat_user.ja.adoc
index 8e7dfe6b3..eea1fc57d 100644
--- a/doc/ja/weechat_user.ja.adoc
+++ b/doc/ja/weechat_user.ja.adoc
@@ -3138,8 +3138,10 @@ Relay プラグインは IRC プロキシとしても使えます: Relay プラ�
 
 IRC サーバごとに異なるポート、もしくは全てのサーバに対して共通のポートを定義することができます。
 
+// TRANSLATION MISSING
 すべてのサーバに対して共通のポートを定義した場合には、クライアントからサーバの内部名を
-IRC の "PASS" コマンドに含めて送信するようにしてください、以下の書式を使ってください:
+IRC の "PASS" コマンドに含めて送信するようにしてください、以下の書式を使ってください
+(see example below):
 
 ----
 PASS server:mypass
@@ -3160,6 +3162,15 @@ PASS server:mypass
 任意の IRC クライアントからサーバパスワード "mypass" (全てのサーバに対して共通の
 IRC プロキシを設定した場合には "freenode:mypass") で 8000 番ポートに接続出来ます。
 
+// TRANSLATION MISSING
+For example if you use WeeChat as IRC client of the relay, with a server called
+"relay" and the relay password "secret", you can setup the password with this
+command:
+
+----
+/set irc.server.relay.password "freenode:secret"
+----
+
 [[relay_weechat_protocol]]
 ==== WeeChat プロトコル
 
diff --git a/doc/pl/weechat_user.pl.adoc b/doc/pl/weechat_user.pl.adoc
index cef93a60b..b8e8ccb84 100644
--- a/doc/pl/weechat_user.pl.adoc
+++ b/doc/pl/weechat_user.pl.adoc
@@ -3174,8 +3174,10 @@ możesz się połączyć do niego za pomocą dowolnego klienta IRC (w tym WeeCha
 
 Możesz zdefiniować oddzielne porty dla serwerów IRC, lub jeden dla wszystkich.
 
+// TRANSLATION MISSING
 Jeśli używasz jednego portu dla wszystkich serwerów, klient musi wysłać
-wewnętrzną nazwę serwera w komendzie IRC "PASS", zachowując format:
+wewnętrzną nazwę serwera w komendzie IRC "PASS", zachowując format
+(see example below):
 
 ----
 PASS serwer:hasło
@@ -3197,6 +3199,15 @@ Teraz możesz się połączyć na porcie 8000 za pomocą dowolnego klienta IRC
 używając hasła serwera "moje_hasło" (lub "freenode:moje_hasło" jeśli żaden
 serwer nie został podany w przekaźniku).
 
+// TRANSLATION MISSING
+For example if you use WeeChat as IRC client of the relay, with a server called
+"relay" and the relay password "secret", you can setup the password with this
+command:
+
+----
+/set irc.server.relay.password "freenode:secret"
+----
+
 [[relay_weechat_protocol]]
 ==== Protokół WeeChat