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

1 files changed, 30 insertions, 0 deletions

diff --git a/doc/fr/weechat_relay_protocol.fr.adoc b/doc/fr/weechat_relay_protocol.fr.adoc
index e3e87b4bb..bb9a04771 100644
--- a/doc/fr/weechat_relay_protocol.fr.adoc
+++ b/doc/fr/weechat_relay_protocol.fr.adoc
@@ -188,6 +188,11 @@ suivantes :
 ** _off_ : les messages ne sont pas compressés
 ** _zlib_ : les messages sont compressés avec https://zlib.net/[zlib ^↗^^]
 ** _zstd_ : les messages sont compressés avec https://facebook.github.io/zstd/[Zstandard ^↗^^]
+* _escape_commands_ :
+** _on_ : toutes les barres obliques inverses sont interprétées dans les messages
+   du client
+** _off_ : les barres obliques inverses ne sont *PAS* interprétées dans les messages
+   du client et sont utilisées telles quelles
 
 [TIP]
 Avec WeeChat ≤ 2.8, la commande _handshake_ n'est pas implémentée, WeeChat ignore
@@ -213,6 +218,28 @@ htb: {
     'totp': 'on',
     'nonce': '85B1EE00695A5B254E14F4885538DF0D',
     'compression': 'off',
+    'escape_commands': 'off',
+}
+----
+
+* Échappement des commandes activé par le client _(WeeChat ≥ 4.0.0)_ :
+
+----
+(handshake) handshake escape_commands=on
+----
+
+Réponse :
+
+[source,python]
+----
+id: 'handshake'
+htb: {
+    'password_hash_algo': 'plain',
+    'password_hash_iterations': '100000',
+    'totp': 'on',
+    'nonce': '85B1EE00695A5B254E14F4885538DF0D',
+    'compression': 'off',
+    'escape_commands': 'on',
 }
 ----
 
@@ -233,6 +260,7 @@ htb: {
     'totp': 'on',
     'nonce': '85B1EE00695A5B254E14F4885538DF0D',
     'compression': 'off',
+    'escape_commands': 'off',
 }
 ----
 
@@ -253,6 +281,7 @@ htb: {
     'totp': 'on',
     'nonce': '85B1EE00695A5B254E14F4885538DF0D',
     'compression': 'off',
+    'escape_commands': 'off',
 }
 ----
 
@@ -282,6 +311,7 @@ htb: {
     'totp': 'on',
     'nonce': '85B1EE00695A5B254E14F4885538DF0D',
     'compression': 'zstd',
+    'escape_commands': 'off',
 }
 ----