path: root/doc
diff options
authorFlorent Le Coz <>2014-04-15 05:42:12 +0200
committerFlorent Le Coz <>2014-04-15 05:42:12 +0200
commit996a827a5231464eb4d31d78b56ed4054ab0f4a8 (patch)
treee7e9b85c077045dcfd531d790140b1c70294eb2a /doc
parentfbcce3c1123c144a3b395ee6415465f61a8e0ac1 (diff)
Document the new dummy channel, and how biboumi creates and closes connections
Diffstat (limited to 'doc')
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/ b/doc/
index bd6463d..c985de7 100644
--- a/doc/
+++ b/doc/
@@ -111,6 +111,21 @@ If compiled with Libidn, an IRC user has a bare JID representing the
To join an IRC channel `#foo` on the IRC server ``,
join the XMPP MUC ``.
+### Connect to an IRC server
+The connection to the IRC server is automatically made when the user tries
+to join any channel on that IRC server. The connection is closed whenever
+the last channel on that server is left by the user. To be able to stay
+connected to an IRC server without having to be in a real IRC channel,
+biboumi provides a virtual channel on the jid
+``. For example if you want to join the
+channel `#foo` on the server ``, but you need to authenticate
+to a bot of the server before you can join it, you can first join the room
+`` (this will effectively connect you to
+the IRC server without joining any room), then send your authentication
+message to the user `" and finally
+join the room ``.
### Channel messages
On XMPP, unlike on IRC, the displayed order of the messages is the same for