doc/relay: add option "escape_commands" in handshake response and examples

1 files changed, 29 insertions, 0 deletions

diff --git a/doc/ja/weechat_relay_protocol.ja.adoc b/doc/ja/weechat_relay_protocol.ja.adoc
index b279e2f6d..91710273e 100644
--- a/doc/ja/weechat_relay_protocol.ja.adoc
+++ b/doc/ja/weechat_relay_protocol.ja.adoc
@@ -188,6 +188,10 @@ WeeChat replies with a hashtable containing the following keys and values:
 ** _off_: messages are not compressed
 ** _zlib_: messages are compressed with https://zlib.net/[zlib ^↗^^]
 ** _zstd_: messages are compressed with https://facebook.github.io/zstd/[Zstandard ^↗^^]
+// TRANSLATION MISSING
+* _escape_commands_:
+** _on_: all backslashes are interpreted in the client messages
+** _off_: backslashes are *NOT* interpreted in the client messages and used as-is
 
 [TIP]
 With WeeChat ≤ 2.8, the command _handshake_ is not implemented, WeeChat silently
@@ -214,6 +218,28 @@ htb: {
     'totp': 'on',
     'nonce': '85B1EE00695A5B254E14F4885538DF0D',
     'compression': 'off',
+    'escape_commands': 'off',
+}
+----
+
+* Escape of commands enabled by the client _(WeeChat ≥ 4.0.0)_:
+
+----
+(handshake) handshake escape_commands=on
+----
+
+Response:
+
+[source,python]
+----
+id: 'handshake'
+htb: {
+    'password_hash_algo': 'plain',
+    'password_hash_iterations': '100000',
+    'totp': 'on',
+    'nonce': '85B1EE00695A5B254E14F4885538DF0D',
+    'compression': 'off',
+    'escape_commands': 'on',
 }
 ----
 
@@ -234,6 +260,7 @@ htb: {
     'totp': 'on',
     'nonce': '85B1EE00695A5B254E14F4885538DF0D',
     'compression': 'off',
+    'escape_commands': 'off',
 }
 ----
 
@@ -254,6 +281,7 @@ htb: {
     'totp': 'on',
     'nonce': '85B1EE00695A5B254E14F4885538DF0D',
     'compression': 'off',
+    'escape_commands': 'off',
 }
 ----
 
@@ -283,6 +311,7 @@ htb: {
     'totp': 'on',
     'nonce': '85B1EE00695A5B254E14F4885538DF0D',
     'compression': 'zstd',
+    'escape_commands': 'off',
 }
 ----