Changeset 29ff5c2 for doc


Ignore:
Timestamp:
2015-11-21T00:01:50Z (9 years ago)
Author:
dequis <dx@…>
Parents:
e4f08bf (diff), 8fdeaa5 (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 branch 'master' into feat/hip-cat

Location:
doc
Files:
7 edited

Legend:

Unmodified
Added
Removed

  • doc/CHANGES

    re4f08bf r29ff5c2  
    33
    44https://github.com/bitlbee/bitlbee/commits/master
     5
     6Version 3.4.1:
     7- msn:
     8  * Upgraded protocol to MSNP21, works again (dx)
     9  * Contact list management, groupchats and skype username logins won't work.
     10    Next release!
     11- jabber:
     12  * Add "hipchat" protocol, for smoother login. Takes the same username as
     13    the official client. Note that unlike the 'hip-cat' branch, this doesn't
     14    preload channels. https://wiki.bitlbee.org/HowtoHipchat for details (dx)
     15  * Fixed a bug when receiving topics set by people who left the channel (dx)
     16  * Create fake users instead of showing "unknown participant" errors (dx)
     17  * Gmail mail notifications support (Artem Savkov)
     18  * Lowering xmpp presence priority on away (Artem Savkov)
     19- twitter:
     20  * Show quoted tweets/RTs with comment inline (wilmer)
     21  * Added "url" command, can be used to quote tweets (wilmer)
     22  * Make replies to self work (wilmer)
     23- Building documentation is now done with a python script (both 2.x/3.x work)
     24  Asciidoc/xsltproc/xmlto are no longer build dependencies (dx)
     25
     26Finished 16 Jun 2015
    527
    628Version 3.4:
    … …  
    407429  officially be treated as case sensitive.
    408430- Fully stripping spaces from AIM screennames, this didn't happen completely
    409   which severly breaks the IRC protocol.
     431  which severely breaks the IRC protocol.
    410432- Removed all the yellow tape around daemon mode, it's pretty mature by now:
    411433  testing.bitlbee.org serves all (~30) SSL users from one daemon mode
    … …  
    607629  some situations.
    608630- Outgoing MSN typing notifications are now understood correctly by the
    609   orignal MS Mac/Windows clients (again).
     631  original MS Mac/Windows clients (again).
    610632- Added "account add $protocol" to the documentation, got rid of a lot
    611633  of over-markup (i.e. overuse of bold-tags), reviewed some other parts.

  • doc/HACKING

    re4f08bf r29ff5c2  
    1414calls and arguments where that seemed useful, etc.
    1515
    16 However, up to late in the 1.2 series, the IRC core was still spread accross
     16However, up to late in the 1.2 series, the IRC core was still spread across
    1717several files, mostly irc.c + irc_commands.c and pieces and bits in
    1818nogaim.c. If you're looking for a textbook example of layer violation, start

  • doc/README

    re4f08bf r29ff5c2  
    88to set up the build system. If configure succeeds, run make to build BitlBee.
    99make install will move all the files to the right places.
     10
     11RUN MODES
     12=========
    1013
    1114--- (Fork)Daemon mode
    … …  
    8992==================
    9093
    91 Cygwin NOTE: You'll need a glib installation to run BitlBee. However, Cygwin
    92 doesn't provide a glib package. You can download a binary tar.gz from:
    93 <http://my.dreamwiz.com/jbdoll/>. When you installed it, BitlBee should work
    94 fine. You'll probably like bitlbeed or xinetd to get it running on the
    95 network.
    96 
    97 On some non-Linux systems the program still suffers from some random bugs.
    98 Please do report them, we might be able to fix them if they're not too
    99 mysterious.
    100 
    101 Also, the configure script is known to not work very well with non-Bash
    102 shells, so if you experience problems, make sure you use bash to run the
    103 script. Same for the Makefile, it only works well with GNU make. (gmake on
    104 most BSD systems)
     94The configure script is may not work very well with some non-bash shells (but
     95dash is supported), so if you experience problems, make sure you use bash to
     96run the script. Same for the Makefile, it only works well with GNU make. (gmake
     97on most BSD systems)
    10598
    10699If someone can tell us how to write Makefiles that work with both/all
    … …  
    153146=============================
    154147
    155 There used to be a note here about the simple obfuscation method used to
    156 make the passwords in the configuration files unreadable. However, BitlBee
    157 now uses a better format (and real encryption (salted MD5 and RC4)) to store
    158 the passwords. This means that people who somehow get their hands on your
    159 configuration files can't easily extract your passwords from them anymore.
     148BitlBee currently uses salted MD5 and RC4 to store the passwords. This means
     149that people who somehow get their hands on your configuration files can't
     150easily extract your passwords from them anymore.
    160151
    161152However, once you log into the BitlBee server and send your password, an
    162153intruder with tcpdump can still read your passwords. This can't really be
    163 avoided, of course. The new format is a lot more reliable (because it can't
    164 be cracked with just very basic crypto analysis anymore), but you still have
    165 to be careful. The main extra protection offered by the new format is that
    166 the files can only be cracked with some help from the user (by sending the
    167 password at login time).
    168 
    169 So if you run a public server, it's most important that you don't give root
    170 access to people who like to play with tcpdump. Also, it's a good idea to
    171 delete all *.nicks/*.accounts files as soon as BitlBee converted them to the
    172 new format (which happens as soon as the user logs in, it can't be done
    173 automatically because it needs the password for that account). You won't
    174 need them anymore (unless you want to switch back to an older BitlBee
    175 version) and they only make it easier for others to crack your passwords.
    176 
     154avoided, of course. So if you run a public server, it's most important that you
     155don't give root access to people who like to play with tcpdump.
    177156
    178157LEGAL
    … …  
    181160BitlBee is distributed under the GPL (GNU General Public License). See the
    182161file COPYING for this license.
    183 
    184 The MD5 algorithm code is licensed under the Aladdin license. This license
    185 can be found in the files, to which this applies. The SHA1 algorithm code
    186 is licensed under the Mozilla Public License, see http://www.mozilla.org/MPL/
    187 for details.
    188162
    189163The Yahoo! library used by BitlBee is libyahoo2 <http://libyahoo2.sf.net/>,

  • doc/user-guide/Installation.xml

    re4f08bf r29ff5c2  
    7373<para>
    7474By default, BitlBee runs as the user nobody. You might want
    75 to run it as a seperate user (some computers run named or apache as nobody).
     75to run it as a separate user (some computers run named or apache as nobody).
    7676</para>
    7777

  • doc/user-guide/commands.xml

    re4f08bf r29ff5c2  
    182182                               
    183183                                <para>
    184                                         For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
     184                                        For more information about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
    185185                                </para>
    186186                               
    … …  
    240240                               
    241241                                <para>
    242                                         For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
     242                                        For more information about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
    243243                                </para>
    244244                               
    … …  
    10931093                       
    10941094                        <para>
    1095                                 With modes "chat" and "many", you can send direct messages by /msg'ing your contacts directly. Note, however, that incoming DMs are not fetched yet.
     1095                                With modes "chat" and "many", you can send direct messages by /msg'ing your contacts directly. Incoming DMs are only fetched if the "stream" setting is on (default).
    10961096                        </para>
    10971097                       
    … …  
    11861186        </bitlbee-setting>
    11871187
     1188        <bitlbee-setting name="anonymous" type="boolean" scope="account">
     1189                <default>false</default>
     1190
     1191                <description>
     1192                        <para>
     1193                                This enables SASL ANONYMOUS login for jabber accounts, as specified by XEP-0175.
     1194                        </para>
     1195
     1196                        <para>
     1197                                With this setting enabled, if the server allows this method, a password isn't required and the username part of the JID is ignored (you can use anonymous@jabber.example.com). Servers will usually assign you a random numeric username instead.
     1198                        </para>
     1199                </description>
     1200
     1201        </bitlbee-setting>
     1202
    11881203        <bitlbee-setting name="ops" type="string" scope="global">
    11891204                <default>both</default>
    … …  
    13091324        </bitlbee-setting>
    13101325
     1326        <bitlbee-setting name="proxy" type="string" scope="account">
     1327                <default>&lt;local&gt;&lt;auto&gt;</default>
     1328
     1329                <description>
     1330                        <para>
     1331                                A list of <emphasis>file transfer proxies</emphasis> for jabber. This isn't the connection proxy. Sorry, look in bitlbee.conf for those.
     1332                        </para>
     1333
     1334                        <para>
     1335                                It's a semicolon-separated list of items that can be either <emphasis>JID,HOST,PORT</emphasis> or two special values, <emphasis>&lt;local&gt;</emphasis> (to try a direct connection first) and <emphasis>&lt;auto&gt;</emphasis> (to try to discover a proxy). For example, "&lt;local&gt;;proxy.somewhere.org,123.123.123.123,7777".
     1336                        </para>
     1337                        <para>
     1338                                The address should point to a SOCKS5 bytestreams server, usually provided by jabber servers. This is only used for sending files. Note that the host address might not match what DNS tells you, and the port isn't always the same.
     1339                        </para>
     1340                        <para>
     1341                                The correct way to get a socks proxy host/port is a mystery, and the file transfer might fail anyway. Maybe just try using dropbox instead.
     1342                        </para>
     1343                </description>
     1344        </bitlbee-setting>
     1345
    13111346        <bitlbee-setting name="query_order" type="string" scope="global">
    13121347                <default>lifo</default>
    … …  
    13691404        </bitlbee-setting>
    13701405
     1406        <bitlbee-setting name="self_messages" type="string" scope="global">
     1407                <default>true</default>
     1408                <possible-values>true, false, prefix, prefix_notice</possible-values>
     1409
     1410                <description>
     1411                        <para>
     1412                                Change this setting to customize how (or whether) to show self-messages, which are messages sent by yourself from other locations (for example, mobile clients), for IM protocols that support it.
     1413                        </para>
     1414
     1415                        <para>
     1416                                When this is set to "true", it will send those messages in the "standard" way, which is a PRIVMSG with source and target fields swapped.
     1417                        </para>
     1418                       
     1419                        <para>
     1420                                Since this isn't very well supported by some clients (the messages might appear in the wrong window), you can set it to "prefix" to show them as a normal message prefixed with "-> ", or use "prefix_notice" which is the same thing but with a NOTICE instead.
     1421                        </para>
     1422
     1423                        <para>
     1424                                You can also set it to "false" to disable these messages completely.
     1425                        </para>
     1426
     1427                        <para>
     1428                                This setting only applies to private messages. Self messages in groupchats are always shown, since they haven't caused issues in any clients so far.
     1429                        </para>
     1430                </description>
     1431        </bitlbee-setting>
     1432
    13711433        <bitlbee-setting name="server" type="string" scope="account">
    13721434                <description>
    … …  
    14021464
    14031465        <bitlbee-setting name="show_users" type="string" scope="channel">
    1404                 <default>online+,away</default>
     1466                <default>online+,special%,away</default>
    14051467
    14061468                <description>
    … …  
    14091471                                and any modes they should have. The following statuses are currently
    14101472                                recognised: <emphasis>online</emphasis> (i.e. available, not
    1411                                 away), <emphasis>away</emphasis>, and <emphasis>offline</emphasis>.
     1473                                away), <emphasis>special</emphasis>, <emphasis>away</emphasis>,
     1474                                and <emphasis>offline</emphasis>.
    14121475                        </para>
    14131476                       
    … …  
    14151478                                If a status is followed by a valid channel mode character
    14161479                                (@, % or +), it will be given to users with that status.
    1417                                 For example, <emphasis>online@,away+,offline</emphasis> will
    1418                                 show all users in the channel. Online people will
     1480                                For example, <emphasis>online@,special%,away+,offline</emphasis>
     1481                                will show all users in the channel. Online people will
    14191482                                have +o, people who are online but away will have +v,
    14201483                                and others will have no special modes.
    … …  
    18761939
    18771940                        <description>
    1878                                 <para>Rejects all incoming (not already transferring) file transfers. Since you probably have only one incoming transfer at a time, no id is neccessary. Or is it?</para>
     1941                                <para>Rejects all incoming (not already transferring) file transfers. Since you probably have only one incoming transfer at a time, no id is necessary. Or is it?</para>
    18791942                        </description>
    18801943

  • doc/user-guide/misc.xml

    re4f08bf r29ff5c2  
    9090
    9191<para>
    92 Away states have different names accross different protocols. BitlBee will try to pick the best available option for every connection:
     92Away states have different names across different protocols. BitlBee will try to pick the best available option for every connection:
    9393</para>
    9494
    … …  
    146146
    147147<para>
    148 Control channels are where you see your contacts. By default, you will have one control channel called &amp;bitlbee, containing all your contacts. But you can create more, if you want, and divide your contact list accross several channels.
     148Control channels are where you see your contacts. By default, you will have one control channel called &amp;bitlbee, containing all your contacts. But you can create more, if you want, and divide your contact list across several channels.
    149149</para>
    150150
    … …  
    433433</sect1>
    434434
     435<sect1 id="whatsnew030401">
     436<title>New stuff in BitlBee 3.4.1</title>
     437
     438<simplelist>
     439        <member><emphasis>msn:</emphasis> Upgraded protocol version to MSNP21, works again</member>
     440        <member><emphasis>jabber:</emphasis> Add "hipchat" protocol, for smoother login. Takes the same username as the official client. Note that unlike the 'hip-cat' branch, this doesn't preload channels. See the <emphasis>HowtoHipchat</emphasis> wiki page for details</member>
     441        <member><emphasis>jabber:</emphasis> Gmail notifications support</member>
     442        <member><emphasis>twitter:</emphasis> Show quoted tweets inline. Added "url" command, can be used to quote tweets.</member>
     443</simplelist>
     444
     445</sect1>
     446
    435447</chapter>

  • doc/user-guide/quickstart.xml

    re4f08bf r29ff5c2  
    1111
    1212<para>
    13 You need register so that all your IM settings (passwords, contacts, etc) can be saved on the BitlBee server. It's important that you pick a good password so no one else can access your account. Register with this password using the <emphasis>register</emphasis> command: <emphasis>register &lt;password&gt;</emphasis> (without the brackets!).
     13You need to register so that all your IM settings (passwords, contacts, etc) can be saved on the BitlBee server. It's important that you pick a good password so no one else can access your account. Register with this password using the <emphasis>register</emphasis> command: <emphasis>register &lt;password&gt;</emphasis> (without the brackets!).
    1414</para>
    1515
Note: See TracChangeset for help on using the changeset viewer.