Changeset 345577b for doc/user-guide


Ignore:
Timestamp:
2015-10-30T10:27:20Z (9 years ago)
Author:
dequis <dx@…>
Branches:
master
Children:
fb2338d
Parents:
0db6618
git-author:
dequis <dx@…> (13-09-15 04:17:14)
git-committer:
dequis <dx@…> (30-10-15 10:27:20)
Message:

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.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/user-guide/commands.xml

    r0db6618 r345577b  
    14041404        </bitlbee-setting>
    14051405
     1406        <bitlbee-setting name="self_messages" type="string" scope="global">
     1407                <default>true</default>
     1408                <possible-values>true, false, prefix, prefix_notice</possible-values>
     1409
     1410                <description>
     1411                        <para>
     1412                                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.
     1413                        </para>
     1414
     1415                        <para>
     1416                                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.
     1417                        </para>
     1418                       
     1419                        <para>
     1420                                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.
     1421                        </para>
     1422
     1423                        <para>
     1424                                You can also set it to "false" to disable these messages completely.
     1425                        </para>
     1426
     1427                        <para>
     1428                                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.
     1429                        </para>
     1430                </description>
     1431        </bitlbee-setting>
     1432
    14061433        <bitlbee-setting name="server" type="string" scope="account">
    14071434                <description>
Note: See TracChangeset for help on using the changeset viewer.