Changeset fa8f57b for doc/user-guide

Timestamp:

2015-11-21T03:01:05Z (9 years ago)

Author:

dequis <dx@…>

Branches:

master

Children:

2f8e3ca

Parents:

8fdeaa5

git-author:

dequis <dx@…> (21-11-15 02:04:06)

git-committer:

dequis <dx@…> (21-11-15 03:01:05)

Message:

jabber: Implement carbons (XEP-0280)

"Message carbons" (XEP-0280) is a server feature to get copies of
outgoing messages sent from other clients connected to the same account.
It's not widely supported by most public XMPP servers (easier if you
host your own), but this will probably change in the next few years.

This is enabled by default if the server supports it. It can also be
disabled with the "carbons" account setting.

Loosely based on a patch by kormat from trac ticket 1021. (Thanks!)
I moved stuff around, simplified things, fixed a few bugs, and used the
new self-messages feature.

File:

• doc/user-guide/commands.xml (modified) (1 diff)

doc/user-guide/commands.xml

@@ -789 +789 @@
         </bitlbee-setting>
 
+        <bitlbee-setting name="carbons" type="boolean" scope="account">
+                <default>true</default>
+
+                <description>
+                        <para>
+                                Jabber specific. "Message carbons" (XEP-0280) is a server feature to get copies of outgoing messages sent from other clients connected to the same account. It's not widely supported by most public XMPP servers (easier if you host your own), but this will probably change in the next few years.
+                        </para>
+                        <para>
+                                This defaults to true, which will enable it if the server supports it, or fail silently if it's not. This setting only exists to allow disabling the feature if anyone considers it undesirable.
+                        </para>
+                        <para>
+                                See also the <emphasis>self_messages</emphasis> setting.
+                        </para>
+                </description>
+        </bitlbee-setting>
+
         <bitlbee-setting name="charset" type="string" scope="global">
                 <default>utf-8</default>