diff options
Diffstat (limited to 'doc/en/weechat_relay_protocol.en.adoc')
| -rw-r--r-- | doc/en/weechat_relay_protocol.en.adoc | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/en/weechat_relay_protocol.en.adoc b/doc/en/weechat_relay_protocol.en.adoc index 4ef031b5a..498815638 100644 --- a/doc/en/weechat_relay_protocol.en.adoc +++ b/doc/en/weechat_relay_protocol.en.adoc @@ -177,6 +177,9 @@ 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 ^↗^^] +* _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 @@ -203,6 +206,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', } ---- @@ -223,6 +248,7 @@ htb: { 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', 'compression': 'off', + 'escape_commands': 'off', } ---- @@ -243,6 +269,7 @@ htb: { 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', 'compression': 'off', + 'escape_commands': 'off', } ---- @@ -272,6 +299,7 @@ htb: { 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', 'compression': 'zstd', + 'escape_commands': 'off', } ---- |