Changeset 21c87a7 for doc/user-guide

Timestamp:

2010-04-14T09:27:50Z (15 years ago)

Author:

Wilmer van der Gaast <wilmer@…>

Branches:

master

Children:

d33679e

Parents:

81186cab (diff), 156bbd7 (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:

Merging loads of stuff from mainline.

File:

• doc/user-guide/commands.xml (modified) (6 diffs)

doc/user-guide/commands.xml

@@ -63 +63 @@
                                 </ircexample>
                         </bitlbee-command>
+                        
+                        <bitlbee-command name="twitter">
+                                <syntax>account add twitter &lt;handle&gt; &lt;password&gt;</syntax>
+
+                                <description>
+                                        <para>
+                                                This module gives you simple access to Twitter. Although it uses the Twitter API, only Twitter itself is supported at the moment.
+                                        </para>
+                                        
+                                        <para>
+                                                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>).
+                                        </para>
+                                        
+                                        <para>
+                                                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.
+                                        </para>
+                                </description>
+                        </bitlbee-command>
 
                         <bitlbee-command name="yahoo">
@@ -401 +419 @@
 
         <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
-                <default>false</default>
+                <default>true</default>
 
                 <description>
@@ -556 +574 @@
                         <para>
                                 With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
+                        </para>
+                </description>
+        </bitlbee-setting>
+
+        <bitlbee-setting name="display_timestamps" type="boolean" scope="global">
+                <default>true</default>
+
+                <description>
+                        <para>
+                                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.
                         </para>
                 </description>
@@ -609 +637 @@
         </bitlbee-setting>
 
+        <bitlbee-setting name="local_display_name" type="boolean" scope="account">
+                <default>false</default>
+
+                <description>
+                        <para>
+                                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.
+                        </para>
+                </description>
+
+        </bitlbee-setting>
+
         <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
                 <default>false</default>
@@ -828 +867 @@
         </bitlbee-setting>
 
+        <bitlbee-setting name="timezone" type="string" scope="global">
+                <default>local</default>
+                <possible-values>local, utc, gmt, timezone-spec</possible-values>
+
+                <description>
+                        <para>
+                                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.
+                        </para>
+
+                        <para>
+                                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.
+                        </para>
+                </description>
+        </bitlbee-setting>
+
         <bitlbee-setting name="tls" type="boolean" scope="account">
                 <default>try</default>
@@ -862 +916 @@
                         <para>
                                 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.
+                        </para>
+                </description>
+        </bitlbee-setting>
+
+        <bitlbee-setting name="use_groupchat" type="boolean" scope="account">
+                <default>false</default>
+
+                <description>
+                        <para>
+                                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.
                         </para>
                 </description>