summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/en/weechat_relay_protocol.en.adoc28
-rw-r--r--doc/fr/weechat_relay_protocol.fr.adoc30
-rw-r--r--doc/ja/weechat_relay_protocol.ja.adoc29
-rw-r--r--doc/sr/weechat_relay_protocol.sr.adoc29
4 files changed, 116 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',
}
----
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',
}
----
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',
}
----
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',
}
----
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-01 21:36:33 +0000