From 7a754d93abf68d536a4f18c8771a374a75fc5b57 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Helleu?= <flashcode@flashtux.org>
Date: Mon, 5 Jun 2023 19:01:46 +0200
Subject: doc/relay: add option "escape_commands" in handshake response and
 examples

---
 doc/sr/weechat_relay_protocol.sr.adoc | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

(limited to 'doc/sr')

diff --git a/doc/sr/weechat_relay_protocol.sr.adoc b/doc/sr/weechat_relay_protocol.sr.adoc
index b76d26949..e8f855c57 100644
--- a/doc/sr/weechat_relay_protocol.sr.adoc
+++ b/doc/sr/weechat_relay_protocol.sr.adoc
@@ -158,6 +158,10 @@ _WeeChat ≥ 2.9, updated in versions 3.5, 4.0.0._
 ** _off_: поруке се не компресују
 ** _zlib_: поруке су компресоване са https://zlib.net/[zlib ^↗^^]
 ** _zstd_: поруке су компресоване са 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]
 У програму WeeChat верзије ≤ 2.8, команда _handshake_ није имплементирана, програм WeeChat једноставно игнорише ову команду, чак и ако се пошаље пре _init_ команде. +
@@ -182,6 +186,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',
 }
 ----
 
@@ -202,6 +228,7 @@ htb: {
     'totp': 'on',
     'nonce': '85B1EE00695A5B254E14F4885538DF0D',
     'compression': 'off',
+    'escape_commands': 'off',
 }
 ----
 
@@ -222,6 +249,7 @@ htb: {
     'totp': 'on',
     'nonce': '85B1EE00695A5B254E14F4885538DF0D',
     'compression': 'off',
+    'escape_commands': 'off',
 }
 ----
 
@@ -248,6 +276,7 @@ htb: {
     'totp': 'on',
     'nonce': '85B1EE00695A5B254E14F4885538DF0D',
     'compression': 'zstd',
+    'escape_commands': 'off',
 }
 ----
 
-- 
cgit v1.2.3