summaryrefslogtreecommitdiff
path: root/doc/en
diff options
context:
space:
mode:
authorSebastien Helleu <flashcode@flashtux.org>2010-02-15 11:51:44 +0100
committerSebastien Helleu <flashcode@flashtux.org>2010-02-15 11:51:44 +0100
commit341551f2f2db91ee8c017e1dc65adb6dd0b188aa (patch)
treee066ba259fe7fade21468dd2f480fc6723ad13b9 /doc/en
parent34272b7e4dbc6bf826b50c5e83fea255fc3bea8a (diff)
downloadweechat-341551f2f2db91ee8c017e1dc65adb6dd0b188aa.zip
Add SASL authentication in IRC plugin (task #8829), add function "string_encode_base64" in plugin API, fix bug with base64 encoding
New options for IRC servers: - sasl_mechanism (only "plain" for now) - sasl_username - sasl_password
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/autogen/user/irc_options.txt15
-rw-r--r--doc/en/weechat_plugin_api.en.txt27
2 files changed, 42 insertions, 0 deletions
diff --git a/doc/en/autogen/user/irc_options.txt b/doc/en/autogen/user/irc_options.txt
index 5dcfdcc7f..2b578c097 100644
--- a/doc/en/autogen/user/irc_options.txt
+++ b/doc/en/autogen/user/irc_options.txt
@@ -308,6 +308,21 @@
** type: string
** values: any string (default value: "")
+* *irc.server_default.sasl_mechanism*
+** description: mechanism for SASL authentication
+** type: integer
+** values: plain (default value: plain)
+
+* *irc.server_default.sasl_password*
+** description: password for SASL authentication
+** type: string
+** values: any string (default value: "")
+
+* *irc.server_default.sasl_username*
+** description: username for SASL authentication
+** type: string
+** values: any string (default value: "")
+
* *irc.server_default.ssl*
** description: use SSL for server communication
** type: boolean
diff --git a/doc/en/weechat_plugin_api.en.txt b/doc/en/weechat_plugin_api.en.txt
index df447f3d8..6c5d3b518 100644
--- a/doc/en/weechat_plugin_api.en.txt
+++ b/doc/en/weechat_plugin_api.en.txt
@@ -1108,6 +1108,33 @@ str = weechat.string_remove_color(string, replacement)
str = weechat.string_remove_color(my_string, "?")
----------------------------------------
+weechat_string_encode_base64
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Encode a string in base64.
+
+Prototype:
+
+[source,C]
+----------------------------------------
+void weechat_string_encode_base64 (const char *from, int length, char *to);
+----------------------------------------
+
+Arguments:
+
+* 'from': string to encode
+* 'length': length of string to encode (for example `strlen(from)`)
+* 'to': pointer to string to store result (must be long enough)
+
+Example:
+
+[source,C]
+----------------------------------------
+char *string = "abcdefgh", result[128];
+weechat_string_encode_base64 (string, strlen (string), result);
+/* result == "YWJjZGVmZ2g=" */
+----------------------------------------
+
[[utf-8]]
UTF-8
~~~~~