diff options
| author | Sebastien Helleu <flashcode@flashtux.org> | 2013-03-17 16:14:20 +0100 |
|---|---|---|
| committer | Sebastien Helleu <flashcode@flashtux.org> | 2013-03-17 16:14:20 +0100 |
| commit | a9ff529d83ad5e4293095448bd2f18641754be01 (patch) | |
| tree | d84e27914c9b43852d36e70e436e431913d9b70f /doc/en | |
| parent | fa2b1d6bf976a66c30019b920d49dbc9478955cc (diff) | |
| download | weechat-a9ff529d83ad5e4293095448bd2f18641754be01.zip | |
relay: rename compression "gzip" to "zlib" (compression is zlib, not gzip) (thanks to Dominik Honnef)
Diffstat (limited to 'doc/en')
| -rw-r--r-- | doc/en/weechat_relay_protocol.en.txt | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/doc/en/weechat_relay_protocol.en.txt b/doc/en/weechat_relay_protocol.en.txt index 696bdae3b..acc1e3f8d 100644 --- a/doc/en/weechat_relay_protocol.en.txt +++ b/doc/en/weechat_relay_protocol.en.txt @@ -116,16 +116,20 @@ Arguments: ** 'password' (required): password used to authenticate on 'relay' (option 'relay.network.password' in WeeChat) ** 'compression' (optional): compression type: -*** 'gzip': enable gzip compression for messages sent by 'relay' +*** 'zlib': enable zlib compression for messages sent by 'relay' *** 'off': disable compression [NOTE] -Compression 'gzip' is enabled by default if 'relay' supports gzip compression. +Compression 'zlib' is enabled by default if 'relay' supports zlib compression. -Example: +Examples: ---------------------------------------- -init password=mypass,compression=gzip +# initialize and use zlib compression by default (if WeeChat supports it) +init password=mypass + +# initialize and disable compression +init password=mypass,compression=off ---------------------------------------- [[command_hdata]] @@ -473,7 +477,7 @@ Messages are sent as binary data, using following format (with size in bytes): this length) * 'compression' (byte): flag: ** '0x00': following data is not compressed -** '0x01': following data is gzip-compressed +** '0x01': following data is zlib-compressed * 'id' (string): 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 @@ -485,7 +489,7 @@ Compression ~~~~~~~~~~~ If flag 'compression' is equal to 0x01, then *all* data after is compressed -with gzip, and therefore must be uncompressed before being processed. +with zlib, and therefore must be uncompressed before being processed. [[message_identifier]] Identifier |