Changeset e88fbe27 for doc


Ignore:
Timestamp:
2010-04-15T23:10:10Z (14 years ago)
Author:
Wilmer van der Gaast <wilmer@…>
Branches:
master
Children:
55b1e69
Parents:
f9ed311
Message:

Added a meta-contact twitter_$username and replaced the "use_groupchat"
setting with a "mode" setting which also allows for a mode where everything
just comes from the meta-contact. Tweets should now go to that user or to
the channel (if available). Messages to others become DMs.

File:
1 edited

Legend:

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

    rf9ed311 re88fbe27  
    2121                        <description>
    2222                                <para>
    23                                         Adds an account on the given server with the specified protocol, username and password to the account list. Supported protocols right now are: Jabber, MSN, OSCAR (AIM/ICQ) and Yahoo. For more information about adding an account, see <emphasis>help account add &lt;protocol&gt;</emphasis>.
     23                                        Adds an account on the given server with the specified protocol, username and password to the account list. Supported protocols right now are: Jabber, MSN, OSCAR (AIM/ICQ), Yahoo and Twitter. For more information about adding an account, see <emphasis>help account add &lt;protocol&gt;</emphasis>.
    2424                                </para>
    2525                        </description>
     
    7373                                       
    7474                                        <para>
    75                                                 By default all your Twitter contacts will show up in your contact list and their tweets will show up as private messages or in &amp;bitlbee depending on your settings. If you want them in a separate channel, use the use_groupchat setting (see <emphasis>help set use_groupchat</emphasis>).
     75                                                By default all your Twitter contacts will come from a contact called twitter_(yourusername). You can change this behaviour using the <emphasis>mode</emphasis> setting (see <emphasis>help set mode</emphasis>).
    7676                                        </para>
    7777                                       
    7878                                        <para>
    79                                                 To send tweets yourself, send them to any of your Twitter contacts via /query (doesn't matter who), or just write in the groupchat channel if you enabled that option.
     79                                                To send tweets yourself, send them to the twitter_(yourusername) contact, or just write in the groupchat channel if you enabled that option.
    8080                                        </para>
    8181                                </description>
     
    659659        </bitlbee-setting>
    660660
     661        <bitlbee-setting name="mode" type="string" scope="account">
     662                <possible-values>one, many, chat</possible-values>
     663                <default>one</default>
     664
     665                <description>
     666                        <para>
     667                                By default, everything from the Twitter module will come from one nick, twitter_(yourusername). If you prefer to have individual nicks for everyone, you can set this setting to "many" instead.
     668                        </para>
     669                       
     670                        <para>
     671                                If you prefer to have all your Twitter things in a separate channel, you can set this setting to "chat".
     672                        </para>
     673                       
     674                        <para>
     675                                In the last two modes, you can send direct messages by /msg'ing your contacts directly. Note, however, that incoming DMs are not fetched yet.
     676                        </para>
     677                </description>
     678
     679        </bitlbee-setting>
     680
    661681        <bitlbee-setting name="nick" type="string" scope="chat">
    662682
     
    916936                        <para>
    917937                                Sends you a /notice when a user starts typing a message (if supported by the IM protocol and the user's client). To use this, you most likely want to use a script in your IRC client to show this information in a more sensible way.
    918                         </para>
    919                 </description>
    920         </bitlbee-setting>
    921 
    922         <bitlbee-setting name="use_groupchat" type="boolean" scope="account">
    923                 <default>false</default>
    924 
    925                 <description>
    926                         <para>
    927                                 By default the Twitter module shows all Twitter contacts and their Tweet in &amp;bitlbee and/or private messages. With this setting enabled the module will show all contacts and their Tweets in a separate channel.
    928938                        </para>
    929939                </description>
Note: See TracChangeset for help on using the changeset viewer.