aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/AUTHORS29
-rw-r--r--doc/CHANGES39
-rw-r--r--doc/bitlbee.86
-rw-r--r--doc/user-guide/commands.xml45
-rw-r--r--doc/user-guide/help.xml2
-rw-r--r--doc/user-guide/misc.xml10
6 files changed, 107 insertions, 24 deletions
diff --git a/doc/AUTHORS b/doc/AUTHORS
index 6dab1040..24901bee 100644
--- a/doc/AUTHORS
+++ b/doc/AUTHORS
@@ -1,19 +1,32 @@
-Current developers:
+Core team:
Wilmer van der Gaast <wilmer@gaast.net>
Main developer
-Jelmer 'ctrlsoft' Vernooij <jelmer@samba.org>
- Documentation, general hacking, Win32 port
-Maurits Dijkstra <mauritsd@xs4all.nl>
- Daemon dude, plus some other stuff
+Other contributors:
+Miklos Vajna <vmiklos@vmiklos.hu>
+ Skype module
-Retired developer:
+pesco <pesco@khjk.org>
+ OTR support
+
+
+Retired developers:
Sjoerd 'lucumo' Hemminga <sjoerd@hemminga-online.nl>
NickServ, documentation
-The development team wishes to thank Sjoerd for his contributions to the
-Bee.
+Jelmer 'ctrlsoft' Vernooij <jelmer@samba.org>
+ Documentation, general hacking, Win32 port
+
+Maurits Dijkstra <mauritsd@xs4all.nl>
+ Daemon dude, plus some other stuff
+
+Geert Mulders <g.c.w.m.mulders@gmail.com>
+ Initial version of the Twitter module
+
+ulim <a.sporto+bee@gmail.com>
+Marijn Kruisselbrink
+ File transfer support
diff --git a/doc/CHANGES b/doc/CHANGES
index 9375225f..7ead8466 100644
--- a/doc/CHANGES
+++ b/doc/CHANGES
@@ -3,6 +3,45 @@ found in the bzr commit logs, for example you can try:
http://bugs.bitlbee.org/bitlbee/timeline?daysback=90&changeset=on
+Version 3.2:
+- By far the most important change, a thorough update to the Twitter
+ module:
+ * Now using Twitter API 1.1,
+ * which means it's now using JSON instead of XML,
+ * which means access to the streaming API (Twitter only, other Twitter
+ API services don't seem to have it). No more 60-second polls, #twitter
+ looks even more like real IRC now!
+ * Also, the streaming API means nice things like receiving DMs.
+ * show_ids, already enabled by default for a while, now uses hexa-
+ decimal numbers, which means a 256-entry backlog instead of just 100.
+ * Added a mode=strict setting which requires everything to be a command.
+ The "post" command should then be used to post a Tweet.
+- Jabber module bugfix that fixes connection issues with at least Google
+ Talk but reportedly some other servers (OpenFire?) as well.
+- SSL modules improved a little bit. GnuTLS module now supports SNI and
+ session caching. Shouldn't change much, but hopefully reduces latency
+ and bandwidth usage a little bit.
+- A bunch of other fixes/improvements here and there.
+
+Finished 6 Jan 2013
+
+Version 3.0.6:
+- Updated MSN module to speak MSNP18:
+ * Biggest change is that this brings MPOP support (you can sign in to
+ one account from multiple locations).
+ * Restored support for *sending* offline messages.
+ * Some support for federated (i.e. Yahoo!) contacts. (Only messages
+ might work, you won't see them online.)
+- Twitter:
+ * Work-around for stalls that are still happening sometimes.
+ * Added "favourite" command.
+ * "show_ids" enabled by default.
+- Handle see-other-host Jabber messages which should fix support for
+ MSN-XMPP.
+- Misc. fixes and improvements.
+
+Finished 14 Oct 2012
+
Version 3.0.5:
- SSL certificate verification (edit your bitlbee.conf to enable it).
Works only with GnuTLS!
diff --git a/doc/bitlbee.8 b/doc/bitlbee.8
index d01ec39e..b5aa7705 100644
--- a/doc/bitlbee.8
+++ b/doc/bitlbee.8
@@ -12,7 +12,7 @@
.\" along with this program; see the file COPYING. If not, write to
.\" the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
.\"
-.TH bitlbee 8 "07 March 2004"
+.TH bitlbee 8 "19 May 2010"
.SH NAME
BitlBee \- IRC gateway to IM chat networks
.SH SYNOPSIS
@@ -113,7 +113,3 @@ Foundation, Inc., 59 Temple PLace, Suite 330, Boston, MA 02111-1307 USA
.SH AUTHORS
.PP
Wilmer van der Gaast <wilmer@gaast.net>
-.BR
- Jelmer Vernooij <jelmer@vernstok.nl>
-.BR
- Maurits Dijkstra <mauritsd@xs4all.nl>
diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml
index 12bbf4bc..3af469c6 100644
--- a/doc/user-guide/commands.xml
+++ b/doc/user-guide/commands.xml
@@ -68,7 +68,7 @@
</bitlbee-command>
<bitlbee-command name="twitter">
- <syntax>account add twitter &lt;handle&gt; [&lt;password&gt;]</syntax>
+ <syntax>account add twitter &lt;handle&gt;</syntax>
<description>
<para>
@@ -94,11 +94,11 @@
</bitlbee-command>
<bitlbee-command name="identica">
- <syntax>account add identica &lt;handle&gt; [&lt;password&gt;]</syntax>
+ <syntax>account add identica &lt;handle&gt;</syntax>
<description>
<para>
- Same protocol as <emphasis>twitter</emphasis>, but defaults to a <emphasis>base_url</emphasis> pointing at identi.ca, and with OAuth disabled.
+ Same protocol as <emphasis>twitter</emphasis>, but defaults to a <emphasis>base_url</emphasis> pointing at identi.ca. It also works with OAuth (so don't specify your password).
</para>
</description>
</bitlbee-command>
@@ -834,6 +834,7 @@
<bitlbee-setting name="commands" type="boolean" scope="account">
<default>true</default>
+ <possible-values>true, false, strict</possible-values>
<description>
<para>
@@ -847,11 +848,12 @@
<varlistentry><term>report &lt;screenname|#id&gt;</term><listitem><para>Report the given user (or the user who posted the tweet with the given ID) for sending spam. This will also block them.</para></listitem></varlistentry>
<varlistentry><term>follow &lt;screenname&gt;</term><listitem><para>Start following a person</para></listitem></varlistentry>
<varlistentry><term>unfollow &lt;screenname&gt;</term><listitem><para>Stop following a person</para></listitem></varlistentry>
+ <varlistentry><term>favourite &lt;screenname|#id&gt;</term><listitem><para>Favo<emphasis>u</emphasis>rite the given user's most recent tweet, or the given tweet ID.</para></listitem></varlistentry>
<varlistentry><term>post &lt;message&gt;</term><listitem><para>Post a tweet</para></listitem></varlistentry>
</variablelist>
<para>
- Anything that doesn't look like a command will be treated as a tweet. Watch out for typos! :-)
+ Anything that doesn't look like a command will be treated as a tweet. Watch out for typos, or to avoid this behaviour, you can set this setting to <emphasis>strict</emphasis>, which causes the <emphasis>post</emphasis> command to become mandatory for posting a tweet.
</para>
</description>
</bitlbee-setting>
@@ -927,6 +929,10 @@
</para>
<para>
+ With a ! prefix an inverted channel can be created, for example with this setting set to <emphasis>!group</emphasis> you can create a channel with all users <emphasis>not</emphasis> in that group.
+ </para>
+
+ <para>
Note that, when creating a new channel, BitlBee will try to preconfigure the channel for you, based on the channel name. See <emphasis>help channels</emphasis>.
</para>
</description>
@@ -1021,6 +1027,21 @@
</description>
</bitlbee-setting>
+
+ <bitlbee-setting name="stream" type="boolean" scope="account">
+ <default>true</default>
+
+ <description>
+ <para>
+ For Twitter accounts, this setting enables use of the Streaming API. This automatically gives you incoming DMs as well.
+ </para>
+
+ <para>
+ For other Twitter-like services, this setting is not supported.
+ </para>
+ </description>
+
+ </bitlbee-setting>
<bitlbee-setting name="target_url_length" type="integer" scope="account">
<default>20</default>
@@ -1336,7 +1357,7 @@
</bitlbee-setting>
<bitlbee-setting name="show_ids" type="boolean" scope="account">
- <default>false</default>
+ <default>true</default>
<description>
<para>
@@ -1500,15 +1521,15 @@
</bitlbee-setting>
<bitlbee-setting name="tls" type="boolean" scope="account">
- <default>try</default>
+ <default>true</default>
<description>
<para>
- Newer Jabber servers allow clients to convert a plain-text session to a TLS/SSL-encrypted session. Normally (with this setting set to <emphasis>try</emphasis>) BitlBee will do this, if possible.
+ By default (with this setting enabled), BitlBee will require Jabber servers to offer encryption via StartTLS and refuse to connect if they don't.
</para>
<para>
- If you want to force BitlBee to use TLS sessions only (and to give up if that doesn't seem to be possible) you can set this setting to <emphasis>true</emphasis>. Set it to <emphasis>false</emphasis> if you want the session to remain plain-text.
+ If you set this to "try", BitlBee will use StartTLS only if it's offered. With the setting disabled, StartTLS support will be ignored and avoided entirely.
</para>
</description>
</bitlbee-setting>
@@ -1766,11 +1787,15 @@
<bitlbee-command name="group">
<short-description>Contact group management</short-description>
- <syntax>group list</syntax>
+ <syntax>group [ list | info &lt;group&gt; ]</syntax>
<description>
<para>
- Only the <emphasis>group list</emphasis> command is supported at the moment, which shows a list of all groups defined so far.
+ The <emphasis>group list</emphasis> command shows a list of all groups defined so far.
+ </para>
+
+ <para>
+ The <emphasis>group info</emphasis> command shows a list of all members of a the group &lt;group&gt;.
</para>
<para>
diff --git a/doc/user-guide/help.xml b/doc/user-guide/help.xml
index 48ed8a48..e40a04d1 100644
--- a/doc/user-guide/help.xml
+++ b/doc/user-guide/help.xml
@@ -25,7 +25,7 @@ You can read more about them with <emphasis>help &lt;subject&gt;</emphasis>
</para>
<para>
-BitlBee is written by Wilmer van der Gaast together with Jelmer Vernooij, Maurits Dijkstra and others. Bugs can be reported at <ulink link="http://bugs.bitlbee.org/">http://bugs.bitlbee.org/</ulink>.
+Some more help can be found on <ulink link="http://wiki.bitlbee.org/">http://wiki.bitlbee.org/</ulink>. Bugs can be reported at <ulink link="http://bugs.bitlbee.org/">http://bugs.bitlbee.org/</ulink>.
</para>
<para>
diff --git a/doc/user-guide/misc.xml b/doc/user-guide/misc.xml
index 3eb5dd68..ac2734ca 100644
--- a/doc/user-guide/misc.xml
+++ b/doc/user-guide/misc.xml
@@ -385,4 +385,14 @@ by updating your <emphasis>bitlbee.conf</emphasis>.
</para>
</sect1>
+<sect1 id="whatsnew030200">
+<title>New stuff in BitlBee 3.2</title>
+
+<para>
+Upgradeed to Twitter API version 1.1. This is necessary because previous
+versions will stop working from March 2013. At the same time, BitlBee now
+supports the streaming API and incoming direct messages.
+</para>
+</sect1>
+
</chapter>