Changeset b79308b for doc


Ignore:
Timestamp:
2008-04-14T13:10:53Z (17 years ago)
Author:
ulim <a.sporto+bee@…>
Branches:
master
Children:
0cab388
Parents:
6cac643 (diff), aa31117 (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:

merged in upstream r379 (somewhere after 1.2-3).
Just one trivial conflict in the jabber Makefile, went smoothly.

Location:
doc
Files:
6 edited

Legend:

Unmodified
Added
Removed

  • doc/CHANGES

    r6cac643 rb79308b  
     1Version 1.2.1:
     2- Fixed proxy support.
     3- Fixed stalling issues while connecting to Jabber when using the OpenSSL
     4  module.
     5- Fixed problem with GLib and ForkDaemon where processes didn't die when
     6  the client disconnects.
     7- Fixed handling of "set charset none". (Which pretty much breaks the account
     8  completely in 1.2.)
     9- You can now automatically identify yourself to BitlBee by setting a server
     10  password in your IRC client.
     11- Compatible with all crazy kinds of line endings that clients can send.
     12
     13Finished ...
     14
    115Version 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.
    516- Added ForkDaemon mode next to the existing Daemon- and inetd modes. With
    617  ForkDaemon you can run BitlBee as a stand-alone daemon and every connection
    … …  
    2132  1.x is so old that supporting it really isn't necessary anymore.
    2233- 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.
     34  I/O as much as possible, replaced the Gaim (0.59, IOW heavily outdated)
     35  API, fixed lots of little bugs (including bugs that affected daemon mode
     36  stability). See the bzr logs for more information.
     37- One of the user-visible changes from the API change: You can finally see
     38  all away states/messages properly.
     39- Added units tests. Test coverage is very minimal for now.
     40- Better charset handling: Everything is just converted from/to UTF-8 right
     41  in the IRC core, and charset mismatches are detected (if possible) and the
     42  user is asked to resolve this before continuing. Also, UTF-8 is the default
     43  setting now, since that's how the world seems to work these days.
     44- One can now keep hashed passwords in bitlbee.conf instead of the cleartext
     45  version.
    2646- Most important change: New file format for user data (accounts, nicks and
    2747  settings). Migration to the new format should happen transparently,
    … …  
    6989  * An XML console (add xmlconsole to your contact list or see "help set
    7090    xmlconsole" if you want it permanently).
    71 
    72 Finished ???
     91- The Yahoo! module now says it supports YMSG protocol version 12, which will
     92  hopefully keep the Yahoo module working after 2008-04-02 (when Yahoo! is
     93  dropping support for version 6.x of their client).
     94- MSN switchboard handling changes. Hopefully less messages will get lost now,
     95  although things are still not perfect.
     96
     97Finished 17 Mar 2008
    7398
    7499Version 1.0.4:

  • doc/README

    r6cac643 rb79308b  
    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)
    4357
    4458

  • doc/user-guide/Support.xml

    r6cac643 rb79308b  
    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

    r6cac643 rb79308b  
    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>
    … …  
    383379
    384380        <bitlbee-setting name="charset" type="string" scope="global">
    385                 <default>iso8859-1</default>
     381                <default>utf-8</default>
    386382                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
    387383
    388384                <description>
    389385                        <para>
    390                                 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.
    391                         </para>
    392 
    393                         <para>
    394                                 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
     386                                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.
     387                        </para>
     388
     389                        <para>
     390                                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
    395391                        </para>
    396392                </description>
    … …  
    593589        </bitlbee-setting>
    594590
     591        <bitlbee-setting name="root_nick" type="string" scope="global">
     592                <default>root</default>
     593
     594                <description>
     595                        <para>
     596                                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.
     597                        </para>
     598                </description>
     599        </bitlbee-setting>
     600
    595601        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
    596602                <default>true</default>
    … …  
    677683                <description>
    678684                        <para>
    679                                 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. ;-)
     685                                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.
    680686                        </para>
    681687                </description>
    … …  
    830836                <short-description>Change friendly name, nick</short-description>
    831837                <syntax>nick &lt;connection&gt; [&lt;new nick&gt;]</syntax>
    832                 <syntax>nick</syntax>
    833 
    834                 <description>
    835                         <para>
    836                                 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.
    837                         </para>
    838 
    839                         <para>
    840                                 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.
     838                <syntax>nick &lt;connection&gt;</syntax>
     839
     840                <description>
     841                        <para>
     842                                Deprecated: Use the per-account <emphasis>display_name</emphasis> setting to read and change this information.
    841843                        </para>
    842844                </description>
    843845
    844846                <ircexample>
    845                         <ircline nick="wouter">nick 1 "Wouter Paesen"</ircline>
    846                         <ircline nick="root">Setting your name on connection 1 to `Wouter Paesen'</ircline>
     847                        <ircline nick="wouter">account set 1/display_name "The majestik møøse"</ircline>
     848                        <ircline nick="root">display_name = `The majestik møøse'</ircline>
    847849                </ircexample>
    848850

  • doc/user-guide/misc.xml

    r6cac643 rb79308b  
    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

    r6cac643 rb79308b  
    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.