aboutsummaryrefslogtreecommitdiffstats
path: root/doc/user-guide
diff options
context:
space:
mode:
authorWilmer van der Gaast <wilmer@gaast.net>2010-04-08 23:16:38 +0100
committerWilmer van der Gaast <wilmer@gaast.net>2010-04-08 23:16:38 +0100
commit7a90d02eede836f60a119cf516b145c8bf601d3c (patch)
treecc97c24682c19e9a2153c064093c4af1b3c821de /doc/user-guide
parent92a9c686a1d2f5f98bfaed97333c9e856ec70166 (diff)
Document the Twitter module. And fix the default for auto_reconnect while
I'm at it.
Diffstat (limited to 'doc/user-guide')
-rw-r--r--doc/user-guide/commands.xml30
1 files changed, 29 insertions, 1 deletions
diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml
index df7ee0a9..0664aaab 100644
--- a/doc/user-guide/commands.xml
+++ b/doc/user-guide/commands.xml
@@ -62,6 +62,24 @@
<ircline nick="root">Account successfully added</ircline>
</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">
<syntax>account add yahoo &lt;handle&gt; &lt;password&gt;</syntax>
@@ -400,7 +418,7 @@
</bitlbee-setting>
<bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
- <default>false</default>
+ <default>true</default>
<description>
<para>
@@ -901,6 +919,16 @@
</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>
+ </bitlbee-setting>
+
<bitlbee-setting name="web_aware" type="string" scope="account">
<default>false</default>