doc: add escape of commas in command "init" (relay protocol) (issue #730)

3 files changed, 21 insertions, 4 deletions

diff --git a/doc/en/weechat_relay_protocol.en.adoc b/doc/en/weechat_relay_protocol.en.adoc
index 7db6bbf80..332fc12a9 100644
--- a/doc/en/weechat_relay_protocol.en.adoc
+++ b/doc/en/weechat_relay_protocol.en.adoc
@@ -114,10 +114,12 @@ Arguments:
    _relay.network.password_ in WeeChat)
 ** _compression_: compression type:
 *** _zlib_: enable _zlib_ compression for messages sent by _relay_
+    (enabled by default if _relay_ supports _zlib_ compression)
 *** _off_: disable compression
 
 [NOTE]
-Compression _zlib_ is enabled by default if _relay_ supports _zlib_ compression.
+With WeeChat ≥ 1.6, commas can be escaped in the value, for example
+`init password=foo\,bar` to send the password "foo,bar".
 
 Examples:
 
@@ -125,6 +127,9 @@ Examples:
 # initialize and use zlib compression by default (if WeeChat supports it)
 init password=mypass
 
+# initialize with commas in the password (WeeChat ≥ 1.6)
+init password=mypass\,with\,commas
+
 # initialize and disable compression
 init password=mypass,compression=off
 ----
diff --git a/doc/fr/weechat_relay_protocol.fr.adoc b/doc/fr/weechat_relay_protocol.fr.adoc
index 7ef67d85a..b9d258ea2 100644
--- a/doc/fr/weechat_relay_protocol.fr.adoc
+++ b/doc/fr/weechat_relay_protocol.fr.adoc
@@ -119,11 +119,12 @@ Paramètres :
    _relay.network.password_ dans WeeChat)
 ** _compression_ : type de compression :
 *** _zlib_ : activer la compression _zlib_ pour les messages envoyés par _relay_
+    (activée par défaut si _relay_ supporte la compression _zlib_)
 *** _off_ : désactiver la compression
 
 [NOTE]
-La compression _zlib_ est activée par défaut si _relay_ supporte la compression
-_zlib_.
+Avec WeeChat ≥ 1.6, les virgules peuvent être échappées dans la valeur,
+par exemple `init password=foo\,bar` pour envoyer le mot de passe "foo,bar".
 
 Exemples :
 
@@ -131,6 +132,9 @@ Exemples :
 # initialiser et utiliser la compression zlib par défaut (si WeeChat la supporte)
 init password=mypass
 
+# initialiser avec des virgules dans le mot de passe (WeeChat ≥ 1.6)
+init password=mypass\,avec\,virgules
+
 # initialiser et désactiver la compression
 init password=mypass,compression=off
 ----
diff --git a/doc/ja/weechat_relay_protocol.ja.adoc b/doc/ja/weechat_relay_protocol.ja.adoc
index d6df16934..76f2d0428 100644
--- a/doc/ja/weechat_relay_protocol.ja.adoc
+++ b/doc/ja/weechat_relay_protocol.ja.adoc
@@ -120,18 +120,26 @@ init [<option>=<value>,[<option>=<value>,...]]
 ** _password_: _リレー_ の認証用パスワード (WeeChat の
    _relay.network.password_ オプション)
 ** _compression_: 圧縮タイプ:
+// TRANSLATION MISSING
 *** _zlib_: _リレー_ から受信するメッセージに対して _zlib_ 圧縮を使う
+    (enabled by default if _relay_ supports _zlib_ compression)
 *** _off_: 圧縮を使わない
 
+// TRANSLATION MISSING
 [NOTE]
-_リレー_ が _zlib_ 圧縮をサポートする場合、_zlib_ 圧縮はデフォルトで有効化されます。
+With WeeChat ≥ 1.6, commas can be escaped in the value, for example
+`init password=foo\,bar` to send the password "foo,bar".
 
 例:
 
+// TRANSLATION MISSING
 ----
 # 初期化、デフォルト設定の zlib を使用 (WeeChat がサポートする場合)
 init password=mypass
 
+# initialize with commas in the password (WeeChat ≥ 1.6)
+init password=mypass\,with\,commas
+
 # 初期化、圧縮を使わない
 init password=mypass,compression=off
 ----