- Timestamp:
- 2008-04-02T14:22:57Z (16 years ago)
- Branches:
- master
- Children:
- f9dbc99
- Parents:
- 875ad42 (diff), dd34575 (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. - Location:
- doc
- Files:
-
- 1 added
- 11 edited
-
CHANGES (modified) (1 diff)
-
CREDITS (modified) (1 diff)
-
README (modified) (5 diffs)
-
bitlbee.8 (modified) (1 diff)
-
bitlbee.schema (added)
-
user-guide/Makefile (modified) (1 diff)
-
user-guide/Support.xml (modified) (1 diff)
-
user-guide/commands.xml (modified) (15 diffs)
-
user-guide/docbook.xsl (modified) (1 diff)
-
user-guide/help.xsl (modified) (4 diffs)
-
user-guide/misc.xml (modified) (6 diffs)
-
user-guide/quickstart.xml (modified) (3 diffs)
Legend:
- Unmodified
- Added
- Removed
-
doc/CHANGES
r875ad42 r85d7b85 1 Version 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 13 Finished ... 14 15 Version 1.2: 16 - Added ForkDaemon mode next to the existing Daemon- and inetd modes. With 17 ForkDaemon you can run BitlBee as a stand-alone daemon and every connection 18 will run in its own process. No more need to configure inetd, and still you 19 don't get the stability problems BitlBee unfortunately still has in ordinary 20 (one-process) daemon mode. 21 - Added inter-process/connection communication. This made it possible to 22 implement some IRC operator features like WALLOPs, KILL, DIE, REHASH and 23 more. 24 - Added hooks for using libevent instead of GLib for event handling. This 25 should improve scalability, although this won't really be useful yet because 26 the one-process daemon mode is not reliable enough. 27 - BitlBee now makes the buddy quits when doing "account off" look like a 28 netsplit. Modern IRC clients show this in a different, more compact way. 29 (This can be disabled if your client doesn't support this.) 30 - GLib 1.x compatibility was dropped. BitlBee now requires GLib 2.4 or newer. 31 This allows us to use more GLib features (like the XML parser). By now GLib 32 1.x is so old that supporting it really isn't necessary anymore. 33 - Many, many, MANY little changes, improvements, fixes. Using non-blocking 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. 46 - Most important change: New file format for user data (accounts, nicks and 47 settings). Migration to the new format should happen transparently, 48 BitlBee will read the old files and once you quit/save it will save in the 49 new format. It is recommended to delete the old files (BitlBee doesn't do 50 this automatically, it will just ignore them) since they won't be used 51 anymore (and since the old file format is a security risk). Some advantages 52 of this file format switch: 53 * Safer format, since the identify-password is now salted before generating 54 a checksum. This way one can't use MD5 reverse lookup databases to crack 55 passwords. Also, the IM-account passwords are encrypted using RC4 instead 56 of the simple obfuscation scheme which BitlBee used so far. 57 * Easier to extend than the previous format (at least the .nicks format was 58 horribly limited). 59 * Nicknames for buddies are now saved per-account instead of per-protocol. 60 So far having one buddy on multiple accounts of the same protocol was a 61 problem because the nicks generated for the two "instances" of this buddy 62 were very unpredictable. 63 NOTE: This also means that "account del" removes not just the account, 64 BUT ALSO ALL NICKNAMES! If you're changing IM accounts and don't want to 65 lose the nicknames, you can now use "account set" to change the username 66 and password for the existing connection. 67 * Per-account settings (see the new "account set" command). 68 - A brand new Jabber module. Besides the major code cleanup, it also has 69 has these new features: 70 * Pretty complete XMPP support: RFC3920, RFC3921 plus a number of XEPs 71 including XEP45, XEP73 and XEP85. (See http://www.xmpp.org/ for what all 72 these things mean exactly.) Privacy lists are not supported for obvious 73 reasons. 74 * This complete support also includes TLS and SASL support and SRV record 75 lookup. This means that specifying a server tag for connections should 76 (almost) never be necessary anymore, BitlBee can find the server and can 77 automatically convert plaintext connections to TLS-encrypted ones. 78 * XEP45: Jabber chatroom support! 79 * XEP85 means typing notifications. The older XEP22 (still used by some 80 clients including Gaim <2.0) is not supported. 81 * Better handling of buddies who have more than one resource on-line. As 82 long as one resource is on-line (and visible), BitlBee will show this. 83 (The previous module didn't keep track of resources and sent an offline 84 event as soon as any resource disappears.) 85 * You can now set your resource priority. 86 * The info command now gives away state/message information for all 87 resources available for that buddy. (Of course this only works if the 88 buddy is in your contact list.) 89 * An XML console (add xmlconsole to your contact list or see "help set 90 xmlconsole" if you want it permanently). 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 97 Finished 17 Mar 2008 98 99 Version 1.0.4: 100 - Removed sethostent(), which causes problems for many people, especially on 101 *BSD. This is basically the reason for this release. 102 - "allow" command actually displays the allow list, not the block list. 103 - Yahoo away state/msg fix. 104 - Don't display "Gender: Male" by default if nothing's filled in (OSCAR 105 "info" command) 106 - Fixed account cleanup (possible infinite loop) in irc_free(). 107 - Fixed configdir error message to not always display the compile-time 108 setting. 109 110 Finished 20 Aug 2007 111 112 Version 1.0.3: 113 - Fixed ugliness in block/allow list commands (still not perfect though, the 114 list is empty or not up-to-date for most protocols). 115 - OSCAR module doesn't send the ICQ web-aware flag anymore, which seems to 116 get rid of a lot of ICQ spam. 117 - added show_got_added(), BitlBee asks you, after authorizing someone, if you 118 want to add him/her to your list too. 119 - add -tmp, mainly convenient if you want to talk to people who are not in 120 your list. 121 - Fixed ISON command, should work better with irssi now. 122 - Fixed compilation with tcc. 123 - Fixed xinetd-file. 124 - Misc. (crash)bug fixes, including one in the root command parsing that 125 caused mysterious error messages sometimes. 126 127 Finished 24 Jun 2006 (Happy 4th birthday, BitlBee!) 128 129 Version 1.0.2: 130 - Pieces of code cleanup, fixes for possible problems in error checking. 131 - Fixed an auto-reconnect cleanup problem that caused crashes in daemon mode. 132 - /AWAY in daemon mode now doesn't set the away state for every connection 133 anymore. 134 - Fixed a crash-bug on empty help subjects. 135 - Jabber now correctly sets the current away state when connecting. 136 - Added Invisible and Hidden to the away state alias list, invisible mode 137 should be pretty usable now. 138 - Fixed handling of iconv(): It's now done for everything that goes between 139 BitlBee and the IRC client, instead of doing it (almost) every time 140 something goes to or come from the IM-modules. Should've thought about 141 that before. :-) 142 - When cleaning up MSN switchboards with unsent msgs, it now also says which 143 contact those messages were meant for. 144 - You can now use the block and allow commands to see your current block/ 145 allow list. 146 147 Finished 1 Apr 2006 148 149 Version 1.0.1: 150 - Support for AIM groupchats. 151 - Improved typing notification support for at least AIM. 152 - BitlBee sends a 005 reply when logging in, this informs modern IRC clients 153 of some of BitlBee's capabilities. This might also solve problems some 154 people were having with the new control channel name. 155 - MSN switchboards are now properly reset when talking to a person who is 156 offline. This fixes problems with messages to MSN people that sometimes 157 didn't arrive. 158 - Fixed one of the problems that made BitlBee show online Jabber people as 159 offline. 160 - Fixed problems with commas in MSN passwords. 161 - Added some consts for read-only data, which should make the BitlBee per- 162 process memory footprint a bit smaller. 163 - Other bits of code cleanup. 164 165 Finished 14 Jan 2006 166 1 167 Version 1.0: 2 168 - Removed some crashy debugging code. -
doc/CREDITS
r875ad42 r85d7b85 50 50 - Frank Thieme, for the info-command enhancements and other patches. 51 51 - Marcus Dennis, for some bitlbeed enhancements. 52 - 1nfamus, for security auditing BitlBee code.52 - infamous41md, for security auditing BitlBee code. 53 53 - Tijmen Ruizendaal, for some useful BitlBee-related irssi scripts. 54 54 - Ed Schouten, for reporting bugs. 55 - Greg (gropeep.org), for updating the Yahoo! module to fix some issues 56 that were there for quite some time already. 57 - misc@mandriva.org for lots of Jabber contributions. 55 58 56 59 - And all other users who help us by sending useful bug reports, positive -
doc/README
r875ad42 r85d7b85 42 42 directory is read-/writable by this user only. 43 43 44 --- (Fork)Daemon mode 45 46 If you don't want to run any inetd daemon, you can run BitlBee in Daemon 47 mode. Right now, daemon mode may be a bad idea on servers with multiple 48 users, since possible fatal BitlBee bugs will crash the BitlBee process and 49 disconnect all connected users at once. Instead, you can use ForkDaemon 50 mode, which serves every user from a separate process, without depending on 51 an inetd daemon. 52 53 To use BitlBee in daemon mode, just start it with the right flags or enable 54 it in bitlbee.conf. You probably want to write an init script to start 55 BitlBee automatically after a reboot. (This is where you realise using 56 a package from your distro would've been a better idea. :-P) 57 44 58 45 59 DEPENDENCIES … … 47 61 48 62 BitlBee's only real dependency is GLib. This is available on virtually every 49 platform. Any recent version of GLib ( including 1.x versions) will work.63 platform. Any recent version of GLib (2.4 or higher) will work. 50 64 51 65 These days, MSN Messenger clients have to connect to the MS Passport servers … … 155 169 ==================== 156 170 157 BitlBee stores the accounts and settings (not your contact list though) in 158 some sort of encrypted/obfuscated format. 159 160 *** THIS IS NOT A SAFE FORMAT! *** 161 162 You should still make sure the rights to the configuration directory and 163 files are set so that only root and the BitlBee user can read/write them. 164 165 This format is not to prevent malicicous users from running with your 166 passwords, but to prevent accidental glimpses of the administrators to cause 167 any harm. You have no choice but to trust root though. 171 There used to be a note here about the simple obfuscation method used to 172 make the passwords in the configuration files unreadable. However, BitlBee 173 now uses a better format (and real encryption (salted MD5 and RC4)) to store 174 the passwords. This means that people who somehow get their hands on your 175 configuration files can't easily extract your passwords from them anymore. 176 177 However, once you log into the BitlBee server and send your password, an 178 intruder with tcpdump can still read your passwords. This can't really be 179 avoided, of course. The new format is a lot more reliable (because it can't 180 be cracked with just very basic crypto analysis anymore), but you still have 181 to be careful. The main extra protection offered by the new format is that 182 the files can only be cracked with some help from the user (by sending the 183 password at login time). 184 185 So if you run a public server, it's most important that you don't give root 186 access to people who like to play with tcpdump. Also, it's a good idea to 187 delete all *.nicks/*.accounts files as soon as BitlBee converted them to the 188 new format (which happens as soon as the user logs in, it can't be done 189 automatically because it needs the password for that account). You won't 190 need them anymore (unless you want to switch back to an older BitlBee 191 version) and they only make it easier for others to crack your passwords. 168 192 169 193 … … 174 198 file COPYING for this license. 175 199 176 Unfortunately some parts of the Gaim Jabber plugin (most notably the XML 177 code) were licensed under the MPL (Mozilla Public License) version 1.1. We 178 could not relicense this code under the GPL. As such it is still licensed 179 under the MPL. The parts of the code to which this applies are marked as 180 such. 181 182 The MPL is provided in the file MPL-1.1.txt. This license is not GPL 183 compatible. It is however a free software license. 184 185 Another part (the md5 algorithm) is licensed under the Aladdin license. 186 This license can be found in the files, to which this applies. 200 The MD5 algorithm code is licensed under the Aladdin license. This license 201 can be found in the files, to which this applies. The SHA1 algorithm code 202 is licensed under the Mozilla Public License, see http://www.mozilla.org/MPL/ 203 for details. 187 204 188 205 The Yahoo! library used by BitlBee is libyahoo2 <http://libyahoo2.sf.net/>, … … 192 209 BitlBee - An IRC to other chat networks gateway 193 210 <http://www.bitlbee.org/> 194 Copyright (C) 2002-200 5Wilmer van der Gaast <wilmer@gaast.net>211 Copyright (C) 2002-2007 Wilmer van der Gaast <wilmer@gaast.net> 195 212 and others -
doc/bitlbee.8
r875ad42 r85d7b85 63 63 waits for new connections. All clients will be served from one process. 64 64 This is still experimental. See the note above for more information. 65 .IP "-F" 66 Run 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 68 the possible stability issues. 65 69 .IP "-i \fIaddress\fP" 66 70 Only useful when running in daemon mode, to specify the network interface -
doc/user-guide/Makefile
r875ad42 r85d7b85 28 28 xsltproc --xinclude --output $@ docbook.xsl $< 29 29 30 help.txt: help.xml help.xsl 30 help.txt: help.xml help.xsl commands.xml misc.xml quickstart.xml 31 31 xsltproc --stringparam extraparanewline "$(EXTRAPARANEWLINE)" --xinclude help.xsl $< | perl -0077 -pe 's/\n\n%/\n%/s; s/_b_/\002/g;' > $@ 32 32 -
doc/user-guide/Support.xml
r875ad42 r85d7b85 4 4 5 5 <sect1> 6 <title> BitlBee is beta software</title>6 <title>Disclaimer</title> 7 7 8 8 <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. 9 BitlBee doesn't come with a warranty and is still (and will probably always 10 be) under development. That means it can crash at any time, corrupt your 11 data or whatever. Don't use it in any production environment and don't rely 12 on it, or at least don't blame us if things blow up. :-) 12 13 </para> 13 14 -
doc/user-guide/commands.xml
r875ad42 r85d7b85 11 11 12 12 <para> 13 Available actions: add, del, list, on, off . See <emphasis>help account <action></emphasis> for more information.13 Available actions: add, del, list, on, off and set. See <emphasis>help account <action></emphasis> for more information. 14 14 </para> 15 15 … … 17 17 18 18 <bitlbee-command name="add"> 19 <syntax>account add <protocol> <username> <password> [<server>]</syntax>19 <syntax>account add <protocol> <username> <password></syntax> 20 20 21 21 <description> … … 26 26 27 27 <bitlbee-command name="jabber"> 28 <syntax>account add jabber <handle > <password> [<servertag>]</syntax>28 <syntax>account add jabber <handle@server.tld> <password></syntax> 29 29 30 30 <description> 31 31 <para> 32 Note that the servertag argument is optional. You only have to use it if the part after the @ in your handle isn't the hostname of your Jabber server, or if you want to use SSL/connect to a non-standard port number. The format is simple: [<servername>[:<portnumber>][:ssl]]. For example, this is how you can connect to Google Talk:32 The handle should be a full handle, including the domain name. You can specify a servername if necessary. Normally BitlBee doesn't need this though, since it's able to find out the server by doing DNS SRV lookups. 33 33 </para> 34 </description> 35 36 <ircexample> 37 <ircline nick="wilmer">account add jabber example@gmail.com hobbelmeeuw talk.google.com:5223:ssl</ircline> 38 <ircline nick="root">Account successfully added</ircline> 39 </ircexample> 40 41 <description> 34 42 35 <para> 43 Note that Google talk is SSL-only, but officially reachable over both port 5222 and 5223. However, for some people only port 5222 works, for some people only 5223. This is something you'll have to try out.36 In previous versions it was also possible to specify port numbers and/or SSL in the server tag. This is deprecated and should now be done using the <emphasis>account set</emphasis> command. This also applies to specifying a resource in the handle (like <emphasis>wilmer@bitlbee.org/work</emphasis>). 44 37 </para> 45 38 </description> … … 47 40 48 41 <bitlbee-command name="msn"> 49 <syntax>account add msn <handle > <password></syntax>42 <syntax>account add msn <handle@server.tld> <password></syntax> 50 43 51 44 <description> … … 57 50 58 51 <bitlbee-command name="oscar"> 59 <syntax>account add oscar <handle> <password> [<servername>]</syntax>52 <syntax>account add oscar <handle> <password></syntax> 60 53 61 54 <description> 62 55 <para> 63 Specifying a server is required for OSCAR, since OSCAR can be used for both ICQ- and AIM-connections. Although these days it's supposed to be possible to connect to ICQ via AIM-servers and vice versa, we like to stick with this separation for now. For ICQ connections, the servername is <emphasis>login.icq.com</emphasis>, for AIM connections it's <emphasis>login.oscar.aol.com</emphasis>.56 OSCAR is the protocol used to connect to AIM and/or ICQ. The servers will automatically detect if you're using a numeric or non-numeric username so there's no need to tell which network you want to connect to. 64 57 </para> 65 58 </description> 66 59 67 60 <ircexample> 68 <ircline nick="wilmer">account add oscar 72696705 hobbelmeeuw login.icq.com</ircline>61 <ircline nick="wilmer">account add oscar 72696705 hobbelmeeuw</ircline> 69 62 <ircline nick="root">Account successfully added</ircline> 70 63 </ircexample> … … 103 96 <description> 104 97 <para> 105 This command will try to log into the specified account. If no account is specified, BitlBee will log into all the accounts . (Including accounts awaiting a reconnection)98 This command will try to log into the specified account. If no account is specified, BitlBee will log into all the accounts that have the auto_connect flag set. 106 99 </para> 107 100 … … 118 111 <description> 119 112 <para> 120 This command disconnects the connection for the specified account. If no account is specified, BitlBee will deactivate all active accounts . (Including accounts awaiting a reconnection)113 This command disconnects the connection for the specified account. If no account is specified, BitlBee will deactivate all active accounts and cancel all pending reconnects. 121 114 </para> 122 115 … … 133 126 <para> 134 127 This command gives you a list of all the accounts known by BitlBee, including the numbers you'll need for most account commands. 128 </para> 129 </description> 130 </bitlbee-command> 131 132 <bitlbee-command name="set"> 133 <syntax>account set <account id></syntax> 134 <syntax>account set <account id>/<setting></syntax> 135 <syntax>account set <account id>/<setting> <value></syntax> 136 <syntax>account set -del <account id>/<setting></syntax> 137 138 <description> 139 <para> 140 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>. 141 </para> 142 143 <para> 144 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>. 145 </para> 146 147 <para> 148 The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection. 135 149 </para> 136 150 </description> … … 149 163 150 164 <para> 151 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. 152 </para> 153 154 <para> 155 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. 156 166 </para> 157 167 </description> … … 233 243 <bitlbee-command name="set"> 234 244 <short-description>Miscellaneous settings</short-description> 235 <syntax>set [<variable> [<value>]]</syntax> 236 237 <description> 238 239 <para> 240 Without any arguments, this command lists all the set variables. You can also specify a single argument, a variable name, to get that variable's value. To change this value, specify the new value as the second argument. 245 <syntax>set</syntax> 246 <syntax>set <variable></syntax> 247 <syntax>set <variable> <value></syntax> 248 <syntax>set -del <variable></syntax> 249 250 <description> 251 252 <para> 253 Without any arguments, this command lists all the set variables. You can also specify a single argument, a variable name, to get that variable's value. To change this value, specify the new value as the second argument. With <emphasis>-del</emphasis> you can reset a setting to its default value. 241 254 </para> 242 255 … … 276 289 </bitlbee-command> 277 290 278 <bitlbee-setting name="charset" type="string"> 279 <default>iso8859-1</default> 291 <bitlbee-setting name="auto_connect" type="boolean" scope="both"> 292 <default>true</default> 293 294 <description> 295 <para> 296 With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this. 297 </para> 298 299 <para> 300 This setting can also be changed for specific accounts using the <emphasis>account set</emphasis> command. (However, these values will be ignored if the global <emphasis>auto_connect</emphasis> setting is disabled!) 301 </para> 302 </description> 303 </bitlbee-setting> 304 305 <bitlbee-setting name="auto_reconnect" type="boolean" scope="both"> 306 <default>false</default> 307 308 <description> 309 <para> 310 If an IM-connections breaks, you're supposed to bring it back up yourself. Having BitlBee do this automatically might not always be a good idea, for several reasons. If you want the connections to be restored automatically, you can enable this setting. 311 </para> 312 313 <para> 314 See also the <emphasis>auto_reconnect_delay</emphasis> setting. 315 </para> 316 317 <para> 318 This setting can also be changed for specific accounts using the <emphasis>account set</emphasis> command. (However, these values will be ignored if the global <emphasis>auto_reconnect</emphasis> setting is disabled!) 319 </para> 320 </description> 321 </bitlbee-setting> 322 323 <bitlbee-setting name="auto_reconnect_delay" type="integer" scope="global"> 324 <default>300</default> 325 326 <description> 327 <para> 328 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. 329 </para> 330 331 <para> 332 See also the <emphasis>auto_reconnect</emphasis> setting. 333 </para> 334 </description> 335 </bitlbee-setting> 336 337 <bitlbee-setting name="away_devoice" type="boolean" scope="global"> 338 <default>true</default> 339 340 <description> 341 <para> 342 With this option enabled, the root user devoices people when they go away (just away, not offline) and gives the voice back when they come back. You might dislike the voice-floods you'll get if your contact list is huge, so this option can be disabled. 343 </para> 344 </description> 345 </bitlbee-setting> 346 347 <bitlbee-setting name="buddy_sendbuffer" type="boolean" scope="global"> 348 <default>false</default> 349 350 <description> 351 <para> 352 By default, when you send a message to someone, BitlBee forwards this message to the user immediately. When you paste a large number of lines, the lines will be sent in separate messages, which might not be very nice to read. If you enable this setting, BitlBee will buffer your messages and wait for more data. 353 </para> 354 355 <para> 356 Using the <emphasis>buddy_sendbuffer_delay</emphasis> setting you can specify the number of seconds BitlBee should wait for more data before the complete message is sent. 357 </para> 358 359 <para> 360 Please note that if you remove a buddy from your list (or if the connection to that user drops) and there's still data in the buffer, this data will be lost. BitlBee will not try to send the message to the user in those cases. 361 </para> 362 </description> 363 </bitlbee-setting> 364 365 <bitlbee-setting name="buddy_sendbuffer_delay" type="integer" scope="global"> 366 <default>200</default> 367 368 <description> 369 370 <para> 371 Tell BitlBee after how many (mili)seconds a buffered message should be sent. Values greater than 5 will be interpreted as miliseconds, 5 and lower as seconds. 372 </para> 373 374 <para> 375 See also the <emphasis>buddy_sendbuffer</emphasis> setting. 376 </para> 377 </description> 378 </bitlbee-setting> 379 380 <bitlbee-setting name="charset" type="string" scope="global"> 381 <default>utf-8</default> 280 382 <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values> 281 383 282 384 <description> 283 385 <para> 284 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. 285 </para> 286 287 <para> 288 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 289 </para> 290 </description> 291 292 </bitlbee-setting> 293 294 <bitlbee-setting name="private" type="boolean"> 295 <default>True</default> 296 297 <description> 298 299 <para> 300 If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel. 301 </para> 302 303 <para> 304 This setting is remembered (during one session) per-user, this setting only changes the default state. This option takes effect as soon as you reconnect. 305 </para> 306 </description> 307 </bitlbee-setting> 308 309 <bitlbee-setting name="save_on_quit" type="boolean"> 310 <default>True</default> 311 312 <description> 313 <para> 314 If enabled causes BitlBee to save all current settings and account details when user disconnects. This is enabled by default, and these days there's not really a reason to have it disabled anymore. 315 </para> 316 </description> 317 </bitlbee-setting> 318 319 <bitlbee-setting name="strip_html" type="boolean"> 320 <default>True</default> 321 322 <description> 323 <para> 324 Determines what BitlBee should do with HTML in messages. Normally this is turned on and HTML will be stripped from messages, if BitlBee thinks there is HTML. 325 </para> 326 <para> 327 If BitlBee fails to detect this sometimes (most likely in AIM messages over an ICQ connection), you can set this setting to <emphasis>always</emphasis>, but this might sometimes accidentally strip non-HTML things too. 328 </para> 329 </description> 330 </bitlbee-setting> 331 332 <bitlbee-setting name="debug" type="boolean"> 333 <default>False</default> 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 391 </para> 392 </description> 393 394 </bitlbee-setting> 395 396 <bitlbee-setting name="debug" type="boolean" scope="global"> 397 <default>false</default> 334 398 335 399 <description> … … 340 404 </bitlbee-setting> 341 405 342 <bitlbee-setting name="to_char" type="string"> 343 <default>": "</default> 344 345 <description> 346 347 <para> 348 It's customary that messages meant for one specific person on an IRC channel are prepended by his/her alias followed by a colon ':'. BitlBee does this by default. If you prefer a different character, you can set it using <emphasis>set to_char</emphasis>. 349 </para> 350 351 <para> 352 Please note that this setting is only used for incoming messages. For outgoing messages you can use ':' (colon) or ',' to separate the destination nick from the message, and this is not configurable. 353 </para> 354 </description> 355 </bitlbee-setting> 356 357 <bitlbee-setting name="typing_notice" type="boolean"> 358 <default>False</default> 359 360 <description> 361 <para> 362 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. ;-) 363 </para> 364 </description> 365 </bitlbee-setting> 366 367 <bitlbee-setting name="ops" type="string"> 368 <default>both</default> 369 <possible-values>both, root, user, none</possible-values> 370 371 <description> 372 <para> 373 Some people prefer themself and root to have operator status in &bitlbee, other people don't. You can change these states using this setting. 374 </para> 375 376 <para> 377 The value "both" means both user and root get ops. "root" means, well, just root. "user" means just the user. "none" means nobody will get operator status. 378 </para> 379 </description> 380 </bitlbee-setting> 381 382 <bitlbee-setting name="away_devoice" type="boolean"> 383 <default>True</default> 384 385 <description> 386 <para> 387 With this option enabled, the root user devoices people when they go away (just away, not offline) and gives the voice back when they come back. You might dislike the voice-floods you'll get if your contact list is huge, so this option can be disabled. 388 </para> 389 </description> 390 </bitlbee-setting> 391 392 <bitlbee-setting name="handle_unknown" type="string"> 406 <bitlbee-setting name="default_target" type="string" scope="global"> 407 <default>root</default> 408 <possible-values>root, last</possible-values> 409 410 <description> 411 <para> 412 With this value set to <emphasis>root</emphasis>, lines written in the control channel without any nickname in front of them will be interpreted as commands. If you want BitlBee to send those lines to the last person you addressed in the control channel, set this to <emphasis>last</emphasis>. 413 </para> 414 </description> 415 </bitlbee-setting> 416 417 <bitlbee-setting name="display_name" type="string" scope="account"> 418 <description> 419 <para> 420 Currently only available for MSN connections. This setting allows you to read and change your "friendly name" for this connection. Since this is a server-side setting, it can't be changed when the account is off-line. 421 </para> 422 </description> 423 </bitlbee-setting> 424 425 <bitlbee-setting name="display_namechanges" type="boolean" scope="global"> 426 <default>false</default> 427 428 <description> 429 <para> 430 With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name". 431 </para> 432 </description> 433 </bitlbee-setting> 434 435 <bitlbee-setting name="handle_unknown" type="string" scope="global"> 393 436 <default>root</default> 394 437 <possible-values>root, add, add_private, add_channel, ignore</possible-values> … … 417 460 </bitlbee-setting> 418 461 419 <bitlbee-setting name="auto_connect" type="boolean"> 420 <default>True</default> 421 422 <description> 423 <para> 424 With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this. 425 </para> 426 </description> 427 </bitlbee-setting> 428 429 <bitlbee-setting name="auto_reconnect" type="boolean"> 430 <default>False</default> 431 432 <description> 433 <para> 434 If an IM-connections breaks, you're supposed to bring it back up yourself. Having BitlBee do this automatically might not always be a good idea, for several reasons. If you want the connections to be restored automatically, you can enable this setting. 435 </para> 436 437 <para> 438 See also the <emphasis>auto_reconnect_delay</emphasis> setting. 439 </para> 440 </description> 441 442 </bitlbee-setting> 443 444 <bitlbee-setting name="auto_reconnect_delay" type="integer"> 445 <default>300</default> 446 447 <description> 448 449 <para> 450 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. 451 </para> 452 453 <para> 454 See also the <emphasis>auto_reconnect</emphasis> setting. 455 </para> 456 </description> 457 </bitlbee-setting> 458 459 <bitlbee-setting name="buddy_sendbuffer" type="boolean"> 460 <default>False</default> 461 462 <description> 463 464 <para> 465 By default, when you send a message to someone, BitlBee forwards this message to the user immediately. When you paste a large number of lines, the lines will be sent in separate messages, which might not be very nice to read. If you enable this setting, BitlBee will buffer your messages and wait for more data. 466 </para> 467 468 <para> 469 Using the <emphasis>buddy_sendbuffer_delay</emphasis> setting you can specify the number of seconds BitlBee should wait for more data before the complete message is sent. 470 </para> 471 472 <para> 473 Please note that if you remove a buddy from your list (or if the connection to that user drops) and there's still data in the buffer, this data will be lost. BitlBee will not try to send the message to the user in those cases. 474 </para> 475 </description> 476 477 </bitlbee-setting> 478 479 <bitlbee-setting name="buddy_sendbuffer_delay" type="integer"> 480 <default>200</default> 481 482 <description> 483 484 <para> 485 Tell BitlBee after how many (mili)seconds a buffered message should be sent. Values greater than 5 will be interpreted as miliseconds, 5 and lower as seconds. 486 </para> 487 488 <para> 489 See also the <emphasis>buddy_sendbuffer</emphasis> setting. 490 </para> 491 </description> 492 493 </bitlbee-setting> 494 495 <bitlbee-setting name="default_target" type="string"> 496 <default>root</default> 497 <possible-values>root, last</possible-values> 498 499 <description> 500 <para> 501 With this value set to <emphasis>root</emphasis>, lines written in the control channel without any nickname in front of them will be interpreted as commands. If you want BitlBee to send those lines to the last person you addressed in the control channel, set this to <emphasis>last</emphasis>. 502 </para> 503 </description> 504 505 </bitlbee-setting> 506 507 <bitlbee-setting name="display_namechanges" type="boolean"> 508 <default>False</default> 509 510 <para> 511 With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name". 512 </para> 513 </bitlbee-setting> 514 515 <bitlbee-setting name="password" type="string"> 516 <description> 517 <para> 518 Use this setting to change your "NickServ" password. 519 </para> 520 </description> 521 </bitlbee-setting> 522 523 <bitlbee-setting name="query_order" type="string"> 462 <bitlbee-setting name="lcnicks" type="boolean" scope="global"> 463 <default>true</default> 464 465 <description> 466 <para> 467 Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer. 468 </para> 469 </description> 470 471 </bitlbee-setting> 472 473 <bitlbee-setting name="mail_notifications" type="boolean" scope="account"> 474 <default>false</default> 475 476 <description> 477 <para> 478 Some protocols (MSN, Yahoo!) can notify via IM about new e-mail. Since most people use their Hotmail/Yahoo! addresses as a spam-box, this is disabled default. If you want these notifications, you can enable this setting. 479 </para> 480 </description> 481 482 </bitlbee-setting> 483 484 <bitlbee-setting name="ops" type="string" scope="global"> 485 <default>both</default> 486 <possible-values>both, root, user, none</possible-values> 487 488 <description> 489 <para> 490 Some people prefer themself and root to have operator status in &bitlbee, other people don't. You can change these states using this setting. 491 </para> 492 493 <para> 494 The value "both" means both user and root get ops. "root" means, well, just root. "user" means just the user. "none" means nobody will get operator status. 495 </para> 496 </description> 497 </bitlbee-setting> 498 499 <bitlbee-setting name="password" type="string" scope="both"> 500 <description> 501 <para> 502 Use this global setting to change your "NickServ" password. 503 </para> 504 505 <para> 506 This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service. 507 </para> 508 509 <para> 510 Note that BitlBee will always say this setting is empty. This doesn't mean there is no password, it just means that, for security reasons, BitlBee stores passwords somewhere else so they can't just be retrieved in plain text. 511 </para> 512 </description> 513 </bitlbee-setting> 514 515 <bitlbee-setting name="port" type="integer" scope="account"> 516 <description> 517 <para> 518 Currently only available for Jabber connections. Specifies the port number to connect to. Usually this should be set to 5222, or 5223 for SSL-connections. 519 </para> 520 </description> 521 </bitlbee-setting> 522 523 <bitlbee-setting name="priority" type="integer" scope="account"> 524 <default>0</default> 525 526 <description> 527 <para> 528 Can be set for Jabber connections. When connecting to one account from multiple places, this priority value will help the server to determine where to deliver incoming messages (that aren't addressed to a specific resource already). 529 </para> 530 531 <para> 532 According to RFC 3921 servers will always deliver messages to the server with the highest priority value. Mmessages will not be delivered to resources with a negative priority setting (and should be saved as an off-line message if all available resources have a negative priority value). 533 </para> 534 </description> 535 </bitlbee-setting> 536 537 <bitlbee-setting name="private" type="boolean" scope="global"> 538 <default>true</default> 539 540 <description> 541 <para> 542 If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel. 543 </para> 544 545 <para> 546 This setting is remembered (during one session) per-user, this setting only changes the default state. This option takes effect as soon as you reconnect. 547 </para> 548 </description> 549 </bitlbee-setting> 550 551 <bitlbee-setting name="query_order" type="string" scope="global"> 524 552 <default>lifo</default> 525 553 <possible-values>lifo, fifo</possible-values> … … 536 564 </bitlbee-setting> 537 565 538 <bitlbee-setting name="lcnicks" type="boolean"> 539 <default>True</default> 540 541 <description> 542 <para> 543 Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer. 544 </para> 545 </description> 546 566 <bitlbee-setting name="resource" type="string" scope="account"> 567 <default>BitlBee</default> 568 569 <description> 570 <para> 571 Can be set for Jabber connections. You can use this to connect to your Jabber account from multiple clients at once, with every client using a different resource string. 572 </para> 573 </description> 574 </bitlbee-setting> 575 576 <bitlbee-setting name="resource_select" type="string" scope="account"> 577 <default>priority</default> 578 <possible-values>priority, time</possible-values> 579 580 <description> 581 <para> 582 Because the IRC interface makes it pretty hard to specify the resource to talk to (when a buddy is online through different resources), this setting was added. 583 </para> 584 585 <para> 586 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). 587 </para> 588 </description> 589 </bitlbee-setting> 590 591 <bitlbee-setting name="save_on_quit" type="boolean" scope="global"> 592 <default>true</default> 593 594 <description> 595 <para> 596 If enabled causes BitlBee to save all current settings and account details when user disconnects. This is enabled by default, and these days there's not really a reason to have it disabled anymore. 597 </para> 598 </description> 599 </bitlbee-setting> 600 601 <bitlbee-setting name="server" type="string" scope="account"> 602 <description> 603 <para> 604 Can be set for Jabber- and OSCAR-connections. For Jabber, you might have to set this if the servername isn't equal to the part after the @ in the Jabber handle. For OSCAR this shouldn't be necessary anymore in recent BitlBee versions. 605 </para> 606 </description> 607 </bitlbee-setting> 608 609 <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global"> 610 <default>true</default> 611 612 <description> 613 <para> 614 Some IRC clients parse quit messages sent by the IRC server to see if someone really left or just disappeared because of a netsplit. By default, BitlBee tries to simulate netsplit-like quit messages to keep the control channel window clean. If you don't like this (or if your IRC client doesn't support this) you can disable this setting. 615 </para> 616 </description> 617 </bitlbee-setting> 618 619 <bitlbee-setting name="ssl" type="boolean" scope="account"> 620 <default>false</default> 621 622 <description> 623 <para> 624 Currently only available for Jabber connections. Set this to true if the server accepts SSL connections. 625 </para> 626 </description> 627 </bitlbee-setting> 628 629 <bitlbee-setting name="strip_html" type="boolean" scope="global"> 630 <default>true</default> 631 632 <description> 633 <para> 634 Determines what BitlBee should do with HTML in messages. Normally this is turned on and HTML will be stripped from messages, if BitlBee thinks there is HTML. 635 </para> 636 <para> 637 If BitlBee fails to detect this sometimes (most likely in AIM messages over an ICQ connection), you can set this setting to <emphasis>always</emphasis>, but this might sometimes accidentally strip non-HTML things too. 638 </para> 639 </description> 640 </bitlbee-setting> 641 642 <bitlbee-setting name="tls" type="boolean" scope="account"> 643 <default>try</default> 644 645 <description> 646 <para> 647 Newer Jabber servers allow clients to convert a plain-text session to a TLS/SSL-encrypted session. Normally (with this setting set to <emphasis>try</emphasis>) BitlBee will do this, if possible. 648 </para> 649 650 <para> 651 If you want to force BitlBee to use TLS sessions only (and to give up if that doesn't seem to be possible) you can set this setting to <emphasis>true</emphasis>. Set it to <emphasis>false</emphasis> if you want the session to remain plain-text. 652 </para> 653 </description> 654 </bitlbee-setting> 655 656 <bitlbee-setting name="to_char" type="string" scope="global"> 657 <default>": "</default> 658 659 <description> 660 <para> 661 It's customary that messages meant for one specific person on an IRC channel are prepended by his/her alias followed by a colon ':'. BitlBee does this by default. If you prefer a different character, you can set it using <emphasis>set to_char</emphasis>. 662 </para> 663 664 <para> 665 Please note that this setting is only used for incoming messages. For outgoing messages you can use ':' (colon) or ',' to separate the destination nick from the message, and this is not configurable. 666 </para> 667 </description> 668 </bitlbee-setting> 669 670 <bitlbee-setting name="typing_notice" type="boolean" scope="global"> 671 <default>false</default> 672 673 <description> 674 <para> 675 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. 676 </para> 677 </description> 678 </bitlbee-setting> 679 680 <bitlbee-setting name="web_aware" type="string" scope="account"> 681 <default>false</default> 682 683 <description> 684 <para> 685 ICQ allows people to see if you're on-line via a CGI-script. (http://status.icq.com/online.gif?icq=UIN) This can be nice to put on your website, but it seems that spammers also use it to see if you're online without having to add you to their contact list. So to prevent ICQ spamming, recent versions of BitlBee disable this feature by default. 686 </para> 687 688 <para> 689 Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled. 690 </para> 691 </description> 692 </bitlbee-setting> 693 694 <bitlbee-setting name="xmlconsole" type="boolean" scope="account"> 695 <default>false</default> 696 697 <description> 698 <para> 699 The Jabber module allows you to add a buddy <emphasis>xmlconsole</emphasis> to your contact list, which will then show you the raw XMPP stream between you and the server. You can also send XMPP packets to this buddy, which will then be sent to the server. 700 </para> 701 <para> 702 If you want to enable this XML console permanently (and at login time already), you can set this setting. 703 </para> 704 </description> 547 705 </bitlbee-setting> 548 706 … … 668 826 <short-description>Change friendly name, nick</short-description> 669 827 <syntax>nick <connection> [<new nick>]</syntax> 670 <syntax>nick </syntax>671 672 <description> 673 <para> 674 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.828 <syntax>nick <connection></syntax> 829 830 <description> 831 <para> 832 Deprecated: Use the per-account <emphasis>display_name</emphasis> setting to read and change this information. 675 833 </para> 676 834 </description> 677 835 678 836 <ircexample> 679 <ircline nick="wouter"> nick 1 "Wouter Paesen"</ircline>680 <ircline nick="root"> Setting your name on connection 1 to `Wouter Paesen'</ircline>837 <ircline nick="wouter">account set 1/display_name "The majestik møøse"</ircline> 838 <ircline nick="root">display_name = `The majestik møøse'</ircline> 681 839 </ircexample> 682 840 683 841 </bitlbee-command> 684 842 685 <bitlbee-command name=" import_buddies">686 <short-description> Copy local buddy list to server (normally only needed when upgrading)</short-description>687 <syntax> import_buddies <connection> [clear]</syntax>688 689 <description> 690 <para> 691 This command copies the locally stored buddy list to the server. This command exists for upgrading purposes. Previous versions of BitlBee didn't support server-side buddy lists for ICQ, so the list was stored locally.692 </para> 693 694 <para> 695 Since version 0.91 however, server-side contact lists are supported for all protocols, so the local list is now ignored. When upgrading from an older BitlBee to version 0.91, you might need this command to get your buddy list back.696 </para> 697 698 <para> 699 The only argument this command needs is your ICQ account identification. If your serverside buddy list contains some old buddies you don't want anymore, you can pass <emphasis>clear</emphasis> as a second argument.700 </para> 701 702 <para> 703 After giving this command, you have to wait for a while before all the adds are handled, because of ICQ's rate limiting. If your buddy list is very large and the ICQ server starts complaining, you might have to reconnect and enter this command again.704 < /para>705 </ description>843 <bitlbee-command name="join_chat"> 844 <short-description>Join a named groupchat/conference room</short-description> 845 <syntax>join_chat <connection> <room name> [<channel name>] [<room nickname>] [<password>]</syntax> 846 847 <description> 848 <para> 849 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. 850 </para> 851 852 <para> 853 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. 854 </para> 855 856 <para> 857 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>. 858 </para> 859 </description> 860 861 <ircexample> 862 <ircline nick="wilmer">join_chat jabber bitlbee@conference.bitlbee.org &bitlbee-help help-me</ircline> 863 </ircexample> 706 864 707 865 </bitlbee-command> -
doc/user-guide/docbook.xsl
r875ad42 r85d7b85 83 83 84 84 <xsl:template name="cmd"> 85 <xsl:param name="prefix"/> 85 86 <xsl:variable name="thiscmd"><xsl:value-of select="$prefix"/><xsl:value-of select="@name"/></xsl:variable> 86 87 <xsl:attribute name="id"> -
doc/user-guide/help.xsl
r875ad42 r85d7b85 7 7 version="1.1"> 8 8 9 <xsl:output method="text" encoding=" iso-8859-1" standalone="yes"/>9 <xsl:output method="text" encoding="utf-8" standalone="yes"/> 10 10 <xsl:strip-space elements="*"/> 11 11 … … 31 31 32 32 <xsl:template name="subject"> 33 <xsl:param name="id"/> 33 34 <xsl:message><xsl:text>Processing: </xsl:text><xsl:value-of select="$id"/></xsl:message> 34 35 <xsl:text>?</xsl:text><xsl:value-of select="$id"/><xsl:text> </xsl:text> … … 58 59 <xsl:text>?set </xsl:text><xsl:value-of select="@name"/><xsl:text> </xsl:text> 59 60 <xsl:text>_b_Type:_b_ </xsl:text><xsl:value-of select="@type"/><xsl:text> </xsl:text> 60 <xsl:text>_b_Default:_b_ </xsl:text><xsl:value-of select="default"/><xsl:text> </xsl:text> 61 <xsl:text>_b_Scope:_b_ </xsl:text><xsl:value-of select="@scope"/><xsl:text> </xsl:text> 62 <xsl:if test="default"> 63 <xsl:text>_b_Default:_b_ </xsl:text><xsl:value-of select="default"/><xsl:text> </xsl:text> 64 </xsl:if> 61 65 <xsl:if test="possible-values"> 62 66 <xsl:text>_b_Possible Values:_b_ </xsl:text><xsl:value-of select="possible-values"/><xsl:text> </xsl:text> … … 119 123 120 124 <xsl:template name="cmd"> 125 <xsl:param name="prefix"/> 121 126 <xsl:variable name="thiscmd"><xsl:value-of select="$prefix"/><xsl:value-of select="@name"/></xsl:variable> 122 127 <xsl:message><xsl:text>Processing command '</xsl:text><xsl:value-of select="$thiscmd"/><xsl:text>'</xsl:text></xsl:message> -
doc/user-guide/misc.xml
r875ad42 r85d7b85 47 47 </variablelist> 48 48 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 53 49 </sect1> 54 50 … … 56 52 <title>Groupchats</title> 57 53 <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.54 BitlBee now supports groupchats on all IM networks. This text will try to explain you how they work. 59 55 </para> 60 56 … … 73 69 74 70 <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.71 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. 76 72 </para> 77 73 … … 81 77 82 78 <para> 83 This is all you'll probably need to know. If you have any problems, please read <emphasis>help groupchats3</emphasis>. 84 </para> 85 86 </sect1> 87 88 <sect1 id="groupchats3"> 89 <title>Groupchat channel names</title> 90 91 <para> 92 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. :-) 93 </para> 94 95 <para> 96 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. 79 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. 97 80 </para> 98 81 … … 117 100 <member>On the phone, Phone, On phone</member> 118 101 <member>Out to lunch, Lunch, Food</member> 102 <member>Invisible, Hidden</member> 119 103 </simplelist> 120 104 … … 124 108 125 109 <para> 126 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 messageto your buddies.110 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. 127 111 </para> 128 112 -
doc/user-guide/quickstart.xml
r875ad42 r85d7b85 34 34 35 35 <para> 36 For instance, suppose you have a n ICQ account with UIN <emphasis>72696705</emphasis> with password <emphasis>QuickStart</emphasis>, you would:36 For instance, suppose you have a Jabber account at jabber.org with handle <emphasis>bitlbee@jabber.org</emphasis> with password <emphasis>QuickStart</emphasis>, you would: 37 37 </para> 38 38 39 39 <ircexample> 40 <ircline nick="you">account add oscar 72696705 QuickStart login.icq.com</ircline>40 <ircline nick="you">account add jabber bitlbee@jabber.org QuickStart</ircline> 41 41 <ircline nick="root">Account successfully added</ircline> 42 42 </ircexample> 43 43 44 44 <para> 45 Other available IM protocols are jabber, msn, and yahoo. Oscar is the protocol used by ICQ and AOL. For oscar, you need to specify the IM-server as a fourth argument (for msn and yahoo there is no fourth argument). For AOL Instant Messenger, the server name is <emphasis>login.oscar.aol.com</emphasis>. For ICQ, the server name is <emphasis>login.icq.com</emphasis>.45 Other available IM protocols are msn, oscar, and yahoo. OSCAR is the protocol used by ICQ and AOL. For more information about the <emphasis>account add</emphasis> command, see <emphasis>help account add</emphasis>. 46 46 </para> 47 47 … … 61 61 62 62 <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.63 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. 64 64 </para> 65 65 66 66 <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.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. 68 68 </para> 69 69 … … 127 127 <ircexample> 128 128 <ircline nick="you">tux: hey, how's the weather down there?</ircline> 129 <ircline nick="tux"> 129 <ircline nick="tux">you: a bit chilly!</ircline> 130 130 </ircexample> 131 131 132 132 <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 &bitlbee channel, use the <emphasis>set private</emphasis> command: <emphasis>set private true</emphasis> (<emphasis>set private false</emphasis> to change back). 133 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. 134 </para> 135 136 <para> 137 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>. 134 138 </para> 135 139
Note: See TracChangeset
for help on using the changeset viewer.
