diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CHANGES | 38 | ||||
| -rw-r--r-- | doc/user-guide/Makefile | 2 | ||||
| -rw-r--r-- | doc/user-guide/commands.xml | 197 | ||||
| -rw-r--r-- | doc/user-guide/help.xml | 2 | ||||
| -rw-r--r-- | doc/user-guide/misc.xml | 28 | ||||
| -rw-r--r-- | doc/user-guide/user-guide.xml | 2 |
6 files changed, 222 insertions, 47 deletions
diff --git a/doc/CHANGES b/doc/CHANGES index ac1f1f02..1bfd71d4 100644 --- a/doc/CHANGES +++ b/doc/CHANGES @@ -3,6 +3,44 @@ found in the bzr commit logs, for example you can try: http://bugs.bitlbee.org/bitlbee/timeline?daysback=90&changeset=on +Version 1.2.4: +- Most important change (and main reason for releasing now): Upgraded Yahoo! + module to a newer version to get it working again. +- join_chat command replaced with the much better chat command: + * Similar to how account replaced login/slist/logout. Add a chatroom once, + then just /join it like any other room. Also automatic joining at login + time is now possible. + * Note that the old way of starting groupchats (/join #nickname) is now + also deprecated, use "chat with" instead. + * See "help chat" and "help chat add" for more information. +- Rewrote bitlbee.conf parser to be less dumb. +- Fixed compatibility (hopefully) with AIM mobile messages, certain kinds + of Google Talk chatrooms. +- Fixed numerous stability/reliability bugs over the last year. + +Finished 17 Oct 2009 + +Version 1.2.3: +- Fixed one more flaw similar to the previous hijacking bug, caused by incon- + sistent handling of the USTATUS_IDENTIFIED state. All code touching these + variables was reviewed and should be correct now. + +Finished 7 Sep 2008 + +Version 1.2.2: +- Security bugfix: It was possible to hijack accounts (without gaining access + to the old account, it's simply an overwrite) +- Some more stability improvements. +- Fixed bug where people with non-lowercase nicks couldn't drop their account. +- Easier upgrades of non-forking daemon mode servers (using the DEAF + command). +- Can be cross-compiled for Win32 now! (No support for SSL yet though, which + makes it less useful for now.) +- Exponential backoff on auto-reconnect. +- Changing passwords gives less confusing feedback ("password is empty") now. + +Finished 26 Aug 2008 + Version 1.2.1: - Fixed proxy support. - Fixed stalling issues while connecting to Jabber when using the OpenSSL diff --git a/doc/user-guide/Makefile b/doc/user-guide/Makefile index eb31fc0f..9841de8d 100644 --- a/doc/user-guide/Makefile +++ b/doc/user-guide/Makefile @@ -12,7 +12,7 @@ all: user-guide.txt user-guide.html help.txt # user-guide.pdf user-guide.ps user mv $*.db.txt $@ %.html: %.db.xml - xsltproc --output $@ http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl $< + xsltproc --output $@ http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl $< %.pdf: %.db.xml xmlto --skip-validation pdf $< diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 6d77f8cd..931608ee 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -124,7 +124,7 @@ <description> <para> - This command gives you a list of all the accounts known by BitlBee, including the numbers you'll need for most account commands. + This command gives you a list of all the accounts known by BitlBee. </para> </description> </bitlbee-command> @@ -137,11 +137,11 @@ <description> <para> - 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 <emphasis>account set <account id></emphasis>. + This command 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 <emphasis>account set <account id></emphasis>. </para> <para> - For more infomation about a setting, see <emphasis>help set <setting></emphasis>. For details about the syntax of this command, see <emphasis>help set</emphasis>. + For more infomation about a setting, see <emphasis>help set <setting></emphasis>. </para> <para> @@ -151,6 +151,93 @@ </bitlbee-command> </bitlbee-command> + <bitlbee-command name="chat"> + <short-description>Chatroom list maintenance</short-description> + <syntax>chat <action> [<arguments>]</syntax> + + <description> + + <para> + Available actions: add, del, list, with and set. See <emphasis>help chat <action></emphasis> for more information. + </para> + + </description> + + <bitlbee-command name="add"> + <syntax>chat add <account> <room> [<channel>]</syntax> + + <description> + <para> + Add a chatroom to the list of chatrooms you're interested in. BitlBee needs this list to map room names to a proper IRC channel name. + </para> + + <para> + After adding a room to your list, you can simply use the IRC /join command to enter the room. Also, you can tell BitlBee to automatically join the room when you log in. (See <emphasis>chat set</emphasis>) + </para> + + <para> + Password-protected rooms work exactly like on IRC, by passing the password as an extra argument to /join. + </para> + </description> + + </bitlbee-command> + + <bitlbee-command name="del"> + <syntax>chat del <chat id></syntax> + + <description> + <para> + This commands deletes an chatroom from your list. + </para> + + <para> + The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel. + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="list"> + <syntax>chat list</syntax> + + <description> + <para> + This command gives you a list of all the chatrooms known by BitlBee. + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="with"> + <syntax>chat with <nickname></syntax> + + <description> + <para> + While most <emphasis>chat</emphasis> subcommands are about named chatrooms, this command can be used to open an unnamed groupchat with one or more persons. This command is what <emphasis>/join #nickname</emphasis> used to do in older BitlBee versions. + </para> + </description> + </bitlbee-command> + + <bitlbee-command name="set"> + <syntax>chat set <chat id></syntax> + <syntax>chat set <chat id>/<setting></syntax> + <syntax>chat set <chat id>/<setting> <value></syntax> + <syntax>chat set -del <chat id>/<setting></syntax> + + <description> + <para> + This command can be used to change various settings for chatrooms. + </para> + + <para> + For more infomation about a setting, see <emphasis>help set <setting></emphasis>. + </para> + + <para> + The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel. + </para> + </description> + </bitlbee-command> + </bitlbee-command> + <bitlbee-command name="add"> <short-description>Add a buddy to your contact list</short-description> <syntax>add <connection> <handle> [<nick>]</syntax> @@ -302,6 +389,16 @@ </description> </bitlbee-setting> + <bitlbee-setting name="auto_join" type="boolean" scope="chat"> + <default>false</default> + + <description> + <para> + With this option enabled, BitlBee will automatically join this chatroom when you log in. + </para> + </description> + </bitlbee-setting> + <bitlbee-setting name="auto_reconnect" type="boolean" scope="both"> <default>false</default> @@ -320,12 +417,16 @@ </description> </bitlbee-setting> - <bitlbee-setting name="auto_reconnect_delay" type="integer" scope="global"> - <default>300</default> + <bitlbee-setting name="auto_reconnect_delay" type="string" scope="global"> + <default>5*3<900</default> <description> <para> - 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. + Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up. + </para> + + <para> + This can be one integer, for a constant delay. One can also set it to something like "10*10", which means wait for ten seconds on the first reconnect, multiply it by ten on every failure. Once successfully connected, this delay is re-set to the initial value. With < you can give a maximum delay. </para> <para> @@ -334,6 +435,22 @@ </description> </bitlbee-setting> + <bitlbee-setting name="away" type="string" scope="both"> + <description> + <para> + To mark yourself as away, it is recommended to just use <emphasis>/away</emphasis>, like on normal IRC networks. If you want to mark yourself as away on only one IM network, you can use this per-account setting. + </para> + + <para> + You can set it to any value and BitlBee will try to map it to the most appropriate away state for every open IM connection, or set it as a free-form away message where possible. + </para> + + <para> + Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>. + </para> + </description> + </bitlbee-setting> + <bitlbee-setting name="away_devoice" type="boolean" scope="global"> <default>true</default> @@ -481,6 +598,30 @@ </bitlbee-setting> + <bitlbee-setting name="nick" type="string" scope="chat"> + + <description> + <para> + You can use this option to set your nickname in a chatroom. You won't see this nickname yourself, but other people in the room will. By default, BitlBee will use your username as the chatroom nickname. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="nick_source" type="string" scope="account"> + <default>handle</default> + <possible-values>handle, full_name, first_name</possible-values> + + <description> + <para> + By default, BitlBee generates a nickname for every contact by taking its handle and chopping off everything after the @. In some cases, this gives very inconvenient nicknames. The Facebook XMPP server is a good example, as all Facebook XMPP handles are numeric. + </para> + + <para> + With this setting set to <emphasis>full_name</emphasis>, the person's full name is used to generate a nickname. Or if you don't like long nicknames, set this setting to <emphasis>first_name</emphasis> instead and only the first word will be used. Note that the full name can be full of non-ASCII characters which will be stripped off. + </para> + </description> + </bitlbee-setting> + <bitlbee-setting name="ops" type="string" scope="global"> <default>both</default> <possible-values>both, root, user, none</possible-values> @@ -575,7 +716,7 @@ <bitlbee-setting name="resource_select" type="string" scope="account"> <default>priority</default> - <possible-values>priority, time</possible-values> + <possible-values>priority, activity</possible-values> <description> <para> @@ -583,7 +724,7 @@ </para> <para> - Normally it's set to <emphasis>priority</emphasis> which means messages will always be delivered to the buddy's resource with the highest priority. If the setting is set to <emphasis>time</emphasis>, messages will be delivered to the resource that was last used to send you a message (or the resource that most recently connected). + Normally it's set to <emphasis>priority</emphasis> which means messages will always be delivered to the buddy's resource with the highest priority. If the setting is set to <emphasis>activity</emphasis>, messages will be delivered to the resource that was last used to send you a message (or the resource that most recently connected). </para> </description> </bitlbee-setting> @@ -636,6 +777,22 @@ </description> </bitlbee-setting> + <bitlbee-setting name="status" type="string" scope="both"> + <description> + <para> + Certain protocols (like Jabber/XMPP) support status messages, similar to away messages. They can be used to indicate things like your location or activity, without showing up as away/busy. + </para> + + <para> + This setting can be used to set such a message. It will be available as a per-account setting for protocols that support it, and also as a global setting (which will then automatically be used for all protocols that support it). + </para> + + <para> + Away states set using <emphasis>/away</emphasis> or the <emphasis>away</emphasis> setting will override this setting. To un-set the setting, use <emphasis>set -del status</emphasis>. + </para> + </description> + </bitlbee-setting> + <bitlbee-setting name="strip_html" type="boolean" scope="global"> <default>true</default> @@ -849,28 +1006,4 @@ </ircexample> </bitlbee-command> - - <bitlbee-command name="join_chat"> - <short-description>Join a named groupchat/conference room</short-description> - <syntax>join_chat <connection> <room name> [<channel name>] [<room nickname>] [<password>]</syntax> - - <description> - <para> - On most IM-networks groupchats can be started using the /join command. (<emphasis>/join #foo</emphasis> to start a chatroom with you and <emphasis>foo</emphasis>) This doesn't work with names groupchats though (which exist on Jabber networks and AIM, for example), instead you can use this command. - </para> - - <para> - The first two arguments are required. <emphasis>room name</emphasis> is the name of the chatroom on the IM-network. <emphasis>channel name</emphasis> is the IRC channel name BitlBee should map this to. <emphasis>room nickname</emphasis> is the nickname you want to have in this channel. If you don't give these options, BitlBee will do the right guesses. - </para> - - <para> - The following command will join you to the chatroom called <emphasis>bitlbee@conference.bitlbee.org</emphasis>. The channel will be called <emphasis>&bitlbee-help</emphasis> because <emphasis>&bitlbee</emphasis> will already be in use. Your nickname will be <emphasis>help-me</emphasis>. - </para> - </description> - - <ircexample> - <ircline nick="wilmer">join_chat jabber bitlbee@conference.bitlbee.org &bitlbee-help help-me</ircline> - </ircexample> - - </bitlbee-command> </chapter> diff --git a/doc/user-guide/help.xml b/doc/user-guide/help.xml index 34fdb9e2..7487a841 100644 --- a/doc/user-guide/help.xml +++ b/doc/user-guide/help.xml @@ -1,4 +1,4 @@ -<?xml version="1.0" encoding="iso-8859-1"?> +<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> <book id="BitlBee-Help" xmlns:xi="http://www.w3.org/2003/XInclude"> diff --git a/doc/user-guide/misc.xml b/doc/user-guide/misc.xml index b55a8915..a926775a 100644 --- a/doc/user-guide/misc.xml +++ b/doc/user-guide/misc.xml @@ -68,15 +68,15 @@ Of course you can also create your own groupchats. Type <emphasis>help groupchat <title>Creating groupchats</title> <para> -If you want to start a groupchat with the person <emphasis>lisa_msn</emphasis> in it, just join the channel <emphasis>#lisa_msn</emphasis>. 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. +To open a groupchat, use the <emphasis>chat with</emphasis> command. For example, to start a groupchat with the person <emphasis>lisa_msn</emphasis> in it, just type <emphasis>chat with lisa_msn</emphasis>. BitlBee will create a new virtual channel with root, you and lisa_msn in it. </para> <para> -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 <emphasis>/invite</emphasis> 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. +Then, just use the ordinary IRC <emphasis>/invite</emphasis> command to invite more people. 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. </para> <para> -Some protocols (like Jabber) also support named groupchats. BitlBee now supports these too. You can use the <emphasis>join_chat</emphasis> command to join them. See <emphasis>help join_chat</emphasis> for more information. +Some protocols (like Jabber) also support named groupchats. BitlBee now supports these too. You can use the <emphasis>chat add</emphasis> command to join them. See <emphasis>help chat add</emphasis> for more information. </para> </sect1> @@ -85,31 +85,35 @@ Some protocols (like Jabber) also support named groupchats. BitlBee now supports <title>Away states</title> <para> -As you might've expected, you can just use the <emphasis>/away</emphasis> command in your IRC client to set an away-state. BitlBee supports most away-states supported by the protocols. +To mark yourself as away, you can just use the <emphasis>/away</emphasis> command in your IRC client. BitlBee supports most away-states supported by the protocols. </para> <para> -Not all away states are supported by all protocols, and some protocols have different names for them. BitlBee will try to pick the best available alias from this list for every connection: +Away states have different names accross different protocols. BitlBee will try to pick the best available option for every connection: </para> <simplelist> - <member>Away from computer, Away, Extended away</member> - <member>NA, N/A, Not available</member> - <member>Busy, Do not disturb, DND, Occupied</member> - <member>Be right back, BRB</member> - <member>On the phone, Phone, On phone</member> - <member>Out to lunch, Lunch, Food</member> + <member>Away</member> + <member>NA</member> + <member>Busy, DND</member> + <member>BRB</member> + <member>Phone</member> + <member>Lunch, Food</member> <member>Invisible, Hidden</member> </simplelist> <para> -So <emphasis>/away Food</emphasis> will set your state to "Out to lunch" on your MSN connection, and for most other connections the default, "Away" or "Away from computer" will be chosen. +So <emphasis>/away Food</emphasis> will set your state to "Out to lunch" on your MSN connection, and for most other connections the default, "Away" will be chosen. </para> <para> 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. </para> +<para> +If you want to set an away state for only one of your connections, you can use the per-account <emphasis>away</emphasis> setting. See <emphasis>help set away</emphasis>. +</para> + </sect1> </chapter> diff --git a/doc/user-guide/user-guide.xml b/doc/user-guide/user-guide.xml index 5b881fb2..5e1c8fe0 100644 --- a/doc/user-guide/user-guide.xml +++ b/doc/user-guide/user-guide.xml @@ -1,4 +1,4 @@ -<?xml version="1.0" encoding="iso-8859-1"?> +<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> <book id="BitlBee-User-Guide" xmlns:xi="http://www.w3.org/2003/XInclude"> |