Changeset 6738a67 for doc


Ignore:
Timestamp:
2008-07-16T23:22:52Z (17 years ago)
Author:
Sven Moritz Hallberg <pesco@…>
Branches:
master
Children:
9b55485
Parents:
9730d72 (diff), 6a78c0e (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.
Message:

merge in latest trunk

Location:
doc
Files:
1 added
7 edited

Legend:

Unmodified
Added
Removed
  • doc/CHANGES

    r9730d72 r6738a67  
     1This ChangeLog mostly lists changes relevant to users. A full log can be
     2found in the bzr commit logs, for example you can try:
     3
     4http://bugs.bitlbee.org/bitlbee/timeline?daysback=90&changeset=on
     5
     6Version 1.2.1:
     7- Fixed proxy support.
     8- Fixed stalling issues while connecting to Jabber when using the OpenSSL
     9  module.
     10- Fixed problem with GLib and ForkDaemon where processes didn't die when
     11  the client disconnects.
     12- Fixed handling of "set charset none". (Which pretty much breaks the account
     13  completely in 1.2.)
     14- You can now automatically identify yourself to BitlBee by setting a server
     15  password in your IRC client.
     16- Compatible with all crazy kinds of line endings that clients can send.
     17- Changed root nicknames are now saved.
     18- Added ClientInterface setting to bind() outgoing connections to a specific
     19  network interface.
     20- Support for receiving Jabber chatroom invitations.
     21- Relaxed port restriction of the Jabber module: added ports 80 and 443.
     22- Preserving case in Jabber resources of buddies, since these should
     23  officially be treated as case sensitive.
     24- Fully stripping spaces from AIM screennames, this didn't happen completely
     25  which severly breaks the IRC protocol.
     26- Removed all the yellow tape around daemon mode, it's pretty mature by now:
     27  testing.bitlbee.org serves all (~30) SSL users from one daemon mode
     28  process without any serious stability issues.
     29- Fixed GLib <2.6 compatibility issue.
     30- Misc. memory leak/crash fixes.
     31
     32Finished 24 Jun 2008
     33
    134Version 1.2:
    2 - First BitlBee development/testing RELEASE. This should be quite stable
    3   though (and for most people more stable than 1.0.x). It just has a couple
    4   of rough edges and needs a bit more testing.
    535- Added ForkDaemon mode next to the existing Daemon- and inetd modes. With
    636  ForkDaemon you can run BitlBee as a stand-alone daemon and every connection
     
    2151  1.x is so old that supporting it really isn't necessary anymore.
    2252- Many, many, MANY little changes, improvements, fixes. Using non-blocking
    23   I/O as much as possible, fixed lots of little bugs (including bugs that
    24   affected daemon mode stability). See the bzr logs for more information.
    25 - Added units tests, will have to add some more before the real release.
     53  I/O as much as possible, replaced the Gaim (0.59, IOW heavily outdated)
     54  API, fixed lots of little bugs (including bugs that affected daemon mode
     55  stability). See the bzr logs for more information.
     56- One of the user-visible changes from the API change: You can finally see
     57  all away states/messages properly.
     58- Added units tests. Test coverage is very minimal for now.
     59- Better charset handling: Everything is just converted from/to UTF-8 right
     60  in the IRC core, and charset mismatches are detected (if possible) and the
     61  user is asked to resolve this before continuing. Also, UTF-8 is the default
     62  setting now, since that's how the world seems to work these days.
     63- One can now keep hashed passwords in bitlbee.conf instead of the cleartext
     64  version.
    2665- Most important change: New file format for user data (accounts, nicks and
    2766  settings). Migration to the new format should happen transparently,
     
    69108  * An XML console (add xmlconsole to your contact list or see "help set
    70109    xmlconsole" if you want it permanently).
    71 
    72 Finished ???
     110- The Yahoo! module now says it supports YMSG protocol version 12, which will
     111  hopefully keep the Yahoo module working after 2008-04-02 (when Yahoo! is
     112  dropping support for version 6.x of their client).
     113- MSN switchboard handling changes. Hopefully less messages will get lost now,
     114  although things are still not perfect.
     115
     116Finished 17 Mar 2008
    73117
    74118Version 1.0.4:
  • doc/README

    r9730d72 r6738a67  
    4141by default) and chown it to the UID BitlBee is running as. Make sure this
    4242directory is read-/writable by this user only.
     43
     44--- (Fork)Daemon mode
     45
     46If you don't want to run any inetd daemon, you can run BitlBee in Daemon
     47mode. Right now, daemon mode may be a bad idea on servers with multiple
     48users, since possible fatal BitlBee bugs will crash the BitlBee process and
     49disconnect all connected users at once. Instead, you can use ForkDaemon
     50mode, which serves every user from a separate process, without depending on
     51an inetd daemon.
     52
     53To use BitlBee in daemon mode, just start it with the right flags or enable
     54it in bitlbee.conf. You probably want to write an init script to start
     55BitlBee automatically after a reboot. (This is where you realise using
     56a package from your distro would've been a better idea. :-P)
     57
     58Note that the BitlBee code is getting stable enough for daemon mode to be
     59useful. Some public servers use it, and it saves a lot of memory by serving
     60tens of users from a single process. One crash affects all users, but these
     61are becoming quite rare.
    4362
    4463
     
    88107versions of make, we'd love to hear it, but it seems this just isn't
    89108possible.
    90 
    91 
    92 RUNNING ON SERVERS WITH MANY USERS
    93 ==================================
    94 
    95 BitlBee is not yet bug-free. Sometimes a bug causes the program to get into
    96 an infinite loop. Something you really don't want on a public server,
    97 especially when that machine is also used for other (mission-critical) things.
    98 For now we can't do much about it. We haven't seen that happen for a long
    99 time already on our own machines, but some people still manage to get
    100 themselves in nasty situations we haven't seen before.
    101 
    102 For now the best we can offer against this problem is bitlbeed, which allows
    103 you to setrlimit() the child processes to use no more than a specified
    104 number of CPU seconds. Not the best solution (not really a solution anyway),
    105 but certainly trashing one busy daemon process is better than trashing your
    106 whole machine.
    107 
    108 We don't believe adding a limit for bitlbee to /etc/security/limits.conf will
    109 work, because that file is only read by PAM (ie just for real login users,
    110 not daemons).
    111 
    112 See utils/bitlbeed.c for more information about the program.
    113 
    114 Just a little note: Now that we reach version 1.0, this shouldn't be that
    115 much of an issue anymore. However, on a public server, especially if you
    116 also use it for other things, it can't hurt to protect yourself against
    117 possible problems.
    118109
    119110
  • doc/bitlbee.8

    r9730d72 r6738a67  
    4444
    4545\fBbitlbee\fP should be called by
    46 .BR inetd (8).
    47 (Or \fBbitlbeed\fP,
    48 if you can't run and/or configure \fBinetd\fP.) There is an experimental
    49 daemon mode too, in which BitlBee will serve all clients in one process
    50 (and does not require inetd), but this mode is still experimental.
    51 There are still some bugs left in BitlBee, and if they cause a crash,
    52 that would terminate the BitlBee connection for all clients.
     46.BR inetd (8),
     47or you can run it as a stand-alone daemon.
    5348.PP
    5449.SH OPTIONS
     
    6257Run in daemon mode. In this mode, BitlBee forks to the background and
    6358waits for new connections. All clients will be served from one process.
    64 This is still experimental. See the note above for more information.
    6559.IP "-F"
    6660Run in ForkDaemon mode. This is similar to ordinary daemon mode, but every
    67 client gets its own process. Easier to set up than inetd mode, but without
     61client gets its own process. Easier to set up than inetd mode, and without
    6862the possible stability issues.
    6963.IP "-i \fIaddress\fP"
  • doc/user-guide/Support.xml

    r9730d72 r6738a67  
    44
    55<sect1>
    6 <title>BitlBee is beta software</title>
     6<title>Disclaimer</title>
    77
    88<para>
    9 Although BitlBee has quite some functionality it is still beta. That means it
    10 can crash at any time, corrupt your data or whatever. Don't use it in
    11 any production environment and don't rely on it.
     9BitlBee doesn't come with a warranty and is still (and will probably always
     10be) under development. That means it can crash at any time, corrupt your
     11data or whatever. Don't use it in any production environment and don't rely
     12on it, or at least don't blame us if things blow up. :-)
    1213</para>
    1314
  • doc/user-guide/commands.xml

    r9730d72 r6738a67  
    163163
    164164                        <para>
    165                                 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.
    166                         </para>
    167                        
    168                         <para>
    169                                 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.
     165                                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.
    170166                        </para>
    171167                </description>
     
    532528
    533529        <bitlbee-setting name="charset" type="string" scope="global">
    534                 <default>iso8859-1</default>
     530                <default>utf-8</default>
    535531                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
    536532
    537533                <description>
    538534                        <para>
    539                                 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.
    540                         </para>
    541 
    542                         <para>
    543                                 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
     535                                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.
     536                        </para>
     537
     538                        <para>
     539                                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
    544540                        </para>
    545541                </description>
     
    804800        </bitlbee-setting>
    805801
     802        <bitlbee-setting name="root_nick" type="string" scope="global">
     803                <default>root</default>
     804
     805                <description>
     806                        <para>
     807                                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.
     808                        </para>
     809                </description>
     810        </bitlbee-setting>
     811
    806812        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
    807813                <default>true</default>
     
    888894                <description>
    889895                        <para>
    890                                 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. ;-)
     896                                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.
    891897                        </para>
    892898                </description>
     
    10571063                <short-description>Change friendly name, nick</short-description>
    10581064                <syntax>nick &lt;connection&gt; [&lt;new nick&gt;]</syntax>
    1059                 <syntax>nick</syntax>
    1060 
    1061                 <description>
    1062                         <para>
    1063                                 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.
    1064                         </para>
    1065 
    1066                         <para>
    1067                                 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.
     1065                <syntax>nick &lt;connection&gt;</syntax>
     1066
     1067                <description>
     1068                        <para>
     1069                                Deprecated: Use the per-account <emphasis>display_name</emphasis> setting to read and change this information.
    10681070                        </para>
    10691071                </description>
    10701072
    10711073                <ircexample>
    1072                         <ircline nick="wouter">nick 1 "Wouter Paesen"</ircline>
    1073                         <ircline nick="root">Setting your name on connection 1 to `Wouter Paesen'</ircline>
     1074                        <ircline nick="wouter">account set 1/display_name "The majestik møøse"</ircline>
     1075                        <ircline nick="root">display_name = `The majestik møøse'</ircline>
    10741076                </ircexample>
    10751077
  • doc/user-guide/misc.xml

    r9730d72 r6738a67  
    4747</variablelist>
    4848
    49 <para>
    50 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>.
    51 </para>
    52 
    5349</sect1>
    5450
     
    5652<title>Groupchats</title>
    5753<para>
    58 Since version 0.8x, BitlBee supports groupchats on the MSN and Yahoo! networks. This text will try to explain you how they work.
     54BitlBee now supports groupchats on all IM networks. This text will try to explain you how they work.
    5955</para>
    6056
     
    7369
    7470<para>
    75 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.
     71If 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.
    7672</para>
    7773
     
    8278<para>
    8379Some 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.
    84 </para>
    85 
    86 <para>
    87 This is all you'll probably need to know. If you have any problems, please read <emphasis>help groupchats3</emphasis>.
    88 </para>
    89 
    90 </sect1>
    91 
    92 <sect1 id="groupchats3">
    93 <title>Groupchat channel names</title>
    94 
    95 <para>
    96 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. :-)
    97 </para>
    98 
    99 <para>
    100 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.
    10180</para>
    10281
     
    121100        <member>On the phone, Phone, On phone</member>
    122101        <member>Out to lunch, Lunch, Food</member>
     102        <member>Invisible, Hidden</member>
    123103</simplelist>
    124104
     
    128108
    129109<para>
    130 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.
     110You 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.
    131111</para>
    132112
  • doc/user-guide/quickstart.xml

    r9730d72 r6738a67  
    6161
    6262<para>
    63 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.
     63Now 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.
    6464</para>
    6565
    6666<para>
    67 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.
     67BitlBee 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.
    6868</para>
    6969
     
    127127<ircexample>
    128128        <ircline nick="you">tux: hey, how's the weather down there?</ircline>
    129         <ircline nick="tux"> you: a bit chilly!</ircline>
     129        <ircline nick="tux">you: a bit chilly!</ircline>
    130130</ircexample>
    131131
    132132<para>
    133 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 &amp;bitlbee channel, use the <emphasis>set private</emphasis> command: <emphasis>set private true</emphasis> (<emphasis>set private false</emphasis> to change back).
     133Note that, although all contacts are in the &amp;bitlbee channel, only tux will actually receive this message. The &amp;bitlbee channel shouldn't be confused with a real IRC channel.
     134</para>
     135
     136<para>
     137If 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>.
    134138</para>
    135139
Note: See TracChangeset for help on using the changeset viewer.