aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authordequis <dx@dxzone.com.ar>2015-09-13 01:17:14 -0300
committerdequis <dx@dxzone.com.ar>2015-10-30 07:27:20 -0300
commit345577bc90da1d1fffa0df013426eab54fa2b1b2 (patch)
tree2c07626bdaceb7bd5070eebd2c4a89b24d82db0b /doc
parent0db66186f49438ae9c2f73ca85b915e999896309 (diff)
IRC self-message support (messages sent by yourself from other clients)
This adds an OPT_SELFMESSAGE flag that can be passed to imcb_buddy_msg() or imcb_chat_msg() to indicate that the protocol knows that the message being sent is a self message. This needs to be explicit since the old behavior is to silently drop these messages, which also removed server echoes. This commit doesn't break API/ABI, the flags parameters that were added are all internal (between protocols and UI code) On the irc protocol side, the situation isn't very nice, since some clients put these messages in the wrong window. Irssi, hexchat and mirc get this wrong. Irssi 0.8.18 has a fix for it, and the others have scripts to patch it. But meanwhile, there's a "self_messages" global setting that lets users disable this, or get them as normal messages / notices with a "->" prefix, which loosely imitates the workaround used by the ZNC "privmsg_prefix" module.
Diffstat (limited to 'doc')
-rw-r--r--doc/user-guide/commands.xml27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml
index d671f6d0..32c3b24e 100644
--- a/doc/user-guide/commands.xml
+++ b/doc/user-guide/commands.xml
@@ -1403,6 +1403,33 @@
</description>
</bitlbee-setting>
+ <bitlbee-setting name="self_messages" type="string" scope="global">
+ <default>true</default>
+ <possible-values>true, false, prefix, prefix_notice</possible-values>
+
+ <description>
+ <para>
+ Change this setting to customize how (or whether) to show self-messages, which are messages sent by yourself from other locations (for example, mobile clients), for IM protocols that support it.
+ </para>
+
+ <para>
+ When this is set to "true", it will send those messages in the "standard" way, which is a PRIVMSG with source and target fields swapped.
+ </para>
+
+ <para>
+ Since this isn't very well supported by some clients (the messages might appear in the wrong window), you can set it to "prefix" to show them as a normal message prefixed with "-> ", or use "prefix_notice" which is the same thing but with a NOTICE instead.
+ </para>
+
+ <para>
+ You can also set it to "false" to disable these messages completely.
+ </para>
+
+ <para>
+ This setting only applies to private messages. Self messages in groupchats are always shown, since they haven't caused issues in any clients so far.
+ </para>
+ </description>
+ </bitlbee-setting>
+
<bitlbee-setting name="server" type="string" scope="account">
<description>
<para>