diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/BUILD.win32 | 10 | ||||
| -rw-r--r-- | doc/CHANGES | 58 | ||||
| -rw-r--r-- | doc/README | 47 | ||||
| -rw-r--r-- | doc/bitlbee.8 | 12 | ||||
| -rw-r--r-- | doc/user-guide/Support.xml | 9 | ||||
| -rw-r--r-- | doc/user-guide/commands.xml | 36 | ||||
| -rw-r--r-- | doc/user-guide/misc.xml | 28 | ||||
| -rw-r--r-- | doc/user-guide/quickstart.xml | 12 |
8 files changed, 119 insertions, 93 deletions
diff --git a/doc/BUILD.win32 b/doc/BUILD.win32 new file mode 100644 index 00000000..e1afe600 --- /dev/null +++ b/doc/BUILD.win32 @@ -0,0 +1,10 @@ +Instructions for building BitlBee for Windows
+=============================================
+
+1) Install the mingw32 compiler
+
+2) Compile GLib2 for the target i586-mingw32msvc
+
+3) Cross-compile BitlBee:
+
+$ ./configure --target=i586-mingw32msvc --ssl=bogus --arch=Windows
diff --git a/doc/CHANGES b/doc/CHANGES index ee4cde69..ac1f1f02 100644 --- a/doc/CHANGES +++ b/doc/CHANGES @@ -1,7 +1,37 @@ +This ChangeLog mostly lists changes relevant to users. A full log can be +found in the bzr commit logs, for example you can try: + +http://bugs.bitlbee.org/bitlbee/timeline?daysback=90&changeset=on + +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.) +- 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. +- Changed root nicknames are now saved. +- Added ClientInterface setting to bind() outgoing connections to a specific + network interface. +- Support for receiving Jabber chatroom invitations. +- Relaxed port restriction of the Jabber module: added ports 80 and 443. +- Preserving case in Jabber resources of buddies, since these should + officially be treated as case sensitive. +- Fully stripping spaces from AIM screennames, this didn't happen completely + which severly breaks the IRC protocol. +- Removed all the yellow tape around daemon mode, it's pretty mature by now: + testing.bitlbee.org serves all (~30) SSL users from one daemon mode + process without any serious stability issues. +- Fixed GLib <2.6 compatibility issue. +- Misc. memory leak/crash fixes. + +Finished 24 Jun 2008 + 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 +50,18 @@ 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. +- 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 @@ -68,8 +107,13 @@ 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 ??? +Finished 17 Mar 2008 Version 1.0.4: - Removed sethostent(), which causes problems for many people, especially on @@ -41,6 +41,25 @@ 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) + +Note that the BitlBee code is getting stable enough for daemon mode to be +useful. Some public servers use it, and it saves a lot of memory by serving +tens of users from a single process. One crash affects all users, but these +are becoming quite rare. + DEPENDENCIES ============ @@ -89,34 +108,6 @@ versions of make, we'd love to hear it, but it seems this just isn't possible. -RUNNING ON SERVERS WITH MANY USERS -================================== - -BitlBee is not yet bug-free. Sometimes a bug causes the program to get into -an infinite loop. Something you really don't want on a public server, -especially when that machine is also used for other (mission-critical) things. -For now we can't do much about it. We haven't seen that happen for a long -time already on our own machines, but some people still manage to get -themselves in nasty situations we haven't seen before. - -For now the best we can offer against this problem is bitlbeed, which allows -you to setrlimit() the child processes to use no more than a specified -number of CPU seconds. Not the best solution (not really a solution anyway), -but certainly trashing one busy daemon process is better than trashing your -whole machine. - -We don't believe adding a limit for bitlbee to /etc/security/limits.conf will -work, because that file is only read by PAM (ie just for real login users, -not daemons). - -See utils/bitlbeed.c for more information about the program. - -Just a little note: Now that we reach version 1.0, this shouldn't be that -much of an issue anymore. However, on a public server, especially if you -also use it for other things, it can't hurt to protect yourself against -possible problems. - - USAGE ===== diff --git a/doc/bitlbee.8 b/doc/bitlbee.8 index ae1cfb05..9e634844 100644 --- a/doc/bitlbee.8 +++ b/doc/bitlbee.8 @@ -43,13 +43,8 @@ protocol plugins. BitlBee currently supports Oscar (aim and icq), MSN, Jabber and Yahoo. \fBbitlbee\fP should be called by -.BR inetd (8). -(Or \fBbitlbeed\fP, -if you can't run and/or configure \fBinetd\fP.) There is an experimental -daemon mode too, in which BitlBee will serve all clients in one process -(and does not require inetd), but this mode is still experimental. -There are still some bugs left in BitlBee, and if they cause a crash, -that would terminate the BitlBee connection for all clients. +.BR inetd (8), +or you can run it as a stand-alone daemon. .PP .SH OPTIONS .PP @@ -61,10 +56,9 @@ option. .IP "-D" 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 +client gets its own process. Easier to set up than inetd mode, and without the possible stability issues. .IP "-i \fIaddress\fP" Only useful when running in daemon mode, to specify the network interface 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 @@ <title>Support</title> <sect1> -<title>BitlBee is beta software</title> +<title>Disclaimer</title> <para> -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. :-) </para> </sect1> diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 8c2a30ca..f0653232 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -162,11 +162,7 @@ </para> <para> - If you want, you can also tell BitlBee what nick to give the new contact. Of course you can also use the <emphasis>rename</emphasis> command for that, but sometimes this might be more convenient. - </para> - - <para> - Adding -tmp adds the buddy to the internal BitlBee structures only, not to the real contact list (like done by <emphasis>set handle_unknown add</emphasis>). 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 <emphasis>set handle_unknown add</emphasis>). This allows you to talk to people who are not in your contact list. This normally won't show you any presence notifications. </para> </description> @@ -531,16 +527,16 @@ </bitlbee-setting> <bitlbee-setting name="charset" type="string" scope="global"> - <default>iso8859-1</default> + <default>utf-8</default> <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values> <description> <para> - 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. </para> <para> - 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 </para> </description> @@ -803,6 +799,16 @@ </description> </bitlbee-setting> + <bitlbee-setting name="root_nick" type="string" scope="global"> + <default>root</default> + + <description> + <para> + Normally the "bot" that takes all your BitlBee commands is called "root". If you don't like this name, you can rename it to anything else using the <emphasis>rename</emphasis> command, or by changing this setting. + </para> + </description> + </bitlbee-setting> + <bitlbee-setting name="save_on_quit" type="boolean" scope="global"> <default>true</default> @@ -887,7 +893,7 @@ <description> <para> - 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. </para> </description> </bitlbee-setting> @@ -1056,21 +1062,17 @@ <bitlbee-command name="nick"> <short-description>Change friendly name, nick</short-description> <syntax>nick <connection> [<new nick>]</syntax> - <syntax>nick</syntax> + <syntax>nick <connection></syntax> <description> <para> - 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. - </para> - - <para> - It is recommended to use the per-account <emphasis>display_name</emphasis> setting to read and change this information. The <emphasis>nick</emphasis> command is deprecated. + Deprecated: Use the per-account <emphasis>display_name</emphasis> setting to read and change this information. </para> </description> <ircexample> - <ircline nick="wouter">nick 1 "Wouter Paesen"</ircline> - <ircline nick="root">Setting your name on connection 1 to `Wouter Paesen'</ircline> + <ircline nick="wouter">account set 1/display_name "The majestik møøse"</ircline> + <ircline nick="root">display_name = `The majestik møøse'</ircline> </ircexample> </bitlbee-command> 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. <varlistentry><term>(O)</term><listitem><para>Clock</para></listitem></varlistentry> </variablelist> -<para> -This list was extracted from <ulink url="http://help.msn.com/!data/en_us/data/messengerv50.its51/$content$/EMOTICONS.HTM?H_APP=">http://help.msn.com/!data/en_us/data/messengerv50.its51/$content$/EMOTICONS.HTM?H_APP=</ulink>. -</para> - </sect1> <sect1 id="groupchats"> <title>Groupchats</title> <para> -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. </para> <para> @@ -72,7 +68,7 @@ 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>jim_msn</emphasis> in it, just join the channel <emphasis>#jim_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 jim_msn in it. +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. </para> <para> @@ -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 <emphasis>join_chat</emphasis> command to join them. See <emphasis>help join_chat</emphasis> for more information. </para> -<para> -This is all you'll probably need to know. If you have any problems, please read <emphasis>help groupchats3</emphasis>. -</para> - -</sect1> - -<sect1 id="groupchats3"> -<title>Groupchat channel names</title> - -<para> -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. :-) -</para> - -<para> -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. -</para> - </sect1> <sect1 id="away"> @@ -120,6 +99,7 @@ Not all away states are supported by all protocols, and some protocols have diff <member>Be right back, BRB</member> <member>On the phone, Phone, On phone</member> <member>Out to lunch, Lunch, Food</member> + <member>Invisible, Hidden</member> </simplelist> <para> @@ -127,7 +107,7 @@ So <emphasis>/away Food</emphasis> will set your state to "Out to lunch" on your </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. 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. </para> </sect1> 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 <emphasis>account on</empha </para> <para> -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. </para> <para> -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. </para> <para> @@ -126,11 +126,15 @@ First of all, a person must be on your contact list for you to chat with them (u <ircexample> <ircline nick="you">tux: hey, how's the weather down there?</ircline> - <ircline nick="tux"> you: a bit chilly!</ircline> + <ircline nick="tux">you: a bit chilly!</ircline> </ircexample> <para> -If you'd rather chat with them in a separate window use the <emphasis>/msg</emphasis> or <emphasis>/query</emphasis> 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 <emphasis>set private</emphasis> command: <emphasis>set private true</emphasis> (<emphasis>set private false</emphasis> 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. +</para> + +<para> +If you prefer chatting in a separate window, use the <emphasis>/msg</emphasis> or <emphasis>/query</emphasis> 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 <emphasis>help set private</emphasis>. </para> <para> |