summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFlorent Le Coz <louiz@louiz.org>2015-05-07 17:01:17 +0200
committerFlorent Le Coz <louiz@louiz.org>2015-05-07 17:01:17 +0200
commit0a6b673b14efc4f623ea445045e6fc60e9842a25 (patch)
tree88fef4dced68ef3c616fe1575d5c542b0474b56a /doc
parente24ed4f70c22142029fa8e6cf5b874e8bc261bc3 (diff)
downloadbiboumi-0a6b673b14efc4f623ea445045e6fc60e9842a25.tar.gz
biboumi-0a6b673b14efc4f623ea445045e6fc60e9842a25.tar.bz2
biboumi-0a6b673b14efc4f623ea445045e6fc60e9842a25.tar.xz
biboumi-0a6b673b14efc4f623ea445045e6fc60e9842a25.zip
Support raw IRC messages
Messages received on an IRC server JID are forwarded as raw IRC messages. fix #2486
Diffstat (limited to 'doc')
-rw-r--r--doc/biboumi.1.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/biboumi.1.md b/doc/biboumi.1.md
index b69dede..faa9618 100644
--- a/doc/biboumi.1.md
+++ b/doc/biboumi.1.md
@@ -357,6 +357,20 @@ Biboumi supports a few ad-hoc commands, as described in the XEP 0050.
“Gateway shutdown” quit message, except that biboumi does not exit when
using this ad-hoc command.
+### Raw IRC messages
+
+Biboumi tries to support as many IRC features as possible, but doesn’t
+handle everything yet (or ever). In order to let the user send any
+arbitrary IRC message, biboumi forwards any XMPP message received on an IRC
+Server JID (see *ADDRESSING*) as a raw command to that IRC server.
+
+For example, to WHOIS the user Foo on the server irc.example.com, a user can
+send the message “WHOIS Foo” to “irc.example.com@biboumi.example.com”.
+
+The message will be forwarded as is, without any modification appart from
+adding "\r\n" at the end (to make it a valid IRC message). You need to have
+a little bit of understanding of the IRC protocol to use this feature.
+
SECURITY
--------