summaryrefslogtreecommitdiff
path: root/doc/en/weechat_relay_protocol.en.adoc
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2016-05-16 11:23:16 +0200
committerSébastien Helleu <flashcode@flashtux.org>2016-05-16 11:23:16 +0200
commitfd80196b818a8df1f8173a6a5407cebc39b287f2 (patch)
treede86bec3274dc8cf50815c08bd402daa85b57a1e /doc/en/weechat_relay_protocol.en.adoc
parenta6a221e5e105ff107d8b68ab76f6299b42107088 (diff)
downloadweechat-fd80196b818a8df1f8173a6a5407cebc39b287f2.zip
doc: add escape of commas in command "init" (relay protocol) (issue #730)
Diffstat (limited to 'doc/en/weechat_relay_protocol.en.adoc')
-rw-r--r--doc/en/weechat_relay_protocol.en.adoc7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/en/weechat_relay_protocol.en.adoc b/doc/en/weechat_relay_protocol.en.adoc
index 7db6bbf80..332fc12a9 100644
--- a/doc/en/weechat_relay_protocol.en.adoc
+++ b/doc/en/weechat_relay_protocol.en.adoc
@@ -114,10 +114,12 @@ Arguments:
_relay.network.password_ in WeeChat)
** _compression_: compression type:
*** _zlib_: enable _zlib_ compression for messages sent by _relay_
+ (enabled by default if _relay_ supports _zlib_ compression)
*** _off_: disable compression
[NOTE]
-Compression _zlib_ is enabled by default if _relay_ supports _zlib_ compression.
+With WeeChat ≥ 1.6, commas can be escaped in the value, for example
+`init password=foo\,bar` to send the password "foo,bar".
Examples:
@@ -125,6 +127,9 @@ Examples:
# initialize and use zlib compression by default (if WeeChat supports it)
init password=mypass
+# initialize with commas in the password (WeeChat ≥ 1.6)
+init password=mypass\,with\,commas
+
# initialize and disable compression
init password=mypass,compression=off
----