Changeset 7a90d02 for doc

Timestamp:

2010-04-08T22:16:38Z (14 years ago)

Author:

Wilmer van der Gaast <wilmer@…>

Branches:

master

Children:

cca0692

Parents:

92a9c68

Message:

Document the Twitter module. And fix the default for auto_reconnect while
I'm at it.

File:

• doc/user-guide/commands.xml (modified) (3 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>
@@ -902 +920 @@
         </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>
+        </bitlbee-setting>
+
         <bitlbee-setting name="web_aware" type="string" scope="account">
                 <default>false</default>