diff options
| author | louiz’ <louiz@louiz.org> | 2017-07-09 01:17:18 +0200 |
|---|---|---|
| committer | louiz’ <louiz@louiz.org> | 2017-07-16 00:16:43 +0200 |
| commit | befdefd98712c940637b9913f895259e7f1952bb (patch) | |
| tree | 0ae6cdd2679259d8f72882320fff174cdf7e5466 | |
| parent | a95197509c262e6294930c4a60d2c96487986e13 (diff) | |
| download | biboumi-befdefd98712c940637b9913f895259e7f1952bb.tar.gz biboumi-befdefd98712c940637b9913f895259e7f1952bb.tar.bz2 biboumi-befdefd98712c940637b9913f895259e7f1952bb.tar.xz biboumi-befdefd98712c940637b9913f895259e7f1952bb.zip | |
Document the biboumi and IRC-server JIDs in user’s roster
| -rw-r--r-- | doc/biboumi.1.rst | 23 |
1 files changed, 23 insertions, 0 deletions
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 ---------------- |