Changeset f924563 for doc/user-guide


Ignore:
Timestamp:
2010-05-03T00:52:08Z (15 years ago)
Author:
Wilmer van der Gaast <wilmer@…>
Branches:
master
Children:
1a3ba05
Parents:
6a9d068 (diff), 6824fb3 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.
Message:

Mainline merge.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • doc/user-guide/commands.xml

    r6a9d068 rf924563  
    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.
     80                                        </para>
     81
     82                                        <para>
     83                                                Since Twitter now requires OAuth authentication, you should not enter your Twitter password into BitlBee. Just type a bogus password. The first time you log in, BitlBee will start OAuth authentication. (See <emphasis>help set oauth</emphasis>.)
    8084                                        </para>
    8185                                </description>
    … …  
    659663        </bitlbee-setting>
    660664
     665        <bitlbee-setting name="mode" type="string" scope="account">
     666                <possible-values>one, many, chat</possible-values>
     667                <default>one</default>
     668
     669                <description>
     670                        <para>
     671                                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.
     672                        </para>
     673                       
     674                        <para>
     675                                If you prefer to have all your Twitter things in a separate channel, you can set this setting to "chat".
     676                        </para>
     677                       
     678                        <para>
     679                                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.
     680                        </para>
     681                </description>
     682
     683        </bitlbee-setting>
     684
    661685        <bitlbee-setting name="nick" type="string" scope="chat">
    662686
    … …  
    683707        </bitlbee-setting>
    684708
     709        <bitlbee-setting name="oauth" type="boolean" scope="account">
     710                <default>true</default>
     711
     712                <description>
     713                        <para>
     714                                This enables OAuth authentication for Twitter accounts. From June 2010 this will be mandatory.
     715                        </para>
     716
     717                        <para>
     718                                With OAuth enabled, you shouldn't tell BitlBee your Twitter password. Just add your account with a bogus password and type <emphasis>account on</emphasis>. BitlBee will then give you a URL to authenticate with Twitter. If this succeeds, Twitter will return a PIN code which you can give back to BitlBee to finish the process.
     719                        </para>
     720
     721                        <para>
     722                                The resulting access token will be saved permanently, so you have to do this only once.
     723                        </para>
     724                </description>
     725
     726        </bitlbee-setting>
     727
    685728        <bitlbee-setting name="ops" type="string" scope="global">
    686729                <default>both</default>
    … …  
    818861        </bitlbee-setting>
    819862
     863        <bitlbee-setting name="show_offline" type="boolean" scope="global">
     864                <default>false</default>
     865
     866                <description>
     867                        <para>
     868                                If enabled causes BitlBee to also show offline users in Channel. Online-users will get op, away-users voice and offline users none of both. This option takes effect as soon as you reconnect.
     869                        </para>
     870                </description>
     871        </bitlbee-setting>
     872
    820873        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
    821874                <default>true</default>
    … …  
    863916                        <para>
    864917                                If BitlBee fails to detect this sometimes (most likely in AIM messages over an ICQ connection), you can set this setting to <emphasis>always</emphasis>, but this might sometimes accidentally strip non-HTML things too.
     918                        </para>
     919                </description>
     920        </bitlbee-setting>
     921
     922        <bitlbee-setting name="switchboard_keepalives" type="boolean" scope="account">
     923                <default>false</default>
     924
     925                <description>
     926                        <para>
     927                                Turn on this flag if you have difficulties talking to offline/invisible contacts.
     928                        </para>
     929                       
     930                        <para>
     931                                With this setting enabled, BitlBee will send keepalives to MSN switchboards with offline/invisible contacts every twenty seconds. This should keep the server and client on the other side from shutting it down.
     932                        </para>
     933                       
     934                        <para>
     935                                This is useful because BitlBee doesn't support MSN offline messages yet and the MSN servers won't let the user reopen switchboards to offline users. Once offline messaging is supported, this flag might be removed.
    865936                        </para>
    866937                </description>
    … …  
    916987                        <para>
    917988                                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.
    928989                        </para>
    929990                </description>
Note: See TracChangeset for help on using the changeset viewer.