From befdefd98712c940637b9913f895259e7f1952bb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?louiz=E2=80=99?= Date: Sun, 9 Jul 2017 01:17:18 +0200 Subject: =?UTF-8?q?Document=20the=20biboumi=20and=20IRC-server=20JIDs=20in?= =?UTF-8?q?=20user=E2=80=99s=20roster?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/biboumi.1.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) (limited to 'doc') diff --git a/doc/biboumi.1.rst b/doc/biboumi.1.rst index 91b2f6d..606fe87 100644 --- a/doc/biboumi.1.rst +++ b/doc/biboumi.1.rst @@ -344,6 +344,29 @@ connect you to the IRC server without joining any channel), then send your authentication message to the user ``bot%irc.example.com@biboumi.example.com`` and finally join the room ``#foo%irc.example.com@biboumi.example.com``. +Roster +------ + +You can add some JIDs provided by biboumi into your own roster, to receive +presence from them. Biboumi will always automatically accept your requests. + +Biboumi’s JID +------------- + +By adding the component JID into your roster, the user will receive an available +presence whenever it is started, and an unavailable presence whenever it is being +shutdown. This is useful to quickly view if that biboumi instance is started or +not. + +IRC server JID +-------------- + +These presence will appear online in the user’s roster whenever they are +connected to that IRC server (see *Connect to an IRC server* for more +details). This is useful to keep track of which server an user is connected +to: this is sometimes hard to remember, when they have many clients, or if +they are using persistent channels. + Channel messages ---------------- -- cgit v1.2.3