diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/de/weechat_user.de.adoc | 5 | ||||
| -rw-r--r-- | doc/en/weechat_relay_protocol.en.adoc | 45 | ||||
| -rw-r--r-- | doc/en/weechat_user.en.adoc | 3 | ||||
| -rw-r--r-- | doc/fr/weechat_relay_protocol.fr.adoc | 67 | ||||
| -rw-r--r-- | doc/fr/weechat_user.fr.adoc | 3 | ||||
| -rw-r--r-- | doc/it/weechat_user.it.adoc | 6 | ||||
| -rw-r--r-- | doc/ja/weechat_relay_protocol.ja.adoc | 48 | ||||
| -rw-r--r-- | doc/ja/weechat_user.ja.adoc | 5 | ||||
| -rw-r--r-- | doc/pl/weechat_user.pl.adoc | 5 | ||||
| -rw-r--r-- | doc/sr/weechat_relay_protocol.sr.adoc | 44 | ||||
| -rw-r--r-- | doc/sr/weechat_user.sr.adoc | 5 |
11 files changed, 137 insertions, 99 deletions
diff --git a/doc/de/weechat_user.de.adoc b/doc/de/weechat_user.de.adoc index 0747034af..27d92319c 100644 --- a/doc/de/weechat_user.de.adoc +++ b/doc/de/weechat_user.de.adoc @@ -107,9 +107,12 @@ WeeChat *erforderlich* sind: | pkg-config | | entdeckt installierte Bibliotheken. | libncursesw5-dev ^(2)^ | | Ncurses Oberfläche. | libcurl4-gnutls-dev | | URL Transfer. -| zlib1g-dev | | Kompression für Pakete, die mittels Relay- (WeeChat Protokoll), Script-Erweiterung übertragen werden. | libgcrypt20-dev | | Geschützte Daten, IRC SASL Authentifikation. | libgnutls28-dev | ≥ 2.2.0 ^(3)^ | SSL Verbindung zu einem IRC Server, Unterstützung von SSL in der Relay-Erweiterung, IRC SASL Authentifikation (ECDSA-NIST256P-CHALLENGE). +// TRANSLATION MISSING +| zlib1g-dev | | Compression of messages (WeeChat -> client) with https://zlib.net/[zlib] in relay plugin (weechat protocol), Script-Erweiterung übertragen werden. +// TRANSLATION MISSING +| libzstd-dev | | Compression of messages (WeeChat -> client) with https://facebook.github.io/zstd/[Zstandard] in relay plugin (weechat protocol). |=== [NOTE] diff --git a/doc/en/weechat_relay_protocol.en.adoc b/doc/en/weechat_relay_protocol.en.adoc index 33ac9f14c..683a72c39 100644 --- a/doc/en/weechat_relay_protocol.en.adoc +++ b/doc/en/weechat_relay_protocol.en.adoc @@ -103,7 +103,7 @@ List of available commands (detail in next chapters): [[command_handshake]] === handshake -_WeeChat ≥ 2.9._ +_WeeChat ≥ 2.9, updated in version 3.5._ Perform an handshake between the client and WeeChat: this is required in most cases to know the session settings and prepare the authentication with the @@ -127,10 +127,15 @@ Arguments: *** _sha512_: password salted and hashed with SHA512 algorithm *** _pbkdf2+sha256_: password salted and hashed with PBKDF2 algorithm (using SHA256 hash) *** _pbkdf2+sha512_: password salted and hashed with PBKDF2 algorithm (using SHA512 hash) -** _compression_: compression type: -*** _zlib_: enable _zlib_ compression for messages sent by _relay_ - (enabled by default if _relay_ supports _zlib_ compression) -*** _off_: disable compression +** _compression_: list of supported compression types supported by the client + (separated by colons and sorted from most important to the fallback value); + if compression is enabled, messages from _relay_ to client are compressed + to save bandwidth; allowed values are: +*** _off_: no compression (default if option is not given) +*** _zlib_: compress with https://zlib.net/[zlib] _(WeeChat ≥ 0.3.7)_ +*** _zstd_: compress with https://facebook.github.io/zstd/[Zstandard]: better + compression and much faster than _zlib_ for both compression and decompression + _(WeeChat ≥ 3.5)_ Notes about option _password_hash_algo_: @@ -169,8 +174,9 @@ WeeChat replies with a hashtable containing the following keys and values: and the user password (the _relay_ nonce + the client nonce is the salt used in the password hash algorithm) * _compression_: compression type: -** _zlib_: messages are compressed with _zlib_ ** _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] [TIP] With WeeChat ≤ 2.8, the command _handshake_ is not implemented, WeeChat silently @@ -196,7 +202,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'zlib', + 'compression': 'off', } ---- @@ -216,7 +222,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'zlib', + 'compression': 'off', } ---- @@ -236,7 +242,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'zlib', + 'compression': 'off', } ---- @@ -248,10 +254,11 @@ the password is "test" in this example: init password_hash=pbkdf2+sha256:85b1ee00695a5b254e14f4885538df0da4b73207f5aae4:100000:ba7facc3edb89cd06ae810e29ced85980ff36de2bb596fcf513aaab626876440 ---- -* Only "sha256" and "sha512" are supported by the client, disable compression: +* Only "sha256" and "sha512" are supported by the client, enable zstd (preferred) +or zlib compression: ---- -(handshake) handshake password_hash_algo=sha256:sha512,compression=off +(handshake) handshake password_hash_algo=sha256:sha512,compression=zstd:zlib ---- Response: @@ -264,7 +271,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'off', + 'compression': 'zstd', } ---- @@ -298,12 +305,6 @@ Arguments: factor, in addition to the password (option _relay.network.totp_secret_ in WeeChat) _(WeeChat ≥ 2.4)_ -** _compression_: compression type (*deprecated* since version 2.9, it is kept - for compatibility reasons but should be sent in the - <<command_handshake,handshake command>>): -*** _zlib_: enable _zlib_ compression for messages sent by _relay_ - (enabled by default if _relay_ supports _zlib_ compression) -*** _off_: disable compression [NOTE] With WeeChat ≥ 1.6, commas can be escaped in the value, for example @@ -1379,7 +1380,8 @@ Messages are sent as binary data, using following format (with size in bytes): (including this field) * _compression_ (byte): flag: ** _0x00_: following data is not compressed -** _0x01_: following data is compressed with _zlib_ +** _0x01_: following data is compressed with https://zlib.net/[zlib] +** _0x02_: following data is compressed with https://facebook.github.io/zstd/[Zstandard] * _id_ (string, 4 bytes + content): identifier sent by client (before command name); it can be empty (string with zero length and no content) if no identifier was given in command @@ -1389,8 +1391,9 @@ Messages are sent as binary data, using following format (with size in bytes): [[message_compression]] === Compression -If flag _compression_ is equal to 0x01, then *all* data after is compressed -with _zlib_, and therefore must be uncompressed before being processed. +If flag _compression_ is equal to 0x01 or 0x02, then *all* data after is compressed +with https://zlib.net/[zlib] or https://facebook.github.io/zstd/[Zstandard], +and therefore must be uncompressed before being processed. [[message_identifier]] === Identifier diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc index d7d3b6fbf..98bb045d1 100644 --- a/doc/en/weechat_user.en.adoc +++ b/doc/en/weechat_user.en.adoc @@ -101,9 +101,10 @@ WeeChat: | pkg-config | | Detect installed libraries. | libncursesw5-dev ^(2)^ | | Ncurses interface. | libcurl4-gnutls-dev | | URL transfer. -| zlib1g-dev | | Compression of packets in relay plugin (weechat protocol), script plugin. | libgcrypt20-dev | | Secured data, IRC SASL authentication. | libgnutls28-dev | ≥ 2.2.0 ^(3)^ | SSL connection to IRC server, support of SSL in relay plugin, IRC SASL authentication (ECDSA-NIST256P-CHALLENGE). +| zlib1g-dev | | Compression of messages (WeeChat -> client) with https://zlib.net/[zlib] in relay plugin (weechat protocol), script plugin. +| libzstd-dev | | Compression of messages (WeeChat -> client) with https://facebook.github.io/zstd/[Zstandard] in relay plugin (weechat protocol). |=== [NOTE] diff --git a/doc/fr/weechat_relay_protocol.fr.adoc b/doc/fr/weechat_relay_protocol.fr.adoc index bcca20f81..51a5b7e13 100644 --- a/doc/fr/weechat_relay_protocol.fr.adoc +++ b/doc/fr/weechat_relay_protocol.fr.adoc @@ -24,7 +24,7 @@ Les termes suivants sont utilisés dans ce document : * _relay_ : il s'agit de l'extension "relay" de WeeChat, qui agit comme un "serveur" et autorise les _clients_ à se connecter * _client_ : il s'agit d'un autre logiciel, connecté au _relay_ via une - connexion réseau; dans la plupart des cas, ce _client_ est une interface + connexion réseau ; dans la plupart des cas, ce _client_ est une interface distante. [[network_diagram]] @@ -79,7 +79,7 @@ Les commandes ont le format : Les champs sont : * _id_ : identifiant du message (facultatif) qui sera envoyée dans la réponse de - _relay_; elle doit être entre parenthèses, et ne doit pas commencer par un + _relay_ ; elle doit être entre parenthèses, et ne doit pas commencer par un underscore (les identifiants commençant par un underscore sont réservés pour les messages _évènements_ de WeeChat) * _commande_ : une commande (voir le tableau ci-dessous) @@ -107,7 +107,7 @@ Liste des commandes disponibles (détail dans les chapitres suivants) : [[command_handshake]] === handshake -_WeeChat ≥ 2.9._ +_WeeChat ≥ 2.9, mis à jour dans la version 3.5._ Effectuer une poignée de main entre le client et WeeChat : cela est obligatoire dans la plupart des cas pour connaître les paramètres de la session et préparer @@ -133,10 +133,16 @@ Paramètres : (avec un hachage SHA256) *** _pbkdf2+sha512_ : mot de passe salé et haché avec l'algorithme PBKDF2 (avec un hachage SHA512) -** _compression_ : type de compression : -*** _zlib_ : activer la compression _zlib_ pour les messages envoyés par _relay_ - (activée par défaut si _relay_ supporte la compression _zlib_) -*** _off_ : désactiver la compression +** _compression_ : liste des types de compression supportées par le client + (séparées par des deux-points et triées de la plus importante à la valeur + par défaut) ; si la compression est activée, les messages de _relay_ vers + le client sont compressés pour économiser de la bande passante ; + les valeurs autorisées sont : +*** _off_ : pas de compression (par défaut si l'option n'est pas donnée) +*** _zlib_ : compresser avec https://zlib.net/[zlib] _(WeeChat ≥ 0.3.7)_ +*** _zstd_ : compresser avec https://facebook.github.io/zstd/[Zstandard] : + meilleure compression et bien plus rapide que _zlib_ pour la compression et + la décompression _(WeeChat ≥ 3.5)_ Notes à propos de l'option _password_hash_algo_ : @@ -178,8 +184,9 @@ suivantes : _relay_ + le nonce client constituent le sel utilisé dans l'algorithme de hachage du mot de passe) * _compression_ : type de compression : -** _zlib_ : les messages sont compressés avec _zlib_ ** _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] [TIP] Avec WeeChat ≤ 2.8, la commande _handshake_ n'est pas implémentée, WeeChat ignore @@ -204,7 +211,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'zlib', + 'compression': 'off', } ---- @@ -224,7 +231,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'zlib', + 'compression': 'off', } ---- @@ -244,7 +251,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'zlib', + 'compression': 'off', } ---- @@ -256,10 +263,11 @@ le mot de passe est "test" dans cet exemple : init password_hash=pbkdf2+sha256:85b1ee00695a5b254e14f4885538df0da4b73207f5aae4:100000:ba7facc3edb89cd06ae810e29ced85980ff36de2bb596fcf513aaab626876440 ---- -* Seulement "sha256" et "sha512" sont supportés par le client, désactiver la compression : +* Seulement "sha256" et "sha512" sont supportés par le client, activer la +compression zstd (préférée) ou zlib : ---- -(handshake) handshake password_hash_algo=sha256:sha512,compression=off +(handshake) handshake password_hash_algo=sha256:sha512,compression=zstd:zlib ---- Réponse : @@ -272,7 +280,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'off', + 'compression': 'zstd', } ---- @@ -306,12 +314,6 @@ Paramètres : One-Time Password) utilisé comme second facteur d'authentification, en plus du mot de passe (option _relay.network.totp_secret_ dans WeeChat) _(WeeChat ≥ 2.4)_ -** _compression_ : type de compression (*obsolète* depuis la version 2.9, gardé - pour des raisons de compatibilité mais devrait être envoyé dans la - <<command_handshake,commande handshake>>) : -*** _zlib_ : activer la compression _zlib_ pour les messages envoyés par _relay_ - (activée par défaut si _relay_ supporte la compression _zlib_) -*** _off_ : désactiver la compression [NOTE] Avec WeeChat ≥ 1.6, les virgules peuvent être échappées dans la valeur, @@ -1157,16 +1159,16 @@ Syntaxe : Paramètres : * _tampon_ : pointeur (par exemple : "0x1234abcd") ou nom complet du tampon (par exemple : - _core.weechat_ ou _irc.libera.#weechat_); le nom "*" peut être utilisé pour + _core.weechat_ ou _irc.libera.#weechat_) ; le nom "*" peut être utilisé pour spécifier tous les tampons * _options_ : un ou plusieurs mots-clés, séparés par des virgules (par défaut _buffers,upgrade,buffer,nicklist_ pour "*" et _buffer,nicklist_ pour un tampon) : ** _buffers_ : recevoir les signaux à propos des tampons (ouverts/fermés, - déplacés, renommés, mélangés, masqués/démasqués); peut être utilisé seulement + déplacés, renommés, mélangés, masqués/démasqués) ; peut être utilisé seulement avec "*" _(WeeChat ≥ 0.4.1)_ ** _upgrade_ : recevoir les signaux à propos de la mise à jour de WeeChat - (mise à jour, fin de mise à jour); peut être utilisé seulement avec "*" + (mise à jour, fin de mise à jour) ; peut être utilisé seulement avec "*" _(WeeChat ≥ 0.4.1)_ ** _buffer_ : recevoir les signaux à propos du tampon (nouvelles lignes, type changé, titre changé, variable locale ajoutée/supprimée, et les même signaux @@ -1225,11 +1227,11 @@ Syntaxe : Paramètres : * _tampon_ : pointeur (par exemple : "0x1234abcd") ou nom complet du tampon (par exemple : - _core.weechat_ ou _irc.libera.#weechat_); le nom "*" peut être utilisé pour + _core.weechat_ ou _irc.libera.#weechat_) ; le nom "*" peut être utilisé pour spécifier tous les tampons * _options_ : un ou plusieurs mots-clés, séparés par des virgules (le défaut est _buffers,upgrade,buffer,nicklist_ pour "*" et _buffer,nicklist_ pour un - tampon); voir <<command_sync,la commande sync>> pour les valeurs + tampon) ; voir <<command_sync,la commande sync>> pour les valeurs [NOTE] En utilisant le tampon "*", les autres tampons synchronisés (en utilisant un @@ -1399,9 +1401,10 @@ suivant (avec la taille en octets) : (en incluant ce champ) * _compression_ (octet) : drapeau : ** _0x00_ : les données qui suivent ne sont pas compressées -** _0x01_ : les données qui suivent sont compressées avec _zlib_ +** _0x01_ : les données qui suivent sont compressées avec https://zlib.net/[zlib] +** _0x02_ : les données qui suivent sont compressées avec https://facebook.github.io/zstd/[Zstandard] * _id_ (chaîne, 4 octets + contenu) : l'identifiant envoyé par le client - (avant le nom de la commande); il peut être vide (chaîne avec une longueur + (avant le nom de la commande) ; il peut être vide (chaîne avec une longueur de zéro sans contenu) si l'identifiant n'était pas donné dans la commande * _type_ (3 caractères) : un type : 3 lettres (voir le tableau ci-dessous) * _objet_ : un objet (voir tableau ci-dessous) @@ -1409,9 +1412,9 @@ suivant (avec la taille en octets) : [[message_compression]] === Compression -Si le drapeau de _compression_ est égal à 0x01, alors *toutes* les données après -sont compressées avec _zlib_, et par conséquent doivent être décompressées avant -d'être utilisées. +Si le drapeau de _compression_ est égal à 0x01 ou 0x02, alors *toutes* les données +après sont compressées avec https://zlib.net/[zlib] ou https://facebook.github.io/zstd/[Zstandard], +et par conséquent doivent être décompressées avant d'être utilisées. [[message_identifier]] === Identifiant @@ -2473,7 +2476,7 @@ Une chaîne _NULL_ (pointeur NULL en C) a une longueur de -1 : [[object_buffer]] ==== Tampon de données -Même format que l'objet <<object_string,chaîne>>; le contenu est simplement un +Même format que l'objet <<object_string,chaîne>> ; le contenu est simplement un tableau d'octets. [[object_pointer]] @@ -2556,7 +2559,7 @@ objets). .... * _h-path_ (chaîne) : chemin utilise pour atteindre le hdata (exemple : - _buffer/lines/line/line_data_); le dernier élément du chemin est le hdata + _buffer/lines/line/line_data_) ; le dernier élément du chemin est le hdata retourné * _keys_ (chaînes) : chaîne avec une liste de _clé:type_ (séparés par des virgules), exemple : _number:int,name:str_ diff --git a/doc/fr/weechat_user.fr.adoc b/doc/fr/weechat_user.fr.adoc index 48949e51f..dfcbfe7cb 100644 --- a/doc/fr/weechat_user.fr.adoc +++ b/doc/fr/weechat_user.fr.adoc @@ -104,9 +104,10 @@ Le tableau suivant liste les paquets *requis* pour compiler WeeChat : | pkg-config | | Détection des bibliothèques installées. | libncursesw5-dev ^(2)^ | | Interface ncurses. | libcurl4-gnutls-dev | | Transfert d'URL. -| zlib1g-dev | | Compression des paquets dans l'extension relay (protocole weechat), extension script. | libgcrypt20-dev | | Données sécurisées, authentification IRC SASL. | libgnutls28-dev | ≥ 2.2.0 ^(3)^ | Connexion SSL au serveur IRC, support SSL dans l'extension relay, authentification IRC SASL (ECDSA-NIST256P-CHALLENGE). +| zlib1g-dev | | Compression des messages (WeeChat -> client) avec https://zlib.net/[zlib] dans l'extension relay (protocole weechat), extension script. +| libzstd-dev | | Compression des messages (WeeChat -> client) avec https://facebook.github.io/zstd/[Zstandard] dans l'extension relay (protocole weechat). |=== [NOTE] diff --git a/doc/it/weechat_user.it.adoc b/doc/it/weechat_user.it.adoc index c3e1602dc..6c5406d08 100644 --- a/doc/it/weechat_user.it.adoc +++ b/doc/it/weechat_user.it.adoc @@ -122,11 +122,13 @@ WeeChat: | libncursesw5-dev ^(2)^ | | Interfaccia ncurses. | libcurl4-gnutls-dev | | Trasferimento URL. // TRANSLATION MISSING -| zlib1g-dev | | Compression of packets in relay plugin (weechat protocol), script plugin. -// TRANSLATION MISSING | libgcrypt20-dev | | Secured data, IRC SASL authentication. // TRANSLATION MISSING | libgnutls28-dev | ≥ 2.2.0 ^(3)^ | Connessione SSL al server IRC, support of SSL in relay plugin, IRC SASL authentication (ECDSA-NIST256P-CHALLENGE). +// TRANSLATION MISSING +| zlib1g-dev | | Compression of messages (WeeChat -> client) with https://zlib.net/[zlib] in relay plugin (weechat protocol), script plugin. +// TRANSLATION MISSING +| libzstd-dev | | Compression of messages (WeeChat -> client) with https://facebook.github.io/zstd/[Zstandard] in relay plugin (weechat protocol). |=== [NOTE] diff --git a/doc/ja/weechat_relay_protocol.ja.adoc b/doc/ja/weechat_relay_protocol.ja.adoc index e004d5221..ab4833517 100644 --- a/doc/ja/weechat_relay_protocol.ja.adoc +++ b/doc/ja/weechat_relay_protocol.ja.adoc @@ -112,7 +112,7 @@ _リレー_ プラグインは _IRC プロキシ_ のように振舞います ( [[command_handshake]] === handshake -_WeeChat ≥ 2.9._ +_WeeChat ≥ 2.9, updated in version 3.5._ Perform an handshake between the client and WeeChat: this is required in most cases to know the session settings and prepare the authentication with the @@ -136,10 +136,16 @@ Arguments: *** _sha512_: password salted and hashed with SHA512 algorithm *** _pbkdf2+sha256_: password salted and hashed with PBKDF2 algorithm (using SHA256 hash) *** _pbkdf2+sha512_: password salted and hashed with PBKDF2 algorithm (using SHA512 hash) -** _compression_: compression type: -*** _zlib_: enable _zlib_ compression for messages sent by _relay_ - (enabled by default if _relay_ supports _zlib_ compression) -*** _off_: disable compression +// TRANSLATION MISSING +** _compression_: list of supported compression types supported by the client + (separated by colons and sorted from most important to the fallback value); + if compression is enabled, messages from _relay_ to client are compressed + to save bandwidth; allowed values are: +*** _off_: no compression (default if option is not given) +*** _zlib_: compress with https://zlib.net/[zlib] _(WeeChat ≥ 0.3.7)_ +*** _zstd_: compress with https://facebook.github.io/zstd/[Zstandard]: better + compression and much faster than _zlib_ for both compression and decompression + _(WeeChat ≥ 3.5)_ Notes about option _password_hash_algo_: @@ -178,8 +184,9 @@ WeeChat replies with a hashtable containing the following keys and values: and the user password (the _relay_ nonce + the client nonce is the salt used in the password hash algorithm) * _compression_: compression type: -** _zlib_: messages are compressed with _zlib_ ** _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] [TIP] With WeeChat ≤ 2.8, the command _handshake_ is not implemented, WeeChat silently @@ -205,7 +212,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'zlib', + 'compression': 'off', } ---- @@ -225,7 +232,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'zlib', + 'compression': 'off', } ---- @@ -245,7 +252,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'zlib', + 'compression': 'off', } ---- @@ -257,10 +264,11 @@ the password is "test" in this example: init password_hash=pbkdf2+sha256:85b1ee00695a5b254e14f4885538df0da4b73207f5aae4:100000:ba7facc3edb89cd06ae810e29ced85980ff36de2bb596fcf513aaab626876440 ---- -* Only "sha256" and "sha512" are supported by the client, disable compression: +* Only "sha256" and "sha512" are supported by the client, enable zstd (preferred) +or zlib compression: ---- -(handshake) handshake password_hash_algo=sha256:sha512,compression=off +(handshake) handshake password_hash_algo=sha256:sha512,compression=zstd:zlib ---- Response: @@ -273,7 +281,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'off', + 'compression': 'zstd', } ---- @@ -310,13 +318,6 @@ _handshake_), without warning. ** _totp_: パスワードに加えた二要素認証で利用する時間ベースのワンタイムパスワード (TOTP) (WeeChat の _relay.network.totp_secret_ オプション) _(WeeChat バージョン 2.4 で利用可能)_ -// TRANSLATION MISSING -** _compression_: 圧縮タイプ (*deprecated* since version 2.9, it is kept - for compatibility reasons but should be sent in the - <<command_handshake,handshake command>>): -*** _zlib_: _リレー_ から受信するメッセージに対して _zlib_ 圧縮を使う - (_リレー_ が _zlib_ 圧縮をサポートしている場合、デフォルトで有効化されます) -*** _off_: 圧縮を使わない [NOTE] WeeChat バージョン 1.6 以上の場合、コンマをエスケープすることで value にコンマを設定可能です。例えば @@ -1409,7 +1410,8 @@ quit (このフィールドを含む) * _compression_ (バイト型): フラグ: ** _0x00_: これ以降のデータは圧縮されていません -** _0x01_: これ以降のデータは _zlib_ で圧縮されています +** _0x01_: これ以降のデータは https://zlib.net/[zlib] で圧縮されています +** _0x02_: これ以降のデータは https://facebook.github.io/zstd/[Zstandard] で圧縮されています * _id_ (文字列型、4 バイト + 内容): クライアントが送信した識別子 (コマンド名の前につけられる); コマンドに識別子が含まれない場合は空文字列でも可 (内容を含まない長さゼロの文字列) @@ -1419,8 +1421,10 @@ quit [[message_compression]] === 圧縮 -_compression_ フラグが 0x01 の場合、これ以降の *全ての* データは _zlib_ -で圧縮されているため、処理前に必ず展開してください。 +// TRANSLATION MISSING +If flag _compression_ is equal to 0x01 or 0x02, then *all* data after is compressed +with https://zlib.net/[zlib] or https://facebook.github.io/zstd/[Zstandard], +and therefore must be uncompressed before being processed. [[message_identifier]] === 識別子 diff --git a/doc/ja/weechat_user.ja.adoc b/doc/ja/weechat_user.ja.adoc index 61be32a7d..7b33ff049 100644 --- a/doc/ja/weechat_user.ja.adoc +++ b/doc/ja/weechat_user.ja.adoc @@ -108,9 +108,12 @@ WeeChat: | pkg-config | | インストール済みライブラリを検出 | libncursesw5-dev ^(2)^ | | ncurses インターフェース | libcurl4-gnutls-dev | | URL 転送 -| zlib1g-dev | | relay プラグインでパケットを圧縮 (weechat プロトコル)、スクリプトプラグイン | libgcrypt20-dev | | 保護データ、IRC SASL 認証 | libgnutls28-dev | 2.2.0 以上 ^(3)^ | IRC サーバへの SSL 接続、IRC SASL 認証 (ECDSA-NIST256P-CHALLENGE) +// TRANSLATION MISSING +| zlib1g-dev | | Compression of messages (WeeChat -> client) with https://zlib.net/[zlib] in relay plugin (weechat protocol), script plugin. +// TRANSLATION MISSING +| libzstd-dev | | Compression of messages (WeeChat -> client) with https://facebook.github.io/zstd/[Zstandard] in relay plugin (weechat protocol). |=== [NOTE] diff --git a/doc/pl/weechat_user.pl.adoc b/doc/pl/weechat_user.pl.adoc index 4fc43dc08..61ed32766 100644 --- a/doc/pl/weechat_user.pl.adoc +++ b/doc/pl/weechat_user.pl.adoc @@ -107,9 +107,12 @@ WeeChat: | pkg-config | | Wykrywa zainstalowane biblioteki. | libncursesw5-dev ^(2)^ | | Interfejs ncurses. | libcurl4-gnutls-dev | | Transfer URL. -| zlib1g-dev | | Kompresja pakietów we wtyczce relay (protokół weechat), wtyczka script. | libgcrypt20-dev | | Zabezpieczone dane, uwierzytelnianie IRC SASL. | libgnutls28-dev | ≥ 2.2.0 ^(3)^ | Połączenia SSL z serwerami IRC, wsparcie dla SSL we wtyczce relay, uwierzytelnianie IRC SASL (ECDSA-NIST256P-CHALLENGE). +// TRANSLATION MISSING +| zlib1g-dev | | Compression of messages (WeeChat -> client) with https://zlib.net/[zlib] in relay plugin (weechat protocol), script plugin. +// TRANSLATION MISSING +| libzstd-dev | | Compression of messages (WeeChat -> client) with https://facebook.github.io/zstd/[Zstandard] in relay plugin (weechat protocol). |=== [NOTE] diff --git a/doc/sr/weechat_relay_protocol.sr.adoc b/doc/sr/weechat_relay_protocol.sr.adoc index 3f9856460..fbf67e515 100644 --- a/doc/sr/weechat_relay_protocol.sr.adoc +++ b/doc/sr/weechat_relay_protocol.sr.adoc @@ -97,7 +97,8 @@ _клијенти_ су повезани са _релејем_ као што ј [[command_handshake]] === handshake -_WeeChat ≥ 2.9._ +// TRANSLATION MISSING +_WeeChat ≥ 2.9, updated in version 3.5._ Извршава руковање између клијента и програма WeeChat: ово је у већини случајева неопходно како би се сазнале поставке сесије и припремила аутентификација командом _init_. @@ -118,9 +119,16 @@ _WeeChat ≥ 2.9._ *** _sha512_: лозинка засољена и хеширана SHA512 алгоритмом *** _pbkdf2+sha256_: лозинка засољена и хеширана PBKDF2 алгоритмом (користећи SHA256 хеш) *** _pbkdf2+sha512_: лозинка засољена и хеширана PBKDF2 алгоритмом (користећи SHA512 хеш) -** _compression_: тип компресије: -*** _zlib_: укључује _zlib_ компресију порука које шаље _релеј_ (подразумевано је укључено ако _релеј_ подржава _zlib_ компресију) -*** _off_: искључује компресију +// TRANSLATION MISSING +** _compression_: list of supported compression types supported by the client + (separated by colons and sorted from most important to the fallback value); + if compression is enabled, messages from _relay_ to client are compressed + to save bandwidth; allowed values are: +*** _off_: no compression (default if option is not given) +*** _zlib_: compress with https://zlib.net/[zlib] _(WeeChat ≥ 0.3.7)_ +*** _zstd_: compress with https://facebook.github.io/zstd/[Zstandard]: better + compression and much faster than _zlib_ for both compression and decompression + _(WeeChat ≥ 3.5)_ Напомене у вези опције _password_hash_algo_: @@ -147,8 +155,9 @@ _WeeChat ≥ 2.9._ ** _off_: Time-based One-Time Password (TOTP) је искључена и није потребна у _init_ команди * _nonce_: бафер бајтова који не могу да се предвиде, послат као хексадецимална вредност, којом се спречавају replay напади; ако је _password_hash_algo_ хеш алгоритам, клијент мора да израчуна хеш лозинке над овим нонсом, спојено са клијентовим нонсом и корисничком лозинком (_релеј_ нонс + _клијент_ нонс је со која се користи у алгоритму хеширања лозинке) * _compression_: тип компресије: -** _zlib_: поруке су компресоване са _zlib_ ** _off_: поруке се не компресују +** _zlib_: поруке су компресоване са https://zlib.net/[zlib] +** _zstd_: поруке су компресоване са https://facebook.github.io/zstd/[Zstandard] [TIP] У програму WeeChat верзије ≤ 2.8, команда _handshake_ није имплементирана, програм WeeChat једноставно игнорише ову команду, чак и ако се пошаље пре _init_ команде. + @@ -172,7 +181,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'zlib', + 'compression': 'off', } ---- @@ -192,7 +201,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'zlib', + 'compression': 'off', } ---- @@ -212,7 +221,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'zlib', + 'compression': 'off', } ---- @@ -222,10 +231,12 @@ htb: { init password_hash=pbkdf2+sha256:85b1ee00695a5b254e14f4885538df0da4b73207f5aae4:100000:ba7facc3edb89cd06ae810e29ced85980ff36de2bb596fcf513aaab626876440 ---- -* Клијент подржава само „sha256” и „sha512”, компресије се искључује: +// TRANSLATION MISSING +* Клијент подржава само „sha256” и „sha512”, компресије се искључује, +enable zstd (preferred) or zlib compression: ---- -(handshake) handshake password_hash_algo=sha256:sha512,compression=off +(handshake) handshake password_hash_algo=sha256:sha512,compression=zstd:zlib ---- Одговор: @@ -238,7 +249,7 @@ htb: { 'password_hash_iterations': '100000', 'totp': 'on', 'nonce': '85B1EE00695A5B254E14F4885538DF0D', - 'compression': 'off', + 'compression': 'zstd', } ---- @@ -264,9 +275,6 @@ _Ажурирано у верзијама 2.4, 2.8, 2.9._ ** _password_: лозинка која се користи за аутентификацију са _релејем_ (опција _relay.network.password_ у програму WeeChat) ** _password_hash_: хеш лозинке која се користи за аутентификацију са _релејем_ (опција _relay.network.password_ у програму WeeChat), погледајте испод за формат _(WeeChat ≥ 2.8)_ ** _totp_: Time-based One-Time Password (TOTP) која се користи као секундарни фактор аутентификације, уз лозинку (опција _relay.network.totp_secret_ у програму WeeChat) _(WeeChat ≥ 2.4)_ -** _compression_: тип компресије (*превазиђено* почевши од верзије 2.9, остало је из разлога компатибилности, али ви требало да се пошаље у <<command_handshake,handshake команди>>): -*** _zlib_: укључује _zlib_ компресију порука које шаље _релеј_ (подразумевано је укључено ако _релеј_ подржава _zlib_ компресију) -*** _off_: искључује компресију [NOTE] У програму WeeChat верзије ≥ 1.6, у вредности могу да се означе запете, на пример `+init password=foo\,bar+` када желите да пошаљете лозинку „foo,bar”. @@ -1292,7 +1300,8 @@ quit * _дужина_ (неозначени цео број, 4 бајта): број бајтова у целој поруци (заједно са овим пољем) * _компресија_ (бајт): заставица: ** _0x00_: подаци који следе нису компресовани -** _0x01_: подаци који следе су компресовани са _zlib_ +** _0x01_: подаци који следе су компресовани са https://zlib.net/[zlib] +** _0x02_: подаци који следе су компресовани са https://facebook.github.io/zstd/[Zstandard] * _id_ (стринг, 4 бајта + садржај): идентификатор који послао клијент (пре имена команде); може бити и празан (стринг дужине нула и без садржаја) ако у команди није био наведен идентификатор * _тип_ (3 карактера): тип: 3 слова (погледајте табелу испод) * _објект_: објекат (погледајте табелу испод) @@ -1300,7 +1309,10 @@ quit [[message_compression]] === Компресија -Ако је вредност заставице _компресија_ 0x01, онда су *сви* подаци компресовани _zlib_ алгоритмом, тако да пре обраде морају да се декомпресују. +// TRANSLATION MISSING +If flag _compression_ is equal to 0x01 or 0x02, then *all* data after is compressed +with https://zlib.net/[zlib] or https://facebook.github.io/zstd/[Zstandard], +and therefore must be uncompressed before being processed. [[message_identifier]] === Идентификатор diff --git a/doc/sr/weechat_user.sr.adoc b/doc/sr/weechat_user.sr.adoc index 22587e0e6..6b25b5fb5 100644 --- a/doc/sr/weechat_user.sr.adoc +++ b/doc/sr/weechat_user.sr.adoc @@ -93,9 +93,12 @@ WeeChat почетна страница се налази на адреси: htt | pkg-config | | Детекција инсталираних библиотека. | libncursesw5-dev ^(2)^ | | Ncurses интерфејс. | libcurl4-gnutls-dev | | URL пренос. -| zlib1g-dev | | Компресија пакета у релеј додатку (weechat протокол), скрипт додатку. | libgcrypt20-dev | | Обезбеђени подаци, IRC SASL аутентификација. | libgnutls28-dev | ≥ 2.2.0 ^(3)^ | SSL веза са IRC сервером, подршка за SSL у релеј додатку, IRC SASL аутентификација (ECDSA-NIST256P-CHALLENGE). +// TRANSLATION MISSING +| zlib1g-dev | | Compression of messages (WeeChat -> client) with https://zlib.net/[zlib] in relay plugin (weechat protocol), script plugin. +// TRANSLATION MISSING +| libzstd-dev | | Compression of messages (WeeChat -> client) with https://facebook.github.io/zstd/[Zstandard] in relay plugin (weechat protocol). |=== [NOTE] |