diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CHANGES | 26 | ||||
| -rw-r--r-- | doc/CREDITS | 4 | ||||
| -rw-r--r-- | doc/README | 19 | ||||
| -rw-r--r-- | doc/bitlbee.8 | 4 | ||||
| -rw-r--r-- | doc/user-guide/commands.xml | 74 |
5 files changed, 93 insertions, 34 deletions
diff --git a/doc/CHANGES b/doc/CHANGES index e9435216..3f509c46 100644 --- a/doc/CHANGES +++ b/doc/CHANGES @@ -1,4 +1,7 @@ -Version x.x: +Version 1.1dev: +- First BitlBee development/testing RELEASE. This should be quite stable + though (and for most people more stable than 1.0.x). It just has a couple + of rough edges and needs a bit more testing. - Added ForkDaemon mode next to the existing Daemon- and inetd modes. With ForkDaemon you can run BitlBee as a stand-alone daemon and every connection will run in its own process. No more need to configure inetd, and still you @@ -18,6 +21,7 @@ Version x.x: - Many, many, MANY little changes, improvements, fixes. Using non-blocking I/O as much as possible, fixed lots of little bugs (including bugs that affected daemon mode stability). See the bzr logs for more information. +- Added units tests, will have to add some more before the real release. - Most important change: New file format for user data (accounts, nicks and settings). Migration to the new format should happen transparently, BitlBee will read the old files and once you quit/save it will save in the @@ -40,6 +44,26 @@ Version x.x: lose the nicknames, you can now use "account set" to change the username and password for the existing connection. * Per-account settings (see the new "account set" command). +- A brand new Jabber module. Besides the major code cleanup, it also has + has these new features: + * Pretty complete XMPP support: RFC3920, RFC3921 plus a number of XEPs + including XEP73 and XEP85. (See http://www.xmpp.org/ for what all these + things mean exactly.) Privacy lists are not supported for obvious + reasons. + * This complete support also includes TLS and SASL support and SRV record + lookup. This means that specifying a server tag for connections should + (almost) never be necessary anymore, BitlBee can find the server and can + automatically convert plaintext connections to TLS-encrypted ones. + * XEP85 means typing notifications. The older XEP22 (still used by some + clients including Gaim <2.0) is not supported. + * Better handling of buddies who have more than one resource on-line. As + long as one resource is on-line (and visible), BitlBee will show this. + (The previous module didn't keep track of resources and sent an offline + event as soon as any resource disappears.) + * You can now set your resource priority. + * The info command now gives away state/message information for all + resources available for that buddy. (Of course this only works if the + buddy is in your contact list.) Version 1.0.3: - Fixed ugliness in block/allow list commands (still not perfect though, the diff --git a/doc/CREDITS b/doc/CREDITS index 83a19f51..f805c251 100644 --- a/doc/CREDITS +++ b/doc/CREDITS @@ -49,9 +49,11 @@ The authors thank the following people: - Elizabeth Krumbach, for her help on the docs. - Frank Thieme, for the info-command enhancements and other patches. - Marcus Dennis, for some bitlbeed enhancements. -- 1nfamus, for security auditing BitlBee code. +- infamous41md, for security auditing BitlBee code. - Tijmen Ruizendaal, for some useful BitlBee-related irssi scripts. - Ed Schouten, for reporting bugs. +- Greg (gropeep.org), for updating the Yahoo! module to fix some issues + that were there for quite some time already. - And all other users who help us by sending useful bug reports, positive feedback, nice patches and cool addons. Mentioning you all would make @@ -46,7 +46,7 @@ DEPENDENCIES ============ BitlBee's only real dependency is GLib. This is available on virtually every -platform. Any recent version of GLib (2.0 or higher) will work. +platform. Any recent version of GLib (2.4 or higher) will work. These days, MSN Messenger clients have to connect to the MS Passport servers through HTTPS. BitlBee can use several SSL libraries for this: GnuTLS, NSS @@ -183,17 +183,10 @@ LEGAL BitlBee is distributed under the GPL (GNU General Public License). See the file COPYING for this license. -Unfortunately some parts of the Gaim Jabber plugin (most notably the XML -code) were licensed under the MPL (Mozilla Public License) version 1.1. We -could not relicense this code under the GPL. As such it is still licensed -under the MPL. The parts of the code to which this applies are marked as -such. - -The MPL is provided in the file MPL-1.1.txt. This license is not GPL -compatible. It is however a free software license. - -Another part (the md5 algorithm) is licensed under the Aladdin license. -This license can be found in the files, to which this applies. +The MD5 algorithm code is licensed under the Aladdin license. This license +can be found in the files, to which this applies. The SHA1 algorithm code +is licensed under the Mozilla Public License, see http://www.mozilla.org/MPL/ +for details. The Yahoo! library used by BitlBee is libyahoo2 <http://libyahoo2.sf.net/>, also licensed under the GPL. @@ -201,5 +194,5 @@ also licensed under the GPL. BitlBee - An IRC to other chat networks gateway <http://www.bitlbee.org/> - Copyright (C) 2002-2006 Wilmer van der Gaast <wilmer@gaast.net> + Copyright (C) 2002-2007 Wilmer van der Gaast <wilmer@gaast.net> and others diff --git a/doc/bitlbee.8 b/doc/bitlbee.8 index 201e366e..ae1cfb05 100644 --- a/doc/bitlbee.8 +++ b/doc/bitlbee.8 @@ -62,6 +62,10 @@ option. Run in daemon mode. In this mode, BitlBee forks to the background and waits for new connections. All clients will be served from one process. This is still experimental. See the note above for more information. +.IP "-F" +Run in ForkDaemon mode. This is similar to ordinary daemon mode, but every +client gets its own process. Easier to set up than inetd mode, but without +the possible stability issues. .IP "-i \fIaddress\fP" Only useful when running in daemon mode, to specify the network interface (identified by IP address) to which the daemon should attach. Use this if diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index a920cfae..6646d0db 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -29,20 +29,13 @@ <description> <para> - Note that the servertag argument is optional. You only have to use it if the part after the @ in your handle isn't the hostname of your Jabber server, or if you want to use SSL/connect to a non-standard port number. The format is simple: [<servername>[:<portnumber>][:ssl]]. + The handle should be a full handle, including the domain name. You can specify a servername if necessary. Normally BitlBee doesn't need this though, since it's able to find out the server by doing DNS SRV lookups. </para> - </description> - <description> <para> - Google Talk uses the Jabber protocol. Please note that Google talk is SSL-only, but officially reachable over both port 5222 and 5223. Usually BitlBee users have to connect via port 5223, for example like this: + In previous versions it was also possible to specify port numbers and/or SSL in the server tag. This is deprecated and should now be done using the <emphasis>account set</emphasis> command. This also applies to specifying a resource in the handle (like <emphasis>wilmer@bitlbee.org/work</emphasis>). </para> </description> - - <ircexample> - <ircline nick="wilmer">account add jabber example@gmail.com hobbelmeeuw talk.google.com:5223:ssl</ircline> - <ircline nick="root">Account successfully added</ircline> - </ircexample> </bitlbee-command> <bitlbee-command name="msn"> @@ -516,6 +509,20 @@ </description> </bitlbee-setting> + <bitlbee-setting name="priority" type="integer" scope="account"> + <default>0</default> + + <description> + <para> + Can be set for Jabber connections. When connecting to one account from multiple places, this priority value will help the server to determine where to deliver incoming messages (that aren't addressed to a specific resource already). + </para> + + <para> + According to RFC 3921 servers will always deliver messages to the server with the highest priority value. Mmessages will not be delivered to resources with a negative priority setting (and should be saved as an off-line message if all available resources have a negative priority value). + </para> + </description> + </bitlbee-setting> + <bitlbee-setting name="private" type="boolean" scope="global"> <default>true</default> @@ -555,6 +562,21 @@ </description> </bitlbee-setting> + <bitlbee-setting name="resource_select" type="string" scope="account"> + <default>priority</default> + <possible-values>priority, time</possible-values> + + <description> + <para> + Because the IRC interface makes it pretty hard to specify the resource to talk to (when a buddy is online through different resources), this setting was added. + </para> + + <para> + Normally it's set to <emphasis>priority</emphasis> which means messages will always be delivered to the buddy's resource with the highest priority. If the setting is set to <emphasis>time</emphasis>, messages will be delivered to the resource that was last used to send you a message (or the resource that most recently connected). + </para> + </description> + </bitlbee-setting> + <bitlbee-setting name="save_on_quit" type="boolean" scope="global"> <default>true</default> @@ -596,6 +618,20 @@ </description> </bitlbee-setting> + <bitlbee-setting name="tls" type="boolean" scope="account"> + <default>try</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. + </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. + </para> + </description> + </bitlbee-setting> + <bitlbee-setting name="to_char" type="string" scope="global"> <default>": "</default> @@ -774,27 +810,27 @@ </bitlbee-command> - <bitlbee-command name="import_buddies"> - <short-description>Copy local buddy list to server (normally only needed when upgrading)</short-description> - <syntax>import_buddies <connection> [clear]</syntax> + <bitlbee-command name="join_chat"> + <short-description>Join a named groupchat/conference room</short-description> + <syntax>import_buddies <connection> <room name> [<channel name>] [<room nickname>] [<password>]</syntax> <description> <para> - This command copies the locally stored buddy list to the server. This command exists for upgrading purposes. Previous versions of BitlBee didn't support server-side buddy lists for ICQ, so the list was stored locally. - </para> - - <para> - Since version 0.91 however, server-side contact lists are supported for all protocols, so the local list is now ignored. When upgrading from an older BitlBee to version 0.91, you might need this command to get your buddy list back. + On most IM-networks groupchats can be started using the /join command. (<emphasis>/join #foo</emphasis> to start a chatroom with you and <emphasis>foo</emphasis>) This doesn't work with names groupchats though (which exist on Jabber networks and AIM, for example), instead you can use this command. </para> <para> - The only argument this command needs is your ICQ account identification. If your serverside buddy list contains some old buddies you don't want anymore, you can pass <emphasis>clear</emphasis> as a second argument. + The first two arguments are required. <emphasis>room name</emphasis> is the name of the chatroom on the IM-network. <emphasis>channel name</emphasis> is the IRC channel name BitlBee should map this to. <emphasis>room nickname</emphasis> is the nickname you want to have in this channel. If you don't give these options, BitlBee will do the right guesses. </para> <para> - After giving this command, you have to wait for a while before all the adds are handled, because of ICQ's rate limiting. If your buddy list is very large and the ICQ server starts complaining, you might have to reconnect and enter this command again. + The following command will join you to the chatroom called <emphasis>bitlbee@conference.bitlbee.org</emphasis>. The channel will be called <emphasis>&bitlbee-help</emphasis> because <emphasis>&bitlbee</emphasis> will already be in use. Your nickname will be <emphasis>help-me</emphasis>. </para> </description> + <ircexample> + <ircline nick="wilmer">join_chat jabber bitlbee@conference.bitlbee.org &bitlbee-help help-me</ircline> + </ircexample> + </bitlbee-command> </chapter> |