Changeset 814aa52 for doc/user-guide


Ignore:
Timestamp:
2010-06-03T11:00:45Z (15 years ago)
Author:
Sven Moritz Hallberg <pesco@…>
Branches:
master
Children:
a6b2f13
Parents:
5f8ab6a9 (diff), f4bcc22 (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:

merge in bitlbee 1.2.6

File:
1 edited

Legend:

Unmodified
Added
Removed

  • doc/user-guide/commands.xml

    r5f8ab6a9 r814aa52  
    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>
    … …  
    6363                                </ircexample>
    6464                        </bitlbee-command>
     65                       
     66                        <bitlbee-command name="twitter">
     67                                <syntax>account add twitter &lt;handle&gt; &lt;password&gt;</syntax>
     68
     69                                <description>
     70                                        <para>
     71                                                This module gives you simple access to Twitter. Although it uses the Twitter API, only Twitter itself is supported at the moment.
     72                                        </para>
     73                                       
     74                                        <para>
     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>).
     76                                        </para>
     77                                       
     78                                        <para>
     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                                </description>
     82                        </bitlbee-command>
    6583
    6684                        <bitlbee-command name="yahoo">
    … …  
    550568
    551569        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
    552                 <default>false</default>
     570                <default>true</default>
    553571
    554572                <description>
    … …  
    668686                        </para>
    669687                </description>
    670 
     688        </bitlbee-setting>
     689
     690        <bitlbee-setting name="control_channel" type="string" scope="global">
     691                <default>&amp;bitlbee</default>
     692
     693                <description>
     694                        <para>
     695                                Normally the control channel where you can see all your contacts is called "&amp;bitlbee". If you don't like this name, you can rename it to anything else using the <emphasis>rename</emphasis> command, or by changing this setting.
     696                        </para>
     697                </description>
    671698        </bitlbee-setting>
    672699
    … …  
    706733                        <para>
    707734                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
     735                        </para>
     736                </description>
     737        </bitlbee-setting>
     738
     739        <bitlbee-setting name="display_timestamps" type="boolean" scope="global">
     740                <default>true</default>
     741
     742                <description>
     743                        <para>
     744                                When incoming messages are old (i.e. offline messages and channel backlogs), BitlBee will prepend them with a timestamp. If you find them ugly or useless, you can use this setting to hide them.
    708745                        </para>
    709746                </description>
    … …  
    750787                        </para>
    751788                </description>
    752 
     789        </bitlbee-setting>
     790
     791        <bitlbee-setting name="ignore_auth_requests" type="boolean" scope="account">
     792                <default>true</default>
     793
     794                <description>
     795                        <para>
     796                                Only supported by OSCAR so far, you can use this setting to ignore ICQ authorization requests, which are hardly used for legitimate (i.e. non-spam) reasons anymore.
     797                        </para>
     798                </description>
    753799        </bitlbee-setting>
    754800
    … …  
    759805                        <para>
    760806                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
     807                        </para>
     808                </description>
     809
     810        </bitlbee-setting>
     811
     812        <bitlbee-setting name="local_display_name" type="boolean" scope="account">
     813                <default>false</default>
     814
     815                <description>
     816                        <para>
     817                                Mostly meant to work around a bug in MSN servers (forgetting the display name set by the user), this setting tells BitlBee to store your display name locally and set this name on the MSN servers when connecting.
    761818                        </para>
    762819                </description>
    … …  
    825882        </bitlbee-setting>
    826883
     884        <bitlbee-setting name="mode" type="string" scope="account">
     885                <possible-values>one, many, chat</possible-values>
     886                <default>one</default>
     887
     888                <description>
     889                        <para>
     890                                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.
     891                        </para>
     892                       
     893                        <para>
     894                                If you prefer to have all your Twitter things in a separate channel, you can set this setting to "chat".
     895                        </para>
     896                       
     897                        <para>
     898                                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.
     899                        </para>
     900                </description>
     901        </bitlbee-setting>
     902
    827903        <bitlbee-setting name="nick" type="string" scope="chat">
    828904
    … …  
    10291105                        <para>
    10301106                                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.
     1107                        </para>
     1108                </description>
     1109        </bitlbee-setting>
     1110
     1111        <bitlbee-setting name="switchboard_keepalives" type="boolean" scope="account">
     1112                <default>false</default>
     1113
     1114                <description>
     1115                        <para>
     1116                                Turn on this flag if you have difficulties talking to offline/invisible contacts.
     1117                        </para>
     1118                       
     1119                        <para>
     1120                                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.
     1121                        </para>
     1122                       
     1123                        <para>
     1124                                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.
     1125                        </para>
     1126                </description>
     1127        </bitlbee-setting>
     1128
     1129        <bitlbee-setting name="timezone" type="string" scope="global">
     1130                <default>local</default>
     1131                <possible-values>local, utc, gmt, timezone-spec</possible-values>
     1132
     1133                <description>
     1134                        <para>
     1135                                If message timestamps are available for offline messages or chatroom backlogs, BitlBee will display them as part of the message. By default it will use the local timezone. If you're not in the same timezone as the BitlBee server, you can adjust the timestamps using this setting.
     1136                        </para>
     1137
     1138                        <para>
     1139                                Values local/utc/gmt should be self-explanatory. timezone-spec is a time offset in hours:minutes, for example: -8 for Pacific Standard Time, +2 for Central European Summer Time, +5:30 for Indian Standard Time.
    10311140                        </para>
    10321141                </description>
Note: See TracChangeset for help on using the changeset viewer.