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/user-guide') 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/user-guide') 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/user-guide') 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/user-guide') 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 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/user-guide') 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/user-guide') 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 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/user-guide') 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 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/user-guide') 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/user-guide') 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 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/user-guide') 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/user-guide') 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/user-guide') 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/user-guide') 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 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/user-guide') 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/user-guide') 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/user-guide') 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/user-guide') 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/user-guide') 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/user-guide') 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/user-guide') 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