From d9d36fc09996ed8c2574f9336c3594aa3cc56941 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Wed, 21 Dec 2005 13:13:10 +0100 Subject: Add initial draft of BitlBee schema --- doc/bitlbee.schema | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 doc/bitlbee.schema (limited to 'doc') diff --git a/doc/bitlbee.schema b/doc/bitlbee.schema new file mode 100644 index 00000000..47d5e706 --- /dev/null +++ b/doc/bitlbee.schema @@ -0,0 +1,27 @@ +## LDAP Schema file for BitlBee +## +## We need the following object classes and related attributes: +## bitlBeeNick: +## - nick +## - password +## - setting (multiple values) +## +## bitlBeeAccount: +## - protocol (msn, oscar, jabber, yahoo, ...) +## - username +## - password +## - server name +## +## bitlBeeBuddy: +## - nick +## - handle + +## each bitlBeeNick has zero or more bitlBeeAccount subentries +## and bitlBeeAccount entries contain zero or more bitlBeeBuddy entries + +## The admin needs to setup the LDAP server to: +## - allow anonymous users to auth against bitlBeeNick objects on the +## password field +## - allow anonymous users to create new objects that start with nick= +## - allow read/write for a user that is authenticated only to his/her own +## object and subentries -- cgit v1.2.3 From a323a22773714a19254db34156500a67e5916451 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Sun, 12 Feb 2006 20:25:31 +1300 Subject: Add autoconnect property --- doc/bitlbee.schema | 1 + 1 file changed, 1 insertion(+) (limited to 'doc') diff --git a/doc/bitlbee.schema b/doc/bitlbee.schema index 47d5e706..9fc6895c 100644 --- a/doc/bitlbee.schema +++ b/doc/bitlbee.schema @@ -11,6 +11,7 @@ ## - username ## - password ## - server name +## - autoconnect (true/false) ## ## bitlBeeBuddy: ## - nick -- cgit v1.2.3 From d5dfc3d7ff2756a5991356bb643630fa7b03f8d9 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Fri, 24 Mar 2006 17:48:00 +0100 Subject: Start working on LDAP schema (OID's still need to be filled in) --- doc/bitlbee.schema | 65 +++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 54 insertions(+), 11 deletions(-) (limited to 'doc') diff --git a/doc/bitlbee.schema b/doc/bitlbee.schema index 9fc6895c..795f5854 100644 --- a/doc/bitlbee.schema +++ b/doc/bitlbee.schema @@ -1,17 +1,7 @@ ## LDAP Schema file for BitlBee +## Copyright (C) 2006 Jelmer Vernooij ## ## We need the following object classes and related attributes: -## bitlBeeNick: -## - nick -## - password -## - setting (multiple values) -## -## bitlBeeAccount: -## - protocol (msn, oscar, jabber, yahoo, ...) -## - username -## - password -## - server name -## - autoconnect (true/false) ## ## bitlBeeBuddy: ## - nick @@ -26,3 +16,56 @@ ## - allow anonymous users to create new objects that start with nick= ## - allow read/write for a user that is authenticated only to his/her own ## object and subentries + +## - userid +## - userPassword +## - setting (multiple values) +## depends: top, account + +#FIXME: Unique OID + +attributetype ( 1.3.6.1.4.1.7165.2.1.24 NAME 'bitlBeeAutoConnect' + DESC 'Autoconnect setting' + EQUALITY booleanMatch + SYNTAX 1.3.6.1.4.1.1466.115.121.1.7 SINGLE-VALUE ) + +#FIXME: Unique OID + +attributetype ( 1.3.6.1.4.1.7165.2.1.24 NAME 'bitlBeeAccountNo' + DESC 'Account number' + EQUALITY integerMatch + SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 SINGLE-VALUE ) + +#FIXME: Unique OID + +objectclass ( 1.3.6.1.4.1.7165.2.2.12 NAME 'bitlBeeAccount' SUP account STRUCTURAL + DESC 'BitlBee User Account ' + MUST ( userid, userPassword ) + MAY ( ) ) + +## bitlBeeAccount: +## - accountNo 1.3.6.1.4.1.1466.115.121.1.27 +## - protocol (msn, oscar, jabber, yahoo, ...) +## - username +## - password +## - server name +## - autoconnect (true/false) 1.3.6.1.4.1.1466.115.121.1.7 +## depends: top + +#FIXME: Unique OID +objectclass ( 1.3.6.1.4.1.7165.2.2.12 NAME 'bitlBeeIMAccount' SUP account STRUCTURAL + DESC 'BitlBee IM Account ' + MUST ( bitlBeeAccountNo, userid, userPassword ) + MAY ( host, bitlBeeAutoconnect ) ) + +#FIXME: Unique OID +objectclass ( 1.3.6.1.4.1.7165.2.2.12 NAME 'bitlBeeSetting' SUP top STRUCTURAL + DESC 'BitlBee Configuration Setting' + MUST ( bitlBeeSettingName ) + MAY ( bitlBeeSettingValue ) ) + +#FIXME: Unique OID +objectclass ( 1.3.6.1.4.1.7165.2.2.12 NAME 'bitlBeeBuddy' SUP top STRUCTURAL + DESC 'BitlBee Nick Mapping' + MUST ( bitlBeeBuddyHandle ) + MAY ( ircNick ) ) -- cgit v1.2.3 From 574af7e01a0cc738b4bbe7e903572943a85b9691 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Fri, 26 May 2006 01:20:54 +0200 Subject: Require GLib 2 --- doc/README | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/README b/doc/README index 12c21c51..c82c9aeb 100644 --- a/doc/README +++ b/doc/README @@ -46,7 +46,7 @@ DEPENDENCIES ============ BitlBee's only real dependency is GLib. This is available on virtually every -platform. Any recent version of GLib (including 1.x versions) will work. +platform. Any recent version of GLib (2.0 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 -- cgit v1.2.3 From 0025b5148725e524dfdc1da57b18fcd2be2608ee Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Sat, 3 Jun 2006 23:08:58 +0200 Subject: Use unique OID's and include BitlBee's OID (25873) --- doc/bitlbee.schema | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) (limited to 'doc') diff --git a/doc/bitlbee.schema b/doc/bitlbee.schema index 795f5854..3322e057 100644 --- a/doc/bitlbee.schema +++ b/doc/bitlbee.schema @@ -22,23 +22,17 @@ ## - setting (multiple values) ## depends: top, account -#FIXME: Unique OID - -attributetype ( 1.3.6.1.4.1.7165.2.1.24 NAME 'bitlBeeAutoConnect' +attributetype ( 1.3.6.1.4.1.25873.2.1.1 NAME 'bitlBeeAutoConnect' DESC 'Autoconnect setting' EQUALITY booleanMatch SYNTAX 1.3.6.1.4.1.1466.115.121.1.7 SINGLE-VALUE ) -#FIXME: Unique OID - -attributetype ( 1.3.6.1.4.1.7165.2.1.24 NAME 'bitlBeeAccountNo' +attributetype ( 1.3.6.1.4.1.25873.2.1.2 NAME 'bitlBeeAccountNo' DESC 'Account number' EQUALITY integerMatch SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 SINGLE-VALUE ) -#FIXME: Unique OID - -objectclass ( 1.3.6.1.4.1.7165.2.2.12 NAME 'bitlBeeAccount' SUP account STRUCTURAL +objectclass ( 1.3.6.1.4.1.25873.2.2.3 NAME 'bitlBeeAccount' SUP account STRUCTURAL DESC 'BitlBee User Account ' MUST ( userid, userPassword ) MAY ( ) ) @@ -52,20 +46,17 @@ objectclass ( 1.3.6.1.4.1.7165.2.2.12 NAME 'bitlBeeAccount' SUP account STRUCTUR ## - autoconnect (true/false) 1.3.6.1.4.1.1466.115.121.1.7 ## depends: top -#FIXME: Unique OID -objectclass ( 1.3.6.1.4.1.7165.2.2.12 NAME 'bitlBeeIMAccount' SUP account STRUCTURAL +objectclass ( 1.3.6.1.4.1.25873.2.2.1 NAME 'bitlBeeIMAccount' SUP account STRUCTURAL DESC 'BitlBee IM Account ' MUST ( bitlBeeAccountNo, userid, userPassword ) MAY ( host, bitlBeeAutoconnect ) ) -#FIXME: Unique OID -objectclass ( 1.3.6.1.4.1.7165.2.2.12 NAME 'bitlBeeSetting' SUP top STRUCTURAL +objectclass ( 1.3.6.1.4.1.25873.2.2.2 NAME 'bitlBeeSetting' SUP top STRUCTURAL DESC 'BitlBee Configuration Setting' MUST ( bitlBeeSettingName ) MAY ( bitlBeeSettingValue ) ) -#FIXME: Unique OID -objectclass ( 1.3.6.1.4.1.7165.2.2.12 NAME 'bitlBeeBuddy' SUP top STRUCTURAL +objectclass ( 1.3.6.1.4.1.25873.2.2.3 NAME 'bitlBeeBuddy' SUP top STRUCTURAL DESC 'BitlBee Nick Mapping' MUST ( bitlBeeBuddyHandle ) MAY ( ircNick ) ) -- cgit v1.2.3 From 75a4b85ea060c5b63e9742ee9d1591bd618ba5c2 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Fri, 14 Jul 2006 11:25:48 +0200 Subject: Fixed a memory leak, added a check for valid Jabber handles, and updated documentation (added information about "account set" and sorted the list of settings because it was a bit too random). --- doc/user-guide/commands.xml | 263 ++++++++++++++++++++++++++++---------------- doc/user-guide/help.xsl | 2 +- 2 files changed, 167 insertions(+), 98 deletions(-) (limited to 'doc') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 44a9882f..d28a8531 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -10,7 +10,7 @@ - Available actions: add, del, list, on, off. See help account <action> for more information. + Available actions: add, del, list, on, off and set. See help account <action> for more information. @@ -25,28 +25,28 @@ - account add jabber <handle> <password> [<servertag>] + account add jabber <handle@server.tld> <password> [<servertag>] - 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]]. For example, this is how you can connect to Google Talk: + 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]]. - - account add jabber example@gmail.com hobbelmeeuw talk.google.com:5223:ssl - Account successfully added - - - Note that Google talk is SSL-only, but officially reachable over both port 5222 and 5223. However, for some people only port 5222 works, for some people only 5223. This is something you'll have to try out. + 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: + + + account add jabber example@gmail.com hobbelmeeuw talk.google.com:5223:ssl + Account successfully added + - account add msn <handle> <password> + account add msn <handle@server.tld> <password> @@ -102,7 +102,7 @@ - This command will try to log into the specified account. If no account is specified, BitlBee will log into all the accounts. (Including accounts awaiting a reconnection) + This command will try to log into the specified account. If no account is specified, BitlBee will log into all the accounts that have the auto_connect flag set. @@ -117,7 +117,7 @@ - This command disconnects the connection for the specified account. If no account is specified, BitlBee will deactivate all active accounts. (Including accounts awaiting a reconnection) + This command disconnects the connection for the specified account. If no account is specified, BitlBee will deactivate all active accounts and cancel all pending reconnects. @@ -135,6 +135,26 @@ + + + account set <account id> + account set <account id>/<setting> + account set <account id>/<setting> <value> + + + + This account can be used to change various settings for IM accounts. For all protocols, this command can be used to change the handle or the password BitlBee uses to log in and if it should be logged in automatically. Some protocols have additional settings. You can see the settings available for a connection by typing account set <account id>. + + + + For more infomation about a setting, see help set <setting>. + + + + The account ID can be a number (see account list), the protocol name or (part of) the screenname, as long as it matches only one connection. + + + @@ -275,120 +295,145 @@ - - iso8859-1 - you can get a list of all possible values by doing 'iconv -l' in a shell + + True - The charset setting enables you to use different character sets in BitlBee. These get converted to UTF-8 before sending and from UTF-8 when receiving. + With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this. - + - If you don't know what's the best value for this, at least iso8859-1 is the best choice for most Western countries. You can try to find what works best for you on http://czyborra.com/charsets/iso8859.html + This setting can also be changed for specific accounts using the account set command. (However, these values will be ignored if the global auto_connect setting is disabled!) - - - True + + False - - If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel. + If an IM-connections breaks, you're supposed to bring it back up yourself. Having BitlBee do this automatically might not always be a good idea, for several reasons. If you want the connections to be restored automatically, you can enable this setting. - This setting is remembered (during one session) per-user, this setting only changes the default state. This option takes effect as soon as you reconnect. + See also the auto_reconnect_delay setting. + - - True + + 300 - If enabled causes BitlBee to save all current settings and account details when user disconnects. This is enabled by default, and these days there's not really a reason to have it disabled anymore. + Tell BitlBee after how many seconds it should attempt to bring an IM-connection back up after a crash. It's not a good idea to set this value very low, it will cause too much useless traffic when an IM-server is down for a few hours. + + + + See also the auto_reconnect setting. - + True - Determines what BitlBee should do with HTML in messages. Normally this is turned on and HTML will be stripped from messages, if BitlBee thinks there is HTML. - - - If BitlBee fails to detect this sometimes (most likely in AIM messages over an ICQ connection), you can set this setting to always, but this might sometimes accidentally strip non-HTML things too. + With this option enabled, the root user devoices people when they go away (just away, not offline) and gives the voice back when they come back. You might dislike the voice-floods you'll get if your contact list is huge, so this option can be disabled. - + False - Some debugging messages can be sent to the control channel if you wish. They're probably not really useful for you, unless you're doing some development on BitlBee. + By default, when you send a message to someone, BitlBee forwards this message to the user immediately. When you paste a large number of lines, the lines will be sent in separate messages, which might not be very nice to read. If you enable this setting, BitlBee will buffer your messages and wait for more data. + + + + Using the buddy_sendbuffer_delay setting you can specify the number of seconds BitlBee should wait for more data before the complete message is sent. + + + + Please note that if you remove a buddy from your list (or if the connection to that user drops) and there's still data in the buffer, this data will be lost. BitlBee will not try to send the message to the user in those cases. - - ": " + + 200 - It's customary that messages meant for one specific person on an IRC channel are prepended by his/her alias followed by a colon ':'. BitlBee does this by default. If you prefer a different character, you can set it using set to_char. + Tell BitlBee after how many (mili)seconds a buffered message should be sent. Values greater than 5 will be interpreted as miliseconds, 5 and lower as seconds. - Please note that this setting is only used for incoming messages. For outgoing messages you can use ':' (colon) or ',' to separate the destination nick from the message, and this is not configurable. + See also the buddy_sendbuffer setting. - - False + + iso8859-1 + you can get a list of all possible values by doing 'iconv -l' in a shell - Sends you a /notice when a user starts typing a message (if the protocol supports it, MSN for example). This is a bug, not a feature. (But please don't report it.. ;-) You don't want to use it. Really. In fact the typing-notification is just one of the least useful 'innovations' ever. It's just there because some guy will probably ask me about it anyway. ;-) + The charset setting enables you to use different character sets in BitlBee. These get converted to UTF-8 before sending and from UTF-8 when receiving. + + + + If you don't know what's the best value for this, at least iso8859-1 is the best choice for most Western countries. You can try to find what works best for you on http://czyborra.com/charsets/iso8859.html + - - both - both, root, user, none + + False - Some people prefer themself and root to have operator status in &bitlbee, other people don't. You can change these states using this setting. + Some debugging messages can be sent to the control channel if you wish. They're probably not really useful for you, unless you're doing some development on BitlBee. + + + + + root + root, last + - The value "both" means both user and root get ops. "root" means, well, just root. "user" means just the user. "none" means nobody will get operator status. + With this value set to root, lines written in the control channel without any nickname in front of them will be interpreted as commands. If you want BitlBee to send those lines to the last person you addressed in the control channel, set this to last. - - True - + - With this option enabled, the root user devoices people when they go away (just away, not offline) and gives the voice back when they come back. You might dislike the voice-floods you'll get if your contact list is huge, so this option can be disabled. + Currently only available for MSN connections. This setting allows you to read and change your "friendly name" for this connection. Since this is a server-side setting, it can't be changed when the account is off-line. + + False + + + With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name". + + + root root, add, add_private, add_channel, ignore @@ -416,134 +461,158 @@ - + True - With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this. + Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer. + - - False + + both + both, root, user, none - If an IM-connections breaks, you're supposed to bring it back up yourself. Having BitlBee do this automatically might not always be a good idea, for several reasons. If you want the connections to be restored automatically, you can enable this setting. + Some people prefer themself and root to have operator status in &bitlbee, other people don't. You can change these states using this setting. - See also the auto_reconnect_delay setting. + The value "both" means both user and root get ops. "root" means, well, just root. "user" means just the user. "none" means nobody will get operator status. - - - 300 - + - - Tell BitlBee after how many seconds it should attempt to bring an IM-connection back up after a crash. It's not a good idea to set this value very low, it will cause too much useless traffic when an IM-server is down for a few hours. + Use this global setting to change your "NickServ" password. - + - See also the auto_reconnect setting. + This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service. + + + + Note that BitlBee will always say this setting is empty. This doesn't mean there is no password, it just means that, for security reasons, BitlBee stores passwords somewhere else so they can't just be retrieved in plain text. - - - False - + + - - By default, when you send a message to someone, BitlBee forwards this message to the user immediately. When you paste a large number of lines, the lines will be sent in separate messages, which might not be very nice to read. If you enable this setting, BitlBee will buffer your messages and wait for more data. + Currently only available for Jabber connections. Specifies the port number to connect to. Usually this should be set to 5222, or 5223 for SSL-connections. + + + + + True + - Using the buddy_sendbuffer_delay setting you can specify the number of seconds BitlBee should wait for more data before the complete message is sent. + If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel. - Please note that if you remove a buddy from your list (or if the connection to that user drops) and there's still data in the buffer, this data will be lost. BitlBee will not try to send the message to the user in those cases. + This setting is remembered (during one session) per-user, this setting only changes the default state. This option takes effect as soon as you reconnect. - - - 200 + + lifo + lifo, fifo - - Tell BitlBee after how many (mili)seconds a buffered message should be sent. Values greater than 5 will be interpreted as miliseconds, 5 and lower as seconds. + This changes the order in which the questions from root (usually authorization requests from buddies) should be answered. When set to lifo, BitlBee immediately displays all new questions and they should be answered in reverse order. When this is set to fifo, BitlBee displays the first question which comes in and caches all the others until you answer the first one. - See also the buddy_sendbuffer setting. + Although the fifo setting might sound more logical (and used to be the default behaviour in older BitlBee versions), it turned out not to be very convenient for many users when they missed the first question (and never received the next ones). + + + BitlBee + + + + Can be set for Jabber connections. You can use this to connect to your Jabber account from multiple clients at once, with every client using a different resource string. + + - - root - root, last + + True - With this value set to root, lines written in the control channel without any nickname in front of them will be interpreted as commands. If you want BitlBee to send those lines to the last person you addressed in the control channel, set this to last. + If enabled causes BitlBee to save all current settings and account details when user disconnects. This is enabled by default, and these days there's not really a reason to have it disabled anymore. + + + + + Can be set for Jabber- and OSCAR-connections. For OSCAR, this must be set to login.icq.com if it's an ICQ connection, or login.oscar.aol.com if it's an AIM connection. For Jabber, you have to set this if the servername isn't equal to the part after the @ in the Jabber handle. + + - + False - - With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name". - + + + Currently only available for Jabber connections. Set this to true if the server accepts SSL connections. + + - + + True + - Use this setting to change your "NickServ" password. + Determines what BitlBee should do with HTML in messages. Normally this is turned on and HTML will be stripped from messages, if BitlBee thinks there is HTML. + + + If BitlBee fails to detect this sometimes (most likely in AIM messages over an ICQ connection), you can set this setting to always, but this might sometimes accidentally strip non-HTML things too. - - lifo - lifo, fifo + + ": " - This changes the order in which the questions from root (usually authorization requests from buddies) should be answered. When set to lifo, BitlBee immediately displays all new questions and they should be answered in reverse order. When this is set to fifo, BitlBee displays the first question which comes in and caches all the others until you answer the first one. + It's customary that messages meant for one specific person on an IRC channel are prepended by his/her alias followed by a colon ':'. BitlBee does this by default. If you prefer a different character, you can set it using set to_char. - Although the fifo setting might sound more logical (and used to be the default behaviour in older BitlBee versions), it turned out not to be very convenient for many users when they missed the first question (and never received the next ones). + Please note that this setting is only used for incoming messages. For outgoing messages you can use ':' (colon) or ',' to separate the destination nick from the message, and this is not configurable. - - True + + False - Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer. + Sends you a /notice when a user starts typing a message (if the protocol supports it, MSN for example). This is a bug, not a feature. (But please don't report it.. ;-) You don't want to use it. Really. In fact the typing-notification is just one of the least useful 'innovations' ever. It's just there because some guy will probably ask me about it anyway. ;-) - diff --git a/doc/user-guide/help.xsl b/doc/user-guide/help.xsl index 0eb1a88b..394530a7 100644 --- a/doc/user-guide/help.xsl +++ b/doc/user-guide/help.xsl @@ -6,7 +6,7 @@ - + -- cgit v1.2.3 From 89a180978d3e5d81300b82923e8a208ee085d754 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Fri, 14 Jul 2006 20:27:02 +0200 Subject: More documentation updates: Added a Scope: line for every setting (for per-account and global settings) and leaving out the Default: line when there is no default specified in XML (like with the display_name setting). --- doc/user-guide/Makefile | 2 +- doc/user-guide/commands.xml | 79 +++++++++++++++++++++++---------------------- doc/user-guide/help.xsl | 5 ++- 3 files changed, 46 insertions(+), 40 deletions(-) (limited to 'doc') diff --git a/doc/user-guide/Makefile b/doc/user-guide/Makefile index 98c4e99f..eb31fc0f 100644 --- a/doc/user-guide/Makefile +++ b/doc/user-guide/Makefile @@ -27,7 +27,7 @@ help.xml: commands.xml %.db.xml: %.xml docbook.xsl xsltproc --xinclude --output $@ docbook.xsl $< -help.txt: help.xml help.xsl +help.txt: help.xml help.xsl commands.xml misc.xml quickstart.xml xsltproc --stringparam extraparanewline "$(EXTRAPARANEWLINE)" --xinclude help.xsl $< | perl -0077 -pe 's/\n\n%/\n%/s; s/_b_/\002/g;' > $@ clean: diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index d28a8531..fd855360 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -295,8 +295,8 @@ - - True + + true @@ -309,8 +309,8 @@ - - False + + false @@ -320,11 +320,14 @@ See also the auto_reconnect_delay setting. - + + This setting can also be changed for specific accounts using the account set command. (However, these values will be ignored if the global auto_reconnect setting is disabled!) + + - + 300 @@ -338,8 +341,8 @@ - - True + + true @@ -348,8 +351,8 @@ - - False + + false @@ -366,7 +369,7 @@ - + 200 @@ -381,7 +384,7 @@ - + iso8859-1 you can get a list of all possible values by doing 'iconv -l' in a shell @@ -397,8 +400,8 @@ - - False + + false @@ -407,7 +410,7 @@ - + root root, last @@ -418,7 +421,7 @@ - + Currently only available for MSN connections. This setting allows you to read and change your "friendly name" for this connection. Since this is a server-side setting, it can't be changed when the account is off-line. @@ -426,15 +429,15 @@ - - False + + false With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name". - + root root, add, add_private, add_channel, ignore @@ -461,8 +464,8 @@ - - True + + true @@ -472,7 +475,7 @@ - + both both, root, user, none @@ -487,7 +490,7 @@ - + Use this global setting to change your "NickServ" password. @@ -503,7 +506,7 @@ - + Currently only available for Jabber connections. Specifies the port number to connect to. Usually this should be set to 5222, or 5223 for SSL-connections. @@ -511,8 +514,8 @@ - - True + + true @@ -525,7 +528,7 @@ - + lifo lifo, fifo @@ -540,7 +543,7 @@ - + BitlBee @@ -550,8 +553,8 @@ - - True + + true @@ -560,7 +563,7 @@ - + Can be set for Jabber- and OSCAR-connections. For OSCAR, this must be set to login.icq.com if it's an ICQ connection, or login.oscar.aol.com if it's an AIM connection. For Jabber, you have to set this if the servername isn't equal to the part after the @ in the Jabber handle. @@ -568,8 +571,8 @@ - - False + + false @@ -578,8 +581,8 @@ - - True + + true @@ -591,7 +594,7 @@ - + ": " @@ -605,8 +608,8 @@ - - False + + false diff --git a/doc/user-guide/help.xsl b/doc/user-guide/help.xsl index 394530a7..dec6a671 100644 --- a/doc/user-guide/help.xsl +++ b/doc/user-guide/help.xsl @@ -57,7 +57,10 @@ Processing setting '' ?set _b_Type:_b_ - _b_Default:_b_ + _b_Scope:_b_ + + _b_Default:_b_ + _b_Possible Values:_b_ -- cgit v1.2.3 From 0aaca60fdc1a6793b438ecc926bd937073d22685 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Wed, 19 Jul 2006 18:52:38 +0200 Subject: Added some (more) comments to .h files in lib/ and some minor fixes/cleanups. --- doc/user-guide/commands.xml | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'doc') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index fd855360..0016d190 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -745,6 +745,10 @@ This command allows to set the friendly name of an im account. If no new name is specified the command will report the current name. When the name contains spaces, don't forget to quote the whole nick in double quotes. Currently this command is only supported by the MSN protocol. + + + It is recommended to use the per-account display_name setting to read and change this information. The nick command is deprecated. + -- cgit v1.2.3 From 846cec61f2b94be60c7bae7f4d0de8952e2d45fa Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 13 Aug 2006 21:08:38 +0200 Subject: Added help information for the web_aware setting. --- doc/user-guide/commands.xml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'doc') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 0016d190..790e89f6 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -618,6 +618,20 @@ + + false + + + + ICQ allows people to see if you're on-line via a CGI-script. (http://status.icq.com/online.gif?icq=UIN) This can be nice to put on your website, but it seems that spammers also use it to see if you're online without having to add you to their contact list. So to prevent ICQ spamming, recent versions of BitlBee disable this feature by default. + + + + Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled. + + + + Rename (renick) a buddy rename <oldnick> <newnick> -- cgit v1.2.3 From 08cdb93834bcc1b67e4e7f44e8bc90b42c686658 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Mon, 14 Aug 2006 15:25:05 +0200 Subject: Updated the note about encryption in the README file. --- doc/README | 34 ++++++++++++++++++++++------------ 1 file changed, 22 insertions(+), 12 deletions(-) (limited to 'doc') diff --git a/doc/README b/doc/README index c82c9aeb..75988004 100644 --- a/doc/README +++ b/doc/README @@ -154,17 +154,27 @@ http://code.bitlbee.org/ A NOTE ON ENCRYPTION ==================== -BitlBee stores the accounts and settings (not your contact list though) in -some sort of encrypted/obfuscated format. - -*** THIS IS NOT A SAFE FORMAT! *** - -You should still make sure the rights to the configuration directory and -files are set so that only root and the BitlBee user can read/write them. - -This format is not to prevent malicicous users from running with your -passwords, but to prevent accidental glimpses of the administrators to cause -any harm. You have no choice but to trust root though. +There used to be a note here about the simple obfuscation method used to +make the passwords in the configuration files unreadable. However, BitlBee +now uses a better format (and real encryption (salted MD5 and RC4)) to store +the passwords. This means that people who somehow get their hands on your +configuration files can't easily extract your passwords from them anymore. + +However, once you log into the BitlBee server and send your password, an +intruder with tcpdump can still read your passwords. This can't really be +avoided, of course. The new format is a lot more reliable (because it can't +be cracked with just very basic crypto analysis anymore), but you still have +to be careful. The main extra protection offered by the new format is that +the files can only be cracked with some help from the user (by sending the +password at login time). + +So if you run a public server, it's most important that you don't give root +access to people who like to play with tcpdump. Also, it's a good idea to +delete all *.nicks/*.accounts files as soon as BitlBee converted them to the +new format (which happens as soon as the user logs in, it can't be done +automatically because it needs the password for that account). You won't +need them anymore (unless you want to switch back to an older BitlBee +version) and they only make it easier for others to crack your passwords. LEGAL @@ -191,5 +201,5 @@ also licensed under the GPL. BitlBee - An IRC to other chat networks gateway - Copyright (C) 2002-2005 Wilmer van der Gaast + Copyright (C) 2002-2006 Wilmer van der Gaast and others -- cgit v1.2.3 From 9829ae028dc1f0d8ab60cb18293234f2d4cc19b8 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Mon, 14 Aug 2006 22:17:54 +0200 Subject: Added information about the new file format to CHANGES. --- doc/CHANGES | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'doc') diff --git a/doc/CHANGES b/doc/CHANGES index 7b95e8cb..cd100741 100644 --- a/doc/CHANGES +++ b/doc/CHANGES @@ -1,3 +1,27 @@ +Version x.x: +- 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 + new format. It is recommended to delete the old files (BitlBee doesn't do + this automatically, it will just ignore them) since they won't be used + anymore (and since the old file format is a security risk). Some advantages + of this file format switch: + * Safer format, since the identify-password is now salted before generating + a checksum. This way one can't use MD5 reverse lookup databases to crack + passwords. Also, the IM-account passwords are encrypted using RC4 instead + of the simple obfuscation scheme which BitlBee used so far. + * Easier to extend than the previous format (at least the .nicks format was + horribly limited). + * Nicknames for buddies are now saved per-account instead of per-protocol. + So far having one buddy on multiple accounts of the same protocol was a + problem because the nicks generated for the two "instances" of this buddy + were very unpredictable. + NOTE: This also means that "account del" removes not just the account, + BUT ALSO ALL NICKNAMES! If you're changing IM accounts and don't want to + 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). + Version 1.0: - Removed some crashy debugging code. - QUIT command now works before logging in. (Mainly an RFC-compliancy fix.) -- cgit v1.2.3 From 2529faf12adfc414048dc41e949065855d0da945 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 15 Oct 2006 16:02:27 +0200 Subject: Small documentation fix (closes #208). --- doc/user-guide/commands.xml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 790e89f6..a920cfae 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -432,9 +432,11 @@ false - - With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name". - + + + With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name". + + -- cgit v1.2.3 From ee5c3558c7db32750e1029a1b4983672dc519bca Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 15 Oct 2006 17:01:13 +0200 Subject: Documentation updates. --- doc/user-guide/commands.xml | 54 +++++++++++++++++++++++++++++++++++++-------- 1 file changed, 45 insertions(+), 9 deletions(-) (limited to 'doc') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 790e89f6..09d4b7b6 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -29,20 +29,13 @@ - 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. - - - 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 account set command. This also applies to specifying a resource in the handle (like wilmer@bitlbee.org/work). - - - account add jabber example@gmail.com hobbelmeeuw talk.google.com:5223:ssl - Account successfully added - @@ -514,6 +507,20 @@ + + 0 + + + + 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). + + + + 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). + + + + true @@ -553,6 +560,21 @@ + + priority + priority, time + + + + 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. + + + + Normally it's set to priority which means messages will always be delivered to the buddy's resource with the highest priority. If the setting is set to time, messages will be delivered to the resource that was last used to send you a message (or the resource that most recently connected). + + + + true @@ -594,6 +616,20 @@ + + try + + + + Newer Jabber servers allow clients to convert a plain-text session to a TLS/SSL-encrypted session. Normally (with this setting set to try) BitlBee will do this, if possible. + + + + 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 true. Set it to false if you want the session to remain plain-text. + + + + ": " -- cgit v1.2.3 From a5ac9f94c2dad85cb0f504172635982368db4d65 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Mon, 16 Oct 2006 00:25:59 +0200 Subject: Filled in the user changelog a bit more. --- doc/CHANGES | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'doc') diff --git a/doc/CHANGES b/doc/CHANGES index cd100741..05ae81f6 100644 --- a/doc/CHANGES +++ b/doc/CHANGES @@ -1,4 +1,23 @@ Version x.x: +- 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 + don't get the stability problems BitlBee unfortunately still has in ordinary + (one-process) daemon mode. +- Added inter-process/connection communication. This made it possible to + implement some IRC operator features like WALLOPs, KILL, DIE, REHASH and + more. +- Added hooks for using libevent instead of GLib for event handling. This + should improve scalability, although this won't really be useful yet because + the one-process daemon mode is not reliable enough. +- BitlBee now makes the buddy quits when doing "account off" look like a + netsplit. Modern IRC clients show this in a different, more compact way. +- GLib 1.x compatibility was dropped. BitlBee now requires GLib 2.6 (FIXME) + or newer. This allows us to use more GLib features. By now GLib 1.x is so + old that supporting it isn't really necessary anymore. +- 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. - 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 -- cgit v1.2.3 From 670204fe6b883397208758d1e8e0c3ada699379c Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 22 Oct 2006 14:43:40 +0200 Subject: Copied 1.0.x changelogs, disabled LDAP support in configure (because the code just doesn't work yet) and added GLib version detection. (GLib 2.4 and up *should* work.) --- doc/CHANGES | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 58 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/CHANGES b/doc/CHANGES index 05ae81f6..e9435216 100644 --- a/doc/CHANGES +++ b/doc/CHANGES @@ -12,9 +12,9 @@ Version x.x: the one-process daemon mode is not reliable enough. - BitlBee now makes the buddy quits when doing "account off" look like a netsplit. Modern IRC clients show this in a different, more compact way. -- GLib 1.x compatibility was dropped. BitlBee now requires GLib 2.6 (FIXME) - or newer. This allows us to use more GLib features. By now GLib 1.x is so - old that supporting it isn't really necessary anymore. +- GLib 1.x compatibility was dropped. BitlBee now requires GLib 2.4 or newer. + This allows us to use more GLib features (like the XML parser). By now GLib + 1.x is so old that supporting it really isn't necessary anymore. - 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. @@ -41,6 +41,61 @@ Version x.x: and password for the existing connection. * Per-account settings (see the new "account set" command). +Version 1.0.3: +- Fixed ugliness in block/allow list commands (still not perfect though, the + list is empty or not up-to-date for most protocols). +- OSCAR module doesn't send the ICQ web-aware flag anymore, which seems to + get rid of a lot of ICQ spam. +- added show_got_added(), BitlBee asks you, after authorizing someone, if you + want to add him/her to your list too. +- add -tmp, mainly convenient if you want to talk to people who are not in + your list. +- Fixed ISON command, should work better with irssi now. +- Fixed compilation with tcc. +- Fixed xinetd-file. +- Misc. (crash)bug fixes, including one in the root command parsing that + caused mysterious error messages sometimes. + +Finished 24 Jun 2006 (Happy 4th birthday, BitlBee!) + +Version 1.0.2: +- Pieces of code cleanup, fixes for possible problems in error checking. +- Fixed an auto-reconnect cleanup problem that caused crashes in daemon mode. +- /AWAY in daemon mode now doesn't set the away state for every connection + anymore. +- Fixed a crash-bug on empty help subjects. +- Jabber now correctly sets the current away state when connecting. +- Added Invisible and Hidden to the away state alias list, invisible mode + should be pretty usable now. +- Fixed handling of iconv(): It's now done for everything that goes between + BitlBee and the IRC client, instead of doing it (almost) every time + something goes to or come from the IM-modules. Should've thought about + that before. :-) +- When cleaning up MSN switchboards with unsent msgs, it now also says which + contact those messages were meant for. +- You can now use the block and allow commands to see your current block/ + allow list. + +Finished 1 Apr 2006 + +Version 1.0.1: +- Support for AIM groupchats. +- Improved typing notification support for at least AIM. +- BitlBee sends a 005 reply when logging in, this informs modern IRC clients + of some of BitlBee's capabilities. This might also solve problems some + people were having with the new control channel name. +- MSN switchboards are now properly reset when talking to a person who is + offline. This fixes problems with messages to MSN people that sometimes + didn't arrive. +- Fixed one of the problems that made BitlBee show online Jabber people as + offline. +- Fixed problems with commas in MSN passwords. +- Added some consts for read-only data, which should make the BitlBee per- + process memory footprint a bit smaller. +- Other bits of code cleanup. + +Finished 14 Jan 2006 + Version 1.0: - Removed some crashy debugging code. - QUIT command now works before logging in. (Mainly an RFC-compliancy fix.) -- cgit v1.2.3 From c7d0f415e0bed09decce7a0503dce2274c9d94d9 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 3 Dec 2006 18:57:31 +0100 Subject: Added Jabber info to CHANGES. --- doc/CHANGES | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'doc') diff --git a/doc/CHANGES b/doc/CHANGES index e9435216..567a8ae6 100644 --- a/doc/CHANGES +++ b/doc/CHANGES @@ -40,6 +40,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 -- cgit v1.2.3 From 7740c4caae24fe8186947d0f1f6a114098daa171 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Tue, 5 Dec 2006 23:57:02 +0100 Subject: Fix xslt with newer (more pedantic) XSLT processors. --- doc/user-guide/docbook.xsl | 1 + doc/user-guide/help.xsl | 2 ++ 2 files changed, 3 insertions(+) (limited to 'doc') diff --git a/doc/user-guide/docbook.xsl b/doc/user-guide/docbook.xsl index 9adff305..21d6b08e 100644 --- a/doc/user-guide/docbook.xsl +++ b/doc/user-guide/docbook.xsl @@ -82,6 +82,7 @@ + cmd_ diff --git a/doc/user-guide/help.xsl b/doc/user-guide/help.xsl index dec6a671..b7e3c371 100644 --- a/doc/user-guide/help.xsl +++ b/doc/user-guide/help.xsl @@ -30,6 +30,7 @@ + Processing: ? @@ -121,6 +122,7 @@ + Processing command '' ? -- cgit v1.2.3 From dcf0f3e77ffd38ce3cc5d3c1eedfc655ff75a8f9 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 18 Feb 2007 22:46:50 +0000 Subject: Fixed Makefiles (make distclean was completely broken). --- doc/CHANGES | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/CHANGES b/doc/CHANGES index 567a8ae6..4c1d2ece 100644 --- a/doc/CHANGES +++ b/doc/CHANGES @@ -1,4 +1,4 @@ -Version x.x: +Version 1.1: (1.1.x will be a (hopefully short) development release) - 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 -- cgit v1.2.3 From d4589cb29dc06e68e9872316cfcd460c78e6aba3 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 18 Feb 2007 23:47:17 +0000 Subject: Little doc/help update. --- doc/CHANGES | 5 ++++- doc/README | 19 ++++++------------- doc/bitlbee.8 | 4 ++++ 3 files changed, 14 insertions(+), 14 deletions(-) (limited to 'doc') diff --git a/doc/CHANGES b/doc/CHANGES index 4c1d2ece..8e0fde42 100644 --- a/doc/CHANGES +++ b/doc/CHANGES @@ -1,4 +1,7 @@ -Version 1.1: (1.1.x will be a (hopefully short) development release) +Version 1.1: +- 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 diff --git a/doc/README b/doc/README index 75988004..bb6596ba 100644 --- a/doc/README +++ b/doc/README @@ -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 , also licensed under the GPL. @@ -201,5 +194,5 @@ also licensed under the GPL. BitlBee - An IRC to other chat networks gateway - Copyright (C) 2002-2006 Wilmer van der Gaast + Copyright (C) 2002-2007 Wilmer van der Gaast 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 -- cgit v1.2.3 From 6cfcfdf92b50719e8c08cc933879dae00a484215 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 18 Feb 2007 23:48:02 +0000 Subject: Added the right version tag. --- doc/CHANGES | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/CHANGES b/doc/CHANGES index 8e0fde42..8fb53608 100644 --- a/doc/CHANGES +++ b/doc/CHANGES @@ -1,4 +1,4 @@ -Version 1.1: +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. -- cgit v1.2.3 From b6423a0964c121edfb7a4318b1d909916d099d4d Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 18 Feb 2007 23:57:12 +0000 Subject: Little fix copied from Jelmer's integration branch, want to import the rest after doing this devel release because there are quite a lot of changes in it. --- doc/CHANGES | 1 + 1 file changed, 1 insertion(+) (limited to 'doc') diff --git a/doc/CHANGES b/doc/CHANGES index 8fb53608..3f509c46 100644 --- a/doc/CHANGES +++ b/doc/CHANGES @@ -21,6 +21,7 @@ Version 1.1dev: - 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 -- cgit v1.2.3 From b3cae44de28b62a282f2ba32260048174abc83e7 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 15 Apr 2007 21:44:08 -0700 Subject: Forgot to credit Greg for the update, and sorry to infamous41md for having your nick misspelled in the CREDITS file for so long! --- doc/CREDITS | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'doc') 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 -- cgit v1.2.3 From f7b44f2c094f99f03182485a30d95a029a84f809 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sat, 30 Jun 2007 22:52:44 +0100 Subject: Added help information for the join_chat command and its five arguments, which were completely undocumented so far. Also removed the import_buddies information because that command doesn't exist anymore anyway. --- doc/user-guide/commands.xml | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'doc') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 36678da2..6646d0db 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -810,27 +810,27 @@ - - Copy local buddy list to server (normally only needed when upgrading) - import_buddies <connection> [clear] + + Join a named groupchat/conference room + import_buddies <connection> <room name> [<channel name>] [<room nickname>] [<password>] - 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. + On most IM-networks groupchats can be started using the /join command. (/join #foo to start a chatroom with you and foo) This doesn't work with names groupchats though (which exist on Jabber networks and AIM, for example), instead you can use this command. - 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. + The first two arguments are required. room name is the name of the chatroom on the IM-network. channel name is the IRC channel name BitlBee should map this to. room nickname is the nickname you want to have in this channel. If you don't give these options, BitlBee will do the right guesses. - 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 clear as a second argument. - - - - 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 bitlbee@conference.bitlbee.org. The channel will be called &bitlbee-help because &bitlbee will already be in use. Your nickname will be help-me. + + join_chat jabber bitlbee@conference.bitlbee.org &bitlbee-help help-me + + -- cgit v1.2.3 From 1ffb46f027f501da45951428e097f69ced1c80e0 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 15 Jul 2007 00:45:30 +0100 Subject: Added join_chat command to the "help groupchat" information. --- doc/user-guide/misc.xml | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'doc') diff --git a/doc/user-guide/misc.xml b/doc/user-guide/misc.xml index f90ce538..d387d4b3 100644 --- a/doc/user-guide/misc.xml +++ b/doc/user-guide/misc.xml @@ -79,6 +79,10 @@ If you want to start a groupchat with the person jim_msn in Of course a channel with only two people isn't really exciting yet. So the next step is to invite some other people to the channel. For this, you can use the /invite command of your IRC client. Please do keep in mind that all the people have to be on the same network and contact list! You can't invite Yahoo! buddies into an MSN groupchat. + +Some protocols (like Jabber) also support named groupchats. BitlBee now supports these too. You can use the join_chat command to join them. See help join_chat for more information. + + This is all you'll probably need to know. If you have any problems, please read help groupchats3. -- cgit v1.2.3 From 8c2008ec2944c3eee13a25656cbd715f352ba4ed Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Wed, 10 Oct 2007 22:56:32 +0100 Subject: Added 1.0.4 changes to doc/CHANGES. --- doc/CHANGES | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/CHANGES b/doc/CHANGES index 3f509c46..6c109f25 100644 --- a/doc/CHANGES +++ b/doc/CHANGES @@ -1,4 +1,4 @@ -Version 1.1dev: +Version 1.2: - 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. @@ -65,6 +65,21 @@ Version 1.1dev: resources available for that buddy. (Of course this only works if the buddy is in your contact list.) +Finished ??? + +Version 1.0.4: +- Removed sethostent(), which causes problems for many people, especially on + *BSD. This is basically the reason for this release. +- "allow" command actually displays the allow list, not the block list. +- Yahoo away state/msg fix. +- Don't display "Gender: Male" by default if nothing's filled in (OSCAR + "info" command) +- Fixed account cleanup (possible infinite loop) in irc_free(). +- Fixed configdir error message to not always display the compile-time + setting. + +Finished 20 Aug 2007 + Version 1.0.3: - Fixed ugliness in block/allow list commands (still not perfect though, the list is empty or not up-to-date for most protocols). -- cgit v1.2.3 From 118638279f7a39422d9e07365b380fa773c5243e Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Wed, 10 Oct 2007 23:15:59 +0100 Subject: Made the netsplit-like quit messages optional. --- doc/user-guide/commands.xml | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'doc') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 6646d0db..cf40782f 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -595,6 +595,16 @@ + + true + + + + Some IRC clients parse quit messages sent by the IRC server to see if someone really left or just disappeared because of a netsplit. By default, BitlBee tries to simulate netsplit-like quit messages to keep the control channel window clean. If you don't like this (or if your IRC client doesn't support this) you can disable this setting. + + + + false -- cgit v1.2.3 From 3933853e12f9f4271c33e68425c3cc4d0aa53728 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 14 Oct 2007 23:57:42 +0100 Subject: Fixed a typo in "help join_chat". --- doc/user-guide/commands.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index cf40782f..b7af2027 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -822,7 +822,7 @@ Join a named groupchat/conference room - import_buddies <connection> <room name> [<channel name>] [<room nickname>] [<password>] + join_chat <connection> <room name> [<channel name>] [<room nickname>] [<password>] -- cgit v1.2.3 From a6df0b5d21370549328c7929a008abb68f2ed4db Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Wed, 14 Nov 2007 23:29:43 +0000 Subject: Added "xmlconsole" setting so it can be enabled at login time already. --- doc/user-guide/commands.xml | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'doc') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index cf40782f..8f97558f 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -680,6 +680,19 @@ + + false + + + + The Jabber module allows you to add a buddy xmlconsole to your contact list, which will then show you the raw XMPP stream between you and the server. You can also send XMPP packets to this buddy, which will then be sent to the server. + + + If you want to enable this XML console permanently (and at login time already), you can set this setting. + + + + Rename (renick) a buddy rename <oldnick> <newnick> -- cgit v1.2.3 From cd428e473fe4428041722fd373badef890edebd9 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sat, 17 Nov 2007 12:20:51 +0000 Subject: Added (account) set -del. --- doc/user-guide/commands.xml | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index b7af2027..05b9abea 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -133,6 +133,7 @@ account set <account id> account set <account id>/<setting> account set <account id>/<setting> <value> + account set -del <account id>/<setting> @@ -140,7 +141,7 @@ - For more infomation about a setting, see help set <setting>. + For more infomation about a setting, see help set <setting>. For details about the syntax of this command, see help set. @@ -245,12 +246,15 @@ Miscellaneous settings - set [<variable> [<value>]] + set + set <variable> + set <variable> <value> + set -del <variable> - Without any arguments, this command lists all the set variables. You can also specify a single argument, a variable name, to get that variable's value. To change this value, specify the new value as the second argument. + Without any arguments, this command lists all the set variables. You can also specify a single argument, a variable name, to get that variable's value. To change this value, specify the new value as the second argument. With -del you can reset a setting to its default value. -- cgit v1.2.3 From 7df5a087131d3b1bbe7add0907cd72217692ffd0 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Mon, 19 Nov 2007 23:36:57 +0000 Subject: Changelog update. --- doc/CHANGES | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/CHANGES b/doc/CHANGES index 6c109f25..b8dbe86f 100644 --- a/doc/CHANGES +++ b/doc/CHANGES @@ -15,6 +15,7 @@ Version 1.2: the one-process daemon mode is not reliable enough. - BitlBee now makes the buddy quits when doing "account off" look like a netsplit. Modern IRC clients show this in a different, more compact way. + (This can be disabled if your client doesn't support this.) - GLib 1.x compatibility was dropped. BitlBee now requires GLib 2.4 or newer. This allows us to use more GLib features (like the XML parser). By now GLib 1.x is so old that supporting it really isn't necessary anymore. @@ -47,13 +48,14 @@ Version 1.2: - 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 + including XEP45, 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. + * XEP45: Jabber chatroom support! * 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 -- cgit v1.2.3 From 221a27346f768b9626f2a0281ff774790858a0c2 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sat, 24 Nov 2007 19:07:22 +0000 Subject: 1.1.1dev (Although the CHANGES change isn't in there). --- doc/CHANGES | 2 ++ 1 file changed, 2 insertions(+) (limited to 'doc') diff --git a/doc/CHANGES b/doc/CHANGES index b8dbe86f..ee4cde69 100644 --- a/doc/CHANGES +++ b/doc/CHANGES @@ -66,6 +66,8 @@ Version 1.2: * 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.) + * An XML console (add xmlconsole to your contact list or see "help set + xmlconsole" if you want it permanently). Finished ??? -- cgit v1.2.3 From 3f2bc2d721c1ac3d6c11a88a350041c2166f71e7 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 9 Dec 2007 23:23:03 +0000 Subject: If I keep forgetting to credit people in commit msgs I should probably add them to doc/CREDITS. Shouldn't be using bzr uncommit all the time. ;-( --- doc/CREDITS | 1 + 1 file changed, 1 insertion(+) (limited to 'doc') diff --git a/doc/CREDITS b/doc/CREDITS index f805c251..d53f6de0 100644 --- a/doc/CREDITS +++ b/doc/CREDITS @@ -54,6 +54,7 @@ The authors thank the following people: - 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. +- misc@mandriva.org for lots of Jabber contributions. - And all other users who help us by sending useful bug reports, positive feedback, nice patches and cool addons. Mentioning you all would make -- cgit v1.2.3 From 30ce1ced040c44c528d0a6e6e9c6b10a1caf1052 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Wed, 12 Dec 2007 23:30:51 +0000 Subject: Killed the parameter to "account add" and changed the default server for OSCAR to what both login.icq.com and login.oscar.aol.com resolve to these days. There's no need to specify a server anymore so why bother. And cleaned up the docs (removed all references to those OSCAR servers). --- doc/user-guide/commands.xml | 12 ++++++------ doc/user-guide/quickstart.xml | 4 ++-- 2 files changed, 8 insertions(+), 8 deletions(-) (limited to 'doc') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index ac9bdf11..b4efd967 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -16,7 +16,7 @@ - account add <protocol> <username> <password> [<server>] + account add <protocol> <username> <password> @@ -25,7 +25,7 @@ - account add jabber <handle@server.tld> <password> [<servertag>] + account add jabber <handle@server.tld> <password> @@ -49,16 +49,16 @@ - account add oscar <handle> <password> [<servername>] + account add oscar <handle> <password> - Specifying a server is required for OSCAR, since OSCAR can be used for both ICQ- and AIM-connections. Although these days it's supposed to be possible to connect to ICQ via AIM-servers and vice versa, we like to stick with this separation for now. For ICQ connections, the servername is login.icq.com, for AIM connections it's login.oscar.aol.com. + OSCAR is the protocol used to connect to AIM and/or ICQ. The servers will automatically detect if you're using a numeric or non-numeric username so there's no need to tell which network you want to connect to. - account add oscar 72696705 hobbelmeeuw login.icq.com + account add oscar 72696705 hobbelmeeuw Account successfully added @@ -594,7 +594,7 @@ - Can be set for Jabber- and OSCAR-connections. For OSCAR, this must be set to login.icq.com if it's an ICQ connection, or login.oscar.aol.com if it's an AIM connection. For Jabber, you have to set this if the servername isn't equal to the part after the @ in the Jabber handle. + Can be set for Jabber- and OSCAR-connections. For Jabber, you might have to set this if the servername isn't equal to the part after the @ in the Jabber handle. For OSCAR this shouldn't be necessary anymore in recent BitlBee versions. diff --git a/doc/user-guide/quickstart.xml b/doc/user-guide/quickstart.xml index 520f240f..fcb06c6b 100644 --- a/doc/user-guide/quickstart.xml +++ b/doc/user-guide/quickstart.xml @@ -37,12 +37,12 @@ For instance, suppose you have an ICQ account with UIN 72696705 - account add oscar 72696705 QuickStart login.icq.com + account add jabber bitlbee@jabber.org QuickStart Account successfully added -Other available IM protocols are jabber, msn, and yahoo. Oscar is the protocol used by ICQ and AOL. For oscar, you need to specify the IM-server as a fourth argument (for msn and yahoo there is no fourth argument). For AOL Instant Messenger, the server name is login.oscar.aol.com. For ICQ, the server name is login.icq.com. +Other available IM protocols are msn, oscar, and yahoo. Oscar is the protocol used by ICQ and AOL. -- cgit v1.2.3 From 1febf5c93b231942cd9cac8ac6a5a0d830c581cc Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sat, 5 Jan 2008 21:15:32 +0000 Subject: Added "mail_notifications" setting. Who needs those notifications anyway? Closes: #338. --- doc/user-guide/commands.xml | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'doc') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index b4efd967..5a1e398c 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -474,6 +474,17 @@ + + false + + + + Some protocols (MSN, Yahoo!) can notify via IM about new e-mail. Since most people use their Hotmail/Yahoo! addresses as a spam-box, this is disabled default. If you want these notifications, you can enable this setting. + + + + + both both, root, user, none -- cgit v1.2.3 From 07ff8a2c5af9b281fa6cdf6f1273f7c55c83bdb2 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 13 Jan 2008 14:45:51 +0000 Subject: Fixed quickstart2. (Bug #349.) --- doc/user-guide/quickstart.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/user-guide/quickstart.xml b/doc/user-guide/quickstart.xml index fcb06c6b..7735a8d7 100644 --- a/doc/user-guide/quickstart.xml +++ b/doc/user-guide/quickstart.xml @@ -33,7 +33,7 @@ To add an account to the account list you will need to use the account -For instance, suppose you have an ICQ account with UIN 72696705 with password QuickStart, you would: +For instance, suppose you have a Jabber account at jabber.org with handle bitlbee@jabber.org with password QuickStart, you would: @@ -42,7 +42,7 @@ For instance, suppose you have an ICQ account with UIN 72696705 -Other available IM protocols are msn, oscar, and yahoo. Oscar is the protocol used by ICQ and AOL. +Other available IM protocols are msn, oscar, and yahoo. OSCAR is the protocol used by ICQ and AOL. For more information about the account add command, see help account add. -- cgit v1.2.3 From d5bd9c078ae2fb4d2e9354e943e06e017e878776 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Thu, 28 Feb 2008 22:39:37 +0000 Subject: My fix for semi-PEBKAC bug #353: Add a warning if someone seems to be using the wrong command, and fixing "help nick" example to show how it should be done now. --- doc/user-guide/commands.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 5a1e398c..3402cfd7 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -842,8 +842,8 @@ - nick 1 "Wouter Paesen" - Setting your name on connection 1 to `Wouter Paesen' + account set 1/display_name "The majestik møøse" + display_name = `The majestik møøse' -- cgit v1.2.3 From 7bb3afbf24aaae0df9cd2e0e0cc9ebaf8e19f228 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 2 Mar 2008 17:13:32 +0000 Subject: Oops, even GMail got out of beta quicker than this. ;-) --- doc/user-guide/Support.xml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/user-guide/Support.xml b/doc/user-guide/Support.xml index 401a4295..c9f50a5f 100644 --- a/doc/user-guide/Support.xml +++ b/doc/user-guide/Support.xml @@ -3,12 +3,13 @@ Support -BitlBee is beta software +Disclaimer -Although BitlBee has quite some functionality it is still beta. That means it -can crash at any time, corrupt your data or whatever. Don't use it in -any production environment and don't rely on it. +BitlBee doesn't come with a warranty and is still (and will probably always +be) under development. That means it can crash at any time, corrupt your +data or whatever. Don't use it in any production environment and don't rely +on it, or at least don't blame us if things blow up. :-) -- cgit v1.2.3 From 064e47c5927e1711fc45263d971998a7afca547b Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 2 Mar 2008 17:58:21 +0000 Subject: Some very late quickstart updates: ICQ supports server-side contact lists for ages already and private is set to true by default for quite some time as well. --- doc/user-guide/quickstart.xml | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/user-guide/quickstart.xml b/doc/user-guide/quickstart.xml index 7735a8d7..0539a7c7 100644 --- a/doc/user-guide/quickstart.xml +++ b/doc/user-guide/quickstart.xml @@ -60,11 +60,11 @@ When you are finished adding your account(s) use the account on -For most protocols (currently MSN, Jabber, Yahoo and AOL) BitlBee can download the contact list automatically from the IM server and all the on-line users should appear in the control channel when you log in. +Now BitlBee logs in and downloads the contact list from the IM server. In a few seconds, all your on-line buddies should show up in the control channel. -BitlBee will convert names into irc-friendly form (for instance: tux@example.com will be given the nickname tux). If you have more than one person who would have the same name by this logic (for instance: tux@example.com and tux@bitlbee.org) the second one to log on will be tux_. The same is true if you have a tux log on to AOL and a tux log on from Yahoo. +BitlBee will convert names into IRC-friendly form (for instance: tux@example.com will be given the nickname tux). If you have more than one person who would have the same name by this logic (for instance: tux@example.com and tux@bitlbee.org) the second one to log on will be tux_. The same is true if you have a tux log on to AOL and a tux log on from Yahoo. @@ -126,11 +126,15 @@ First of all, a person must be on your contact list for you to chat with them (u tux: hey, how's the weather down there? - you: a bit chilly! + you: a bit chilly! -If you'd rather chat with them in a separate window use the /msg or /query command, just like you would for a private message in IRC. If you want to have messages automatically come up in private messages rather than in the &bitlbee channel, use the set private command: set private true (set private false to change back). +Note that, although all contacts are in the &bitlbee channel, only tux will actually receive this message. The &bitlbee channel shouldn't be confused with a real IRC channel. + + + +If you prefer chatting in a separate window, use the /msg or /query command, just like on real IRC. BitlBee will remember how you talk to someone and show his/her responses the same way. If you want to change the default behaviour (for people you haven't talked to yet), see help set private. -- cgit v1.2.3 From b27557b2d23f3cbc0801bc628de24a2a6adcfca9 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 2 Mar 2008 22:12:06 +0000 Subject: More documentation fixes: Cleaned up dead links, removed more outdated information (like the "set charset" default, which is UTF-8 for ages already). --- doc/user-guide/commands.xml | 22 +++++++--------------- doc/user-guide/misc.xml | 28 ++++------------------------ 2 files changed, 11 insertions(+), 39 deletions(-) (limited to 'doc') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 3402cfd7..c45727b9 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -162,11 +162,7 @@ - If you want, you can also tell BitlBee what nick to give the new contact. Of course you can also use the rename command for that, but sometimes this might be more convenient. - - - - Adding -tmp adds the buddy to the internal BitlBee structures only, not to the real contact list (like done by set handle_unknown add). This allows you to talk to people who are not in your contact list. + If you want, you can also tell BitlBee what nick to give the new contact. The -tmp option adds the buddy to the internal BitlBee structures only, not to the real contact list (like done by set handle_unknown add). This allows you to talk to people who are not in your contact list. This normally won't show you any presence notifications. @@ -382,16 +378,16 @@ - iso8859-1 + utf-8 you can get a list of all possible values by doing 'iconv -l' in a shell - The charset setting enables you to use different character sets in BitlBee. These get converted to UTF-8 before sending and from UTF-8 when receiving. + This setting tells BitlBee what your IRC client sends and expects. It should be equal to the charset setting of your IRC client if you want to be able to send and receive non-ASCII text properly. - If you don't know what's the best value for this, at least iso8859-1 is the best choice for most Western countries. You can try to find what works best for you on http://czyborra.com/charsets/iso8859.html + Most systems use UTF-8 these days. On older systems, an iso8859 charset may work better. For example, iso8859-1 is the best choice for most Western countries. You can try to find what works best for you on http://www.unicodecharacter.com/charsets/iso8859.html @@ -676,7 +672,7 @@ - Sends you a /notice when a user starts typing a message (if the protocol supports it, MSN for example). This is a bug, not a feature. (But please don't report it.. ;-) You don't want to use it. Really. In fact the typing-notification is just one of the least useful 'innovations' ever. It's just there because some guy will probably ask me about it anyway. ;-) + 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. @@ -829,15 +825,11 @@ Change friendly name, nick nick <connection> [<new nick>] - nick + nick <connection> - This command allows to set the friendly name of an im account. If no new name is specified the command will report the current name. When the name contains spaces, don't forget to quote the whole nick in double quotes. Currently this command is only supported by the MSN protocol. - - - - It is recommended to use the per-account display_name setting to read and change this information. The nick command is deprecated. + Deprecated: Use the per-account display_name setting to read and change this information. diff --git a/doc/user-guide/misc.xml b/doc/user-guide/misc.xml index d387d4b3..b55a8915 100644 --- a/doc/user-guide/misc.xml +++ b/doc/user-guide/misc.xml @@ -46,16 +46,12 @@ All MSN smileys (except one) are case insensitive and work without the nose too. (O)Clock - -This list was extracted from http://help.msn.com/!data/en_us/data/messengerv50.its51/$content$/EMOTICONS.HTM?H_APP=. - - Groupchats -Since version 0.8x, BitlBee supports groupchats on the MSN and Yahoo! networks. This text will try to explain you how they work. +BitlBee now supports groupchats on all IM networks. This text will try to explain you how they work. @@ -72,7 +68,7 @@ Of course you can also create your own groupchats. Type help groupchat Creating groupchats -If you want to start a groupchat with the person jim_msn in it, just join the channel #jim_msn. BitlBee will refuse to join you to the channel with that name, but it will create a new virtual channel with root, you and jim_msn in it. +If you want to start a groupchat with the person lisa_msn in it, just join the channel #lisa_msn. BitlBee will refuse to join you to the channel with that name, but it will create a new virtual channel with root, you and lisa_msn in it. @@ -83,23 +79,6 @@ Of course a channel with only two people isn't really exciting yet. So the next Some protocols (like Jabber) also support named groupchats. BitlBee now supports these too. You can use the join_chat command to join them. See help join_chat for more information. - -This is all you'll probably need to know. If you have any problems, please read help groupchats3. - - - - - -Groupchat channel names - - -Obviously the (numbered) channel names don't make a lot of sense. Problem is that groupchats usually don't have names at all in the IM-world, while IRC insists on a name. So BitlBee just generates something random, just don't pay attention to it. :-) - - - -Please also note that BitlBee doesn't support groupchats for all protocols yet. BitlBee will tell you so. Support for other protocols will hopefully come later. - - @@ -120,6 +99,7 @@ Not all away states are supported by all protocols, and some protocols have diff Be right back, BRB On the phone, Phone, On phone Out to lunch, Lunch, Food + Invisible, Hidden @@ -127,7 +107,7 @@ So /away Food will set your state to "Out to lunch" on your -You can also add more information to your away message. Setting it to "Busy - Fixing BitlBee bugs" will set your IM-away-states to Busy, but your away message will be more descriptive for people on IRC. Protocols like Yahoo! and Jabber will also show this complete away message to your buddies. +You can also add more information to your away message. Setting it to "Busy - Fixing BitlBee bugs" will set your IM-away-states to Busy, but your away message will be more descriptive for people on IRC. Most IM-protocols can also show this additional information to your buddies. -- cgit v1.2.3 From ed3ae7e7d41f91917fc2ae92051c7c77c357fbab Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Mon, 3 Mar 2008 00:08:49 +0000 Subject: Added note about daemon mode to doc/README --- doc/README | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'doc') diff --git a/doc/README b/doc/README index bb6596ba..ca392573 100644 --- a/doc/README +++ b/doc/README @@ -41,6 +41,20 @@ Also, don't forget to create the configuration directory (/var/lib/bitlbee/ by default) and chown it to the UID BitlBee is running as. Make sure this directory is read-/writable by this user only. +--- (Fork)Daemon mode + +If you don't want to run any inetd daemon, you can run BitlBee in Daemon +mode. Right now, daemon mode may be a bad idea on servers with multiple +users, since possible fatal BitlBee bugs will crash the BitlBee process and +disconnect all connected users at once. Instead, you can use ForkDaemon +mode, which serves every user from a separate process, without depending on +an inetd daemon. + +To use BitlBee in daemon mode, just start it with the right flags or enable +it in bitlbee.conf. You probably want to write an init script to start +BitlBee automatically after a reboot. (This is where you realise using +a package from your distro would've been a better idea. :-P) + DEPENDENCIES ============ -- cgit v1.2.3 From d07c3a8cde47096ad69db7139d410dfee29e509b Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 16 Mar 2008 00:40:20 +0000 Subject: No idea what's holding back 1.2 anymore so at least I'll make sure bitlbee.h is correct. Also updated the changelog. Just remembered 1 or 2 things left to do before 1.2, maybe do them tomorrow? --- doc/CHANGES | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) (limited to 'doc') diff --git a/doc/CHANGES b/doc/CHANGES index ee4cde69..959c11fd 100644 --- a/doc/CHANGES +++ b/doc/CHANGES @@ -1,7 +1,4 @@ Version 1.2: -- 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 @@ -20,9 +17,16 @@ Version 1.2: This allows us to use more GLib features (like the XML parser). By now GLib 1.x is so old that supporting it really isn't necessary anymore. - 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. + I/O as much as possible, replaced the Gaim (0.59, IOW heavily outdated) + API, fixed lots of little bugs (including bugs that affected daemon mode + stability). See the bzr logs for more information. +- One of the user-visible changes from the API change: You can finally see + all away states/messages properly. +- Added units tests. Test coverage is very minimal for now. +- Better charset handling: Everything is just converted from/to UTF-8 right + in the IRC core, and charset mismatches are detected (if possible) and the + user is asked to resolve this before continuing. Also, UTF-8 is the default + setting now, since that's how the world seems to work these days. - 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 @@ -68,6 +72,11 @@ Version 1.2: buddy is in your contact list.) * An XML console (add xmlconsole to your contact list or see "help set xmlconsole" if you want it permanently). +- The Yahoo! module now says it supports YMSG protocol version 12, which will + hopefully keep the Yahoo module working after 2008-04-02 (when Yahoo! is + dropping support for version 6.x of their client). +- MSN switchboard handling changes. Hopefully less messages will get lost now, + although things are still not perfect. Finished ??? -- cgit v1.2.3 From ec0355f6998eb5dee254e4bc60a3207bb661c854 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 16 Mar 2008 16:31:27 +0000 Subject: Passwords in bitlbee.conf can now be (properly salted) MD5 hashes, for just that little bit extra security. --- doc/CHANGES | 2 ++ 1 file changed, 2 insertions(+) (limited to 'doc') diff --git a/doc/CHANGES b/doc/CHANGES index 959c11fd..b3c3b711 100644 --- a/doc/CHANGES +++ b/doc/CHANGES @@ -27,6 +27,8 @@ Version 1.2: in the IRC core, and charset mismatches are detected (if possible) and the user is asked to resolve this before continuing. Also, UTF-8 is the default setting now, since that's how the world seems to work these days. +- One can now keep hashed passwords in bitlbee.conf instead of the cleartext + version. - 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 -- cgit v1.2.3 From 6612cc9dd32475569875030f5acc7cc4b0374ba6 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Mon, 17 Mar 2008 22:35:24 +0000 Subject: Release 1.2 should now be ready. --- doc/CHANGES | 2 +- doc/RELEASE-SPEECH-1.2 | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+), 1 deletion(-) create mode 100644 doc/RELEASE-SPEECH-1.2 (limited to 'doc') diff --git a/doc/CHANGES b/doc/CHANGES index b3c3b711..65947617 100644 --- a/doc/CHANGES +++ b/doc/CHANGES @@ -80,7 +80,7 @@ Version 1.2: - MSN switchboard handling changes. Hopefully less messages will get lost now, although things are still not perfect. -Finished ??? +Finished 17 Mar 2008 Version 1.0.4: - Removed sethostent(), which causes problems for many people, especially on diff --git a/doc/RELEASE-SPEECH-1.2 b/doc/RELEASE-SPEECH-1.2 new file mode 100644 index 00000000..ec7c48b4 --- /dev/null +++ b/doc/RELEASE-SPEECH-1.2 @@ -0,0 +1,57 @@ +BitlBee ... is Bitl +------------------- + +"I CAN HAS SPEEECH?" This is how Wilmer announced to me that he was going to do +another BitlBee release. I was as surprised as you are. I thought he had given +up on this whole releasing business. + +There is some humor in using a LOLcats reference to announce a new Bee +release. The last major BitlBee release (1.0) was done a long time before the +hype even begun. Between then and now we've celebrated BitlBee's fifth birthday +and had a handful of releases, but nothing big happened. As a user this lax +release planning worries me. What if this means that later releases will take +even longer? I don't think we should fear this. Let us explore why this release +took so long. + +Personally, I blame Google. + +There, I've said it. Google. The guys who are so big on "Do No Evil" and all +that jazz. They caused this release to be so late. Let me explain why. + +They made Wilmer an offer. Wilmer, being the sillily naive guy he is, couldn't +refuse. There were no decapitated horses involved, but he couldn't refuse +nonetheless. That's not a big problem of course. Lots of guys (and gals, sure) +work for Google. It wouldn't have become a problem if they hadn't shipped him of +to Ireland. That's where the trouble starts. + +Ireland. Home of the leprechauns. These rascals joined forces with aliens and +LOLcats to abduct Wilmer. The aliens had been trying for years to kidnap him, +but they were on his turf and his trusty sidekicks Jelmer and Maurits were there +to help him. All that changed when he moved to Ireland. + +But it wasn't just that Wilmer was all alone in some strange place. It was also +that the aliens had created the LOLcats and made an alliance with the +leprechauns--the real rulers of Ireland. Wilmer is cool, but he's not that +cool. So they abducted him for a few years. When he finally came back, he +regathered his mad coding skills and hacked a new release together. + +By now you're thinking, what has happened to Jelmer and Maurits? Well, they're +still here and they worked on the Bee while Wilmer was absent. But, like open +source, they are very Bitl--they're cool, but they're ready when they're +ready. + +Well, whatever you may think of my little theory, they did take forever to +launch this release. We're not mad at them, because it shows. They have +added some cool new features and made plenty of changes under the hood. Let me +give you a sneak preview of some of the new features: Jabber groupchats are +supported. Configuration files are stored encrypted. You can now use +ForkDaemon mode, which gives better stability over normal daemon mode, but +doesn't require inetd. Also, server owners can now use the /OPER command to +spy on their users. And--as I was specifically asked to mention--this is the +first stable release that supports plugins. That's some Bitl changes for ya. + +BitlBee is cool, but ready when it's ready. Very Bitl. + +Sjoerd. LOL. + +(LOLBee by Erik Bosman.) -- cgit v1.2.3 From bfe7caaa8f7ec37506668b375bfa026b3349a6a6 Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Mon, 24 Mar 2008 13:55:25 +0000 Subject: Updated doc/CHANGES. --- doc/CHANGES | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'doc') diff --git a/doc/CHANGES b/doc/CHANGES index 65947617..4e9f72ab 100644 --- a/doc/CHANGES +++ b/doc/CHANGES @@ -1,3 +1,14 @@ +Version 1.2.1: +- Fixed proxy support. +- Fixed stalling issues while connecting to Jabber when using the OpenSSL + module. +- Fixed problem with GLib and ForkDaemon where processes didn't die when + the client disconnects. +- Fixed handling of "set charset none". (Which pretty much breaks the account + completely in 1.2.) + +Finished ... + Version 1.2: - 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 -- cgit v1.2.3 From 5ecf96b935c6f6c0fba00d84cf7616ee04b06aed Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 30 Mar 2008 17:15:15 +0100 Subject: Updated doc/CHANGES again. --- doc/CHANGES | 3 +++ 1 file changed, 3 insertions(+) (limited to 'doc') diff --git a/doc/CHANGES b/doc/CHANGES index 4e9f72ab..93ad35e2 100644 --- a/doc/CHANGES +++ b/doc/CHANGES @@ -6,6 +6,9 @@ Version 1.2.1: the client disconnects. - Fixed handling of "set charset none". (Which pretty much breaks the account completely in 1.2.) +- You can now automatically identify yourself to BitlBee by setting a server + password in your IRC client. +- Compatible with all crazy kinds of line endings that clients can send. Finished ... -- cgit v1.2.3 From ddba0aea68f90b06bb6278cada982eb88889c31c Mon Sep 17 00:00:00 2001 From: Wilmer van der Gaast Date: Sun, 30 Mar 2008 22:28:39 +0100 Subject: Removing speech, in case I forget before 1.2.1. --- doc/RELEASE-SPEECH-1.2 | 57 -------------------------------------------------- 1 file changed, 57 deletions(-) delete mode 100644 doc/RELEASE-SPEECH-1.2 (limited to 'doc') diff --git a/doc/RELEASE-SPEECH-1.2 b/doc/RELEASE-SPEECH-1.2 deleted file mode 100644 index ec7c48b4..00000000 --- a/doc/RELEASE-SPEECH-1.2 +++ /dev/null @@ -1,57 +0,0 @@ -BitlBee ... is Bitl -------------------- - -"I CAN HAS SPEEECH?" This is how Wilmer announced to me that he was going to do -another BitlBee release. I was as surprised as you are. I thought he had given -up on this whole releasing business. - -There is some humor in using a LOLcats reference to announce a new Bee -release. The last major BitlBee release (1.0) was done a long time before the -hype even begun. Between then and now we've celebrated BitlBee's fifth birthday -and had a handful of releases, but nothing big happened. As a user this lax -release planning worries me. What if this means that later releases will take -even longer? I don't think we should fear this. Let us explore why this release -took so long. - -Personally, I blame Google. - -There, I've said it. Google. The guys who are so big on "Do No Evil" and all -that jazz. They caused this release to be so late. Let me explain why. - -They made Wilmer an offer. Wilmer, being the sillily naive guy he is, couldn't -refuse. There were no decapitated horses involved, but he couldn't refuse -nonetheless. That's not a big problem of course. Lots of guys (and gals, sure) -work for Google. It wouldn't have become a problem if they hadn't shipped him of -to Ireland. That's where the trouble starts. - -Ireland. Home of the leprechauns. These rascals joined forces with aliens and -LOLcats to abduct Wilmer. The aliens had been trying for years to kidnap him, -but they were on his turf and his trusty sidekicks Jelmer and Maurits were there -to help him. All that changed when he moved to Ireland. - -But it wasn't just that Wilmer was all alone in some strange place. It was also -that the aliens had created the LOLcats and made an alliance with the -leprechauns--the real rulers of Ireland. Wilmer is cool, but he's not that -cool. So they abducted him for a few years. When he finally came back, he -regathered his mad coding skills and hacked a new release together. - -By now you're thinking, what has happened to Jelmer and Maurits? Well, they're -still here and they worked on the Bee while Wilmer was absent. But, like open -source, they are very Bitl--they're cool, but they're ready when they're -ready. - -Well, whatever you may think of my little theory, they did take forever to -launch this release. We're not mad at them, because it shows. They have -added some cool new features and made plenty of changes under the hood. Let me -give you a sneak preview of some of the new features: Jabber groupchats are -supported. Configuration files are stored encrypted. You can now use -ForkDaemon mode, which gives better stability over normal daemon mode, but -doesn't require inetd. Also, server owners can now use the /OPER command to -spy on their users. And--as I was specifically asked to mention--this is the -first stable release that supports plugins. That's some Bitl changes for ya. - -BitlBee is cool, but ready when it's ready. Very Bitl. - -Sjoerd. LOL. - -(LOLBee by Erik Bosman.) -- cgit v1.2.3