source: doc/user-guide/commands.xml @ 6cac643

Last change on this file since 6cac643 was 1ba7e8f, checked in by ulim <a.sporto+bee@…>, at 2008-02-15T17:38:57Z

Merged with upstream r328

Wilmer van der Gaast 2008-02-11 Got rid of some noise at startup: complaining when the default configuration

Wilmer van der Gaast 2008-02-10 Added support for password-protected Jabber chatrooms.
Wilmer van der Gaast 2008-02-10 Making AI_ADDRCONFIG optional, it doesn't exist on at least NetBSD and
Wilmer van der Gaast 2008-02-09 Restored "add -tmp". A bit hackish, but it will do for now.
Wilmer van der Gaast 2008-02-07 Fixed getnameinfo() calls, this fixes Solaris stability issues. Thanks to
Wilmer van der Gaast 2008-02-04 Added bogus G_GNUC_MALLOC to restore GLib 2.4 compatibility (hopefully).
Wilmer van der Gaast 2008-02-03 Messages from the user are also included in backlogs when joining a Jabber
Wilmer van der Gaast 2008-02-03 Disabling "Unknown command" warnings since they're very noisy and pretty
Wilmer van der Gaast 2008-02-03 Implemented XEP-0115. This adds some info to the <presence/> tags so
Wilmer van der Gaast 2008-02-03 Saner garbage collection of cached packets in the Jabber module. Now
Wilmer van der Gaast 2008-02-02 Added help_free() and cleaned up some very stale help-related stuff I
Wilmer van der Gaast 2008-01-30 Fixed handling of OSCAR multi-part messages... They're not arrays, they're
Wilmer van der Gaast 2008-01-24 Keeping track of valid Jabber connections so _connected() events will be
Wilmer van der Gaast 2008-01-24 Fixed two valgrind warnings (partially uninitialized "struct tm" vars.)
Wilmer van der Gaast 2008-01-20 The Jabber module now uses imcb_chat_log() instead of imcb_log() where
Wilmer van der Gaast 2008-01-20 Added imcb_chat_log() for chatroom system messages, so they can be
Wilmer van der Gaast 2008-01-20 GET_BUDDY_FIRST wasn't actually implemented, even though it was in use
Wilmer van der Gaast 2008-01-19 Using test -f instead of test -e. This breaks if the include files are
Wilmer van der Gaast 2008-01-19 Added byte swapping code to the new MD5 checksumming code to make it work
Wilmer van der Gaast 2008-01-18 Moving imcb_chat_new() to a saner location (no code changes) and fixing
Wilmer van der Gaast 2008-01-17 Apparently ext_yahoo_got_im can be called with msg=NULL, so it should be
Wilmer van der Gaast 2008-01-17 Fixing some Solaris compiler warnings (u_int->uint, adding some typecasts
Wilmer van der Gaast 2008-01-13 Fixed handing of failed groupchat joins.
Wilmer van der Gaast 2008-01-13 Fixed "Conditional jump or move depends on uninitialised value(s)" at
Wilmer van der Gaast 2008-01-13 Fixed quickstart2. (Bug #349.)
Wilmer van der Gaast 2008-01-13 Different handling of charset mismatches before login time. Ignoring a
Wilmer van der Gaast 2008-01-12 When a switchboard connection dies (at the TCP level) and there are still
Wilmer van der Gaast 2008-01-12 Killed info_string_append() and now showing the IP address of ICQ users
Wilmer van der Gaast 2008-01-11 Fixing bug #344, now away states should always be correct, even when people
Wilmer van der Gaast 2008-01-11 Adding own handle to protocol name in blist output for people with multiple
Wilmer van der Gaast 2008-01-10 Now setting odata->icq properly again, this got lost some time ago, which
Wilmer van der Gaast 2008-01-06 More consistency in error/warning errors. Until now "WARNING:" was usually
Wilmer van der Gaast 2008-01-06 Changed warning message about unsent MSN messages. It should show the actual
Wilmer van der Gaast 2008-01-05 Added "mail_notifications" setting. Who needs those notifications anyway?
Wilmer van der Gaast 2008-01-05 Build fix from vmiklos.
Wilmer van der Gaast 2008-01-05 Added handling of MSN switchboard NAK messages. Untested, but hey, it
Wilmer van der Gaast 2008-01-05 Removed closure->result. I was planning to add some more stuff, but will
Miklos Vajna 2007-12-31 encode: md5.c is no longer in protocols/, it's in lib/
Wilmer van der Gaast 2007-12-28 Fixed return value check in proxy_connect(), since on some systems
Wilmer van der Gaast 2007-12-28 Added missing return in jabber_login().
Wilmer van der Gaast 2007-12-16 Implemented XEP-0199 (patch from misc@…).
Wilmer van der Gaast 2007-12-12 Checking conn->xcred before trying to clean it up since GnuTLS doesn't
Wilmer van der Gaast 2007-12-12 Killed the <server> parameter to "account add" and changed the default
Wilmer van der Gaast 2007-12-12 Fixed sockerr_again() usage in Jabber module to (hopefully) fix a 100% CPU
Wilmer van der Gaast 2007-12-10 Don't allow nicks that start with a number.
Wilmer van der Gaast 2007-12-10 Fixed "set xxx" syntax (it showed all settings instead of just xxx).
Wilmer van der Gaast 2007-12-09 If I keep forgetting to credit people in commit msgs I should probably add
Wilmer van der Gaast 2007-12-09 Added /invite support for Jabber chatrooms (and fixed the argument order
  • Property mode set to 100644
File size: 36.0 KB
Line 
1<chapter id="commands">
2        <title>Bitlbee commands</title>
3
4        <command-list/>
5
6        <bitlbee-command name="account">
7                <short-description>IM-account list maintenance</short-description>
8                <syntax>account &lt;action&gt; [&lt;arguments&gt;]</syntax>
9
10                <description>
11
12                        <para>
13                                Available actions: add, del, list, on, off and set. See <emphasis>help account &lt;action&gt;</emphasis> for more information.
14                        </para>
15
16                </description>
17
18                <bitlbee-command name="add">
19                        <syntax>account add &lt;protocol&gt; &lt;username&gt; &lt;password&gt;</syntax>
20
21                        <description>
22                                <para>
23                                        Adds an account on the given server with the specified protocol, username and password to the account list. Supported protocols right now are: Jabber, MSN, OSCAR (AIM/ICQ) and Yahoo. For more information about adding an account, see <emphasis>help account add &lt;protocol&gt;</emphasis>.
24                                </para>
25                        </description>
26                       
27                        <bitlbee-command name="jabber">
28                                <syntax>account add jabber &lt;handle@server.tld&gt; &lt;password&gt;</syntax>
29
30                                <description>
31                                        <para>
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                                        </para>
34
35                                        <para>
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>).
37                                        </para>
38                                </description>
39                        </bitlbee-command>
40
41                        <bitlbee-command name="msn">
42                                <syntax>account add msn &lt;handle@server.tld&gt; &lt;password&gt;</syntax>
43
44                                <description>
45                                        <para>
46                                                For MSN connections there are no special arguments.
47                                        </para>
48                                </description>
49                        </bitlbee-command>
50                       
51                        <bitlbee-command name="oscar">
52                                <syntax>account add oscar &lt;handle&gt; &lt;password&gt;</syntax>
53
54                                <description>
55                                        <para>
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.
57                                        </para>
58                                </description>
59
60                                <ircexample>
61                                        <ircline nick="wilmer">account add oscar 72696705 hobbelmeeuw</ircline>
62                                        <ircline nick="root">Account successfully added</ircline>
63                                </ircexample>
64                        </bitlbee-command>
65
66                        <bitlbee-command name="yahoo">
67                                <syntax>account add yahoo &lt;handle&gt; &lt;password&gt;</syntax>
68
69                                <description>
70                                        <para>
71                                                For Yahoo! connections there are no special arguments.
72                                        </para>
73                                </description>
74                        </bitlbee-command>
75
76                </bitlbee-command>
77
78                <bitlbee-command name="del">
79                        <syntax>account del &lt;account id&gt;</syntax>
80
81                        <description>
82                                <para>
83                                        This commands deletes an account from your account list. You should signoff the account before deleting it.
84                                </para>
85
86
87                                <para>
88                                        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.
89                                </para>
90                        </description>
91                </bitlbee-command>
92
93                <bitlbee-command name="on">
94                        <syntax>account on [&lt;account id&gt;]</syntax>
95
96                        <description>
97                                <para>
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.
99                                </para>
100
101                                <para>
102                                        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.
103                                </para>
104                        </description>
105
106                </bitlbee-command>
107
108                <bitlbee-command name="off">
109                        <syntax>account off [&lt;account id&gt;]</syntax>
110
111                        <description>
112                                <para>
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.
114                                </para>
115
116                                <para>
117                                        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.
118                                </para>
119                        </description>
120                </bitlbee-command>
121
122                <bitlbee-command name="list">
123                        <syntax>account list</syntax>
124
125                        <description>
126                                <para>
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 &lt;account id&gt;</syntax>
134                        <syntax>account set &lt;account id&gt;/&lt;setting&gt;</syntax>
135                        <syntax>account set &lt;account id&gt;/&lt;setting&gt; &lt;value&gt;</syntax>
136                        <syntax>account set -del &lt;account id&gt;/&lt;setting&gt;</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 &lt;account id&gt;</emphasis>.
141                                </para>
142                               
143                                <para>
144                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</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.
149                                </para>
150                        </description>
151                </bitlbee-command>
152        </bitlbee-command>
153
154        <bitlbee-command name="add">
155                <short-description>Add a buddy to your contact list</short-description>
156                <syntax>add &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
157                <syntax>add -tmp &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
158
159                <description>
160                        <para>
161                                Adds the given buddy at the specified connection to your buddy list. 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.
162                        </para>
163
164                        <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.
170                        </para>
171                </description>
172
173                <ircexample>
174                        <ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
175                        <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
176                </ircexample>
177        </bitlbee-command>
178
179        <bitlbee-command name="info">
180                <short-description>Request user information</short-description>
181                <syntax>info &lt;connection&gt; &lt;handle&gt;</syntax>
182                <syntax>info &lt;nick&gt;</syntax>
183
184                <description>
185                        <para>
186                                Requests IM-network-specific information about the specified user. The amount of information you'll get differs per protocol. For some protocols (ATM Yahoo! and MSN) it'll give you an URL which you can visit with a normal web browser to get the information.
187                        </para>
188                </description>
189
190                <ircexample>
191                        <ircline nick="ctrlsoft">info 0 72696705</ircline>
192                        <ircline nick="root">User info - UIN: 72696705   Nick: Lintux   First/Last name: Wilmer van der Gaast   E-mail: lintux@lintux.cx</ircline>
193                </ircexample>
194
195        </bitlbee-command>
196
197        <bitlbee-command name="remove">
198                <short-description>Remove a buddy from your contact list</short-description>
199                <syntax>remove &lt;nick&gt;</syntax>
200
201                <description>
202                        <para>
203                                Removes the specified nick from your buddy list.
204                        </para>
205                </description>
206
207                <ircexample>
208                        <ircline nick="ctrlsoft">remove gryp</ircline>
209                        <ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction>
210                </ircexample>
211
212        </bitlbee-command>
213
214        <bitlbee-command name="block">
215                <short-description>Block someone</short-description>
216                <syntax>block &lt;nick&gt;</syntax>
217                <syntax>block &lt;connection&gt; &lt;handle&gt;</syntax>
218                <syntax>block &lt;connection&gt;</syntax>
219
220                <description>
221                        <para>
222                                Puts the specified user on your ignore list. Either specify the user's nick when you have him/her in your contact list or a connection number and a user handle.
223                        </para>
224                       
225                        <para>
226                                When called with only a connection specification as an argument, the command displays the current block list for that connection.
227                        </para>
228                </description>
229        </bitlbee-command>
230
231        <bitlbee-command name="allow">
232                <short-description>Unblock someone</short-description>
233                <syntax>allow &lt;nick&gt;</syntax>
234                <syntax>allow &lt;connection&gt; &lt;handle&gt;</syntax>
235
236                <description>
237                        <para>
238                                Reverse of block. Unignores the specified user or user handle on specified connection.
239                        </para>
240                       
241                        <para>
242                                When called with only a connection specification as an argument, the command displays the current allow list for that connection.
243                        </para>
244                </description>
245        </bitlbee-command>
246
247        <bitlbee-command name="set">
248                <short-description>Miscellaneous settings</short-description>
249                <syntax>set</syntax>
250                <syntax>set &lt;variable&gt;</syntax>
251                <syntax>set &lt;variable&gt; &lt;value&gt;</syntax>
252                <syntax>set -del &lt;variable&gt;</syntax>
253
254                <description>
255
256                        <para>
257                                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.
258                        </para>
259
260                        <para>
261                                To get more help information about a setting, try:
262                        </para>
263
264                </description>
265
266                <ircexample>
267                        <ircline nick="ctrlsoft">help set private</ircline>
268                </ircexample>
269
270        </bitlbee-command>
271
272        <bitlbee-command name="help">
273                <short-description>BitlBee help system</short-description>
274
275                <syntax>help [subject]</syntax>
276
277                <description>
278                        <para>
279                                This command gives you the help information you're reading right now. If you don't give any arguments, it'll give a short help index.
280                        </para>
281                </description>
282        </bitlbee-command>
283
284        <bitlbee-command name="save">
285                <short-description>Save your account data</short-description>
286                <syntax>save</syntax>
287
288                <description>
289                        <para>
290                                This command saves all your nicks and accounts immediately. Handy if you have the autosave functionality disabled, or if you don't trust the program's stability... ;-)
291                        </para>
292                </description>
293        </bitlbee-command>
294
295        <bitlbee-setting name="auto_connect" type="boolean" scope="both">
296                <default>true</default>
297
298                <description>
299                        <para>
300                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
301                        </para>
302                       
303                        <para>
304                                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!)
305                        </para>
306                </description>
307        </bitlbee-setting>
308
309        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
310                <default>false</default>
311
312                <description>
313                        <para>
314                                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.
315                        </para>
316
317                        <para>
318                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
319                        </para>
320
321                        <para>
322                                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!)
323                        </para>
324                </description>
325        </bitlbee-setting>
326
327        <bitlbee-setting name="auto_reconnect_delay" type="integer" scope="global">
328                <default>300</default>
329
330                <description>
331                        <para>
332                                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.
333                        </para>
334
335                        <para>
336                                See also the <emphasis>auto_reconnect</emphasis> setting.
337                        </para>
338                </description>
339        </bitlbee-setting>
340
341        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
342                <default>true</default>
343
344                <description>
345                        <para>
346                                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.
347                        </para>
348                </description>
349        </bitlbee-setting>
350
351        <bitlbee-setting name="buddy_sendbuffer" type="boolean" scope="global">
352                <default>false</default>
353
354                <description>
355                        <para>
356                                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.
357                        </para>
358
359                        <para>
360                                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.
361                        </para>
362
363                        <para>
364                                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.
365                        </para>
366                </description>
367        </bitlbee-setting>
368
369        <bitlbee-setting name="buddy_sendbuffer_delay" type="integer" scope="global">
370                <default>200</default>
371
372                <description>
373
374                        <para>
375                                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.
376                        </para>
377
378                        <para>
379                                See also the <emphasis>buddy_sendbuffer</emphasis> setting.
380                        </para>
381                </description>
382        </bitlbee-setting>
383
384        <bitlbee-setting name="charset" type="string" scope="global">
385                <default>iso8859-1</default>
386                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
387
388                <description>
389                        <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
395                        </para>
396                </description>
397
398        </bitlbee-setting>
399
400        <bitlbee-setting name="debug" type="boolean" scope="global">
401                <default>false</default>
402
403                <description>
404                        <para>
405                                Some debugging messages can be sent to the control channel if you wish. They're probably not really useful for you, unless you're doing some development on BitlBee.
406                        </para>
407                </description>
408        </bitlbee-setting>
409
410        <bitlbee-setting name="default_target" type="string" scope="global">
411                <default>root</default>
412                <possible-values>root, last</possible-values>
413
414                <description>
415                        <para>
416                                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>.
417                        </para>
418                </description>
419        </bitlbee-setting>
420
421        <bitlbee-setting name="display_name" type="string" scope="account">
422                <description>
423                        <para>
424                                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.
425                        </para>
426                </description>
427        </bitlbee-setting>
428
429        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
430                <default>false</default>
431
432                <description>
433                        <para>
434                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
435                        </para>
436                </description>
437        </bitlbee-setting>
438
439        <bitlbee-setting name="handle_unknown" type="string" scope="global">
440                <default>root</default>
441                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
442
443                <description>
444                        <para>
445                                Messages from unknown users are echoed like this by default:
446                        </para>
447
448                        <ircexample>
449                                <ircline nick="root">Unknown message from handle 3137137:</ircline>
450                                <ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
451                        </ircexample>
452
453                        <para>
454                                If you want this lame user to be added automatically, you can set this setting to "add". If you prefer to ignore messages from people you don't know, you can set this one to "ignore". "add_private" and "add_channel" are like add, but you can use them to make messages from unknown buddies appear in the channel instead of a query window.
455                        </para>
456
457                        <note>
458                                <para>
459                                        Auto-added users aren't added to your real contact list. This is because you don't want the user to get authorization requests. So when you restart BitlBee, the auto-added user will be gone. If you want to keep the person in your buddy-list, you have to fixate the add using the <emphasis>add</emphasis> command.
460                                </para>
461                        </note>
462                </description>
463
464        </bitlbee-setting>
465
466        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
467                <default>true</default>
468
469                <description>
470                        <para>
471                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
472                        </para>
473                </description>
474
475        </bitlbee-setting>
476
477        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
478                <default>false</default>
479
480                <description>
481                        <para>
482                                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.
483                        </para>
484                </description>
485
486        </bitlbee-setting>
487
488        <bitlbee-setting name="ops" type="string" scope="global">
489                <default>both</default>
490                <possible-values>both, root, user, none</possible-values>
491
492                <description>
493                        <para>
494                                Some people prefer themself and root to have operator status in &amp;bitlbee, other people don't. You can change these states using this setting.
495                        </para>
496
497                        <para>
498                                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.
499                        </para>
500                </description>
501        </bitlbee-setting>
502
503        <bitlbee-setting name="password" type="string" scope="both">
504                <description>
505                        <para>
506                                Use this global setting to change your "NickServ" password.
507                        </para>
508                       
509                        <para>
510                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
511                        </para>
512                       
513                        <para>
514                                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.
515                        </para>
516                </description>
517        </bitlbee-setting>
518       
519        <bitlbee-setting name="port" type="integer" scope="account">
520                <description>
521                        <para>
522                                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.
523                        </para>
524                </description>
525        </bitlbee-setting>
526
527        <bitlbee-setting name="priority" type="integer" scope="account">
528                <default>0</default>
529
530                <description>
531                        <para>
532                                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).
533                        </para>
534
535                        <para>
536                                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).
537                        </para>
538                </description>
539        </bitlbee-setting>
540
541        <bitlbee-setting name="private" type="boolean" scope="global">
542                <default>true</default>
543
544                <description>
545                        <para>
546                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
547                        </para>
548
549                        <para>
550                                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.
551                        </para>
552                </description>
553        </bitlbee-setting>
554
555        <bitlbee-setting name="query_order" type="string" scope="global">
556                <default>lifo</default>
557                <possible-values>lifo, fifo</possible-values>
558
559                <description>
560                        <para>
561                                This changes the order in which the questions from root (usually authorization requests from buddies) should be answered. When set to <emphasis>lifo</emphasis>, BitlBee immediately displays all new questions and they should be answered in reverse order. When this is set to <emphasis>fifo</emphasis>, BitlBee displays the first question which comes in and caches all the others until you answer the first one.
562                        </para>
563
564                        <para>
565                                Although the <emphasis>fifo</emphasis> setting might sound more logical (and used to be the default behaviour in older BitlBee versions), it turned out not to be very convenient for many users when they missed the first question (and never received the next ones).
566                        </para>
567                </description>
568        </bitlbee-setting>
569
570        <bitlbee-setting name="resource" type="string" scope="account">
571                <default>BitlBee</default>
572
573                <description>
574                        <para>
575                                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.
576                        </para>
577                </description>
578        </bitlbee-setting>
579
580        <bitlbee-setting name="resource_select" type="string" scope="account">
581                <default>priority</default>
582                <possible-values>priority, time</possible-values>
583
584                <description>
585                        <para>
586                                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.
587                        </para>
588
589                        <para>
590                                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).
591                        </para>
592                </description>
593        </bitlbee-setting>
594
595        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
596                <default>true</default>
597
598                <description>
599                        <para>
600                                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.
601                        </para>
602                </description>
603        </bitlbee-setting>
604
605        <bitlbee-setting name="server" type="string" scope="account">
606                <description>
607                        <para>
608                                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.
609                        </para>
610                </description>
611        </bitlbee-setting>
612
613        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
614                <default>true</default>
615
616                <description>
617                        <para>
618                                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.
619                        </para>
620                </description>
621        </bitlbee-setting>
622
623        <bitlbee-setting name="ssl" type="boolean" scope="account">
624                <default>false</default>
625
626                <description>
627                        <para>
628                                Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
629                        </para>
630                </description>
631        </bitlbee-setting>
632
633        <bitlbee-setting name="strip_html" type="boolean" scope="global">
634                <default>true</default>
635
636                <description>
637                        <para>
638                                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.
639                        </para>
640                        <para>
641                                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.
642                        </para>
643                </description>
644        </bitlbee-setting>
645
646        <bitlbee-setting name="tls" type="boolean" scope="account">
647                <default>try</default>
648
649                <description>
650                        <para>
651                                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.
652                        </para>
653
654                        <para>
655                                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.
656                        </para>
657                </description>
658        </bitlbee-setting>
659
660        <bitlbee-setting name="to_char" type="string" scope="global">
661                <default>": "</default>
662
663                <description>
664                        <para>
665                                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>.
666                        </para>
667
668                        <para>
669                                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.
670                        </para>
671                </description>
672        </bitlbee-setting>
673
674        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
675                <default>false</default>
676
677                <description>
678                        <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. ;-)
680                        </para>
681                </description>
682        </bitlbee-setting>
683
684        <bitlbee-setting name="web_aware" type="string" scope="account">
685                <default>false</default>
686
687                <description>
688                        <para>
689                                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.
690                        </para>
691
692                        <para>
693                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
694                        </para>
695                </description>
696        </bitlbee-setting>
697
698        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
699                <default>false</default>
700
701                <description>
702                        <para>
703                                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.
704                        </para>
705                        <para>
706                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
707                        </para>
708                </description>
709        </bitlbee-setting>
710
711        <bitlbee-command name="rename">
712                <short-description>Rename (renick) a buddy</short-description>
713                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
714
715                <description>
716                        <para>
717                                Renick a user in your buddy list. Very useful, in fact just very important, if you got a lot of people with stupid account names (or hard ICQ numbers).
718                        </para>
719                </description>
720
721                <ircexample>
722                        <ircline nick="itsme">rename itsme_ you</ircline>
723                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
724                </ircexample>
725
726        </bitlbee-command>
727
728        <bitlbee-command name="yes">
729                <short-description>Accept a request</short-description>
730                <syntax>yes [&lt;number&gt;]</syntax>
731
732                <description>
733                        <para>
734                                Sometimes an IM-module might want to ask you a question. (Accept this user as your buddy or not?) To accept a question, use the <emphasis>yes</emphasis> command.
735                        </para>
736
737                        <para>
738                                By default, this answers the first unanswered question. You can also specify a different question as an argument. You can use the <emphasis>qlist</emphasis> command for a list of questions.
739                        </para>
740                </description>
741
742        </bitlbee-command>
743
744        <bitlbee-command name="no">
745                <short-description>Deny a request</short-description>
746                <syntax>no [&lt;number&gt;]</syntax>
747
748                <description>
749                        <para>
750                                Sometimes an IM-module might want to ask you a question. (Accept this user as your buddy or not?) To reject a question, use the <emphasis>no</emphasis> command.
751                        </para>
752
753                        <para>
754                                By default, this answers the first unanswered question. You can also specify a different question as an argument. You can use the <emphasis>qlist</emphasis> command for a list of questions.
755                        </para>
756                </description>
757        </bitlbee-command>
758
759        <bitlbee-command name="qlist">
760                <short-description>List all the unanswered questions root asked</short-description>
761                <syntax>qlist</syntax>
762
763                <description>
764                        <para>
765                                This gives you a list of all the unanswered questions from root.
766                        </para>
767                </description>
768
769        </bitlbee-command>
770
771        <bitlbee-command name="register">
772                <short-description>Register yourself</short-description>
773                <syntax>register &lt;password&gt;</syntax>
774
775                <description>
776                        <para>
777                                BitlBee can save your settings so you won't have to enter all your IM passwords every time you log in. If you want the Bee to save your settings, use the <emphasis>register</emphasis> command.
778                        </para>
779
780                        <para>
781                                Please do pick a secure password, don't just use your nick as your password. Please note that IRC is not an encrypted protocol, so the passwords still go over the network in plaintext. Evil people with evil sniffers will read it all. (So don't use your root password.. ;-)
782                        </para>
783
784                        <para>
785                                To identify yourself in later sessions, you can use the <emphasis>identify</emphasis> command. To change your password later, you can use the <emphasis>set password</emphasis> command.
786                        </para>
787                </description>
788
789        </bitlbee-command>
790
791        <bitlbee-command name="identify">
792                <syntax>identify &lt;password&gt;</syntax>
793                <short-description>Identify yourself with your password</short-description>
794
795                <description>
796                        <para>
797                                BitlBee saves all your settings (contacts, accounts, passwords) on-server. To prevent other users from just logging in as you and getting this information, you'll have to identify yourself with your password. You can register this password using the <emphasis>register</emphasis> command.
798                        </para>
799
800                        <para>
801                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
802                        </para>
803                </description>
804        </bitlbee-command>
805
806        <bitlbee-command name="drop">
807                <syntax>drop &lt;password&gt;</syntax>
808                <short-description>Drop your account</short-description>
809
810                <description>
811                        <para>
812                                Drop your BitlBee registration. Your account files will be removed and your password will be forgotten. For obvious security reasons, you have to specify your NickServ password to make this command work.
813                        </para>
814                </description>
815        </bitlbee-command>
816
817        <bitlbee-command name="blist">
818                <syntax>blist [all|online|offline|away]</syntax>
819                <short-description>List all the buddies in your contact list</short-description>
820
821                <description>
822                        <para>
823                                You can get a better readable buddy list using the <emphasis>blist</emphasis> command. If you want a complete list (including the offline users) you can use the <emphasis>all</emphasis> argument.
824                        </para>
825                </description>
826
827        </bitlbee-command>
828
829        <bitlbee-command name="nick">
830                <short-description>Change friendly name, nick</short-description>
831                <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.
841                        </para>
842                </description>
843
844                <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                </ircexample>
848
849        </bitlbee-command>
850
851        <bitlbee-command name="join_chat">
852                <short-description>Join a named groupchat/conference room</short-description>
853                <syntax>join_chat &lt;connection&gt; &lt;room name&gt; [&lt;channel name&gt;] [&lt;room nickname&gt;] [&lt;password&gt;]</syntax>
854
855                <description>
856                        <para>
857                                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.
858                        </para>
859
860                        <para>
861                                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.
862                        </para>
863
864                        <para>
865                                The following command will join you to the chatroom called <emphasis>bitlbee@conference.bitlbee.org</emphasis>. The channel will be called <emphasis>&amp;bitlbee-help</emphasis> because <emphasis>&amp;bitlbee</emphasis> will already be in use. Your nickname will be <emphasis>help-me</emphasis>.
866                        </para>
867                </description>
868
869                <ircexample>
870                        <ircline nick="wilmer">join_chat jabber bitlbee@conference.bitlbee.org &amp;bitlbee-help help-me</ircline>
871                </ircexample>
872
873        </bitlbee-command>
874       
875        <bitlbee-command name="transfers">
876                <short-description>Monitor, cancel, or reject file transfers</short-description>
877                <syntax>transfers [&lt;cancel&gt; id | &lt;reject&gt;]</syntax>
878               
879                <description>
880                        <para>
881                                Without parameters the currently pending file transfers and their status will be listed. Available actions are <emphasis>cancel</emphasis> and <emphasis>reject</emphasis>. See <emphasis>help transfers &lt;action&gt;</emphasis> for more information.
882                        </para>
883
884                        <ircexample>
885                                <ircline nick="ulim">transfers</ircline>
886                        </ircexample>
887                </description>
888               
889                <bitlbee-command name="cancel">
890                        <short-description>Cancels the file transfer with the given id</short-description>
891                        <syntax>transfers &lt;cancel&gt; id</syntax>
892
893                        <description>
894                                <para>Cancels the file transfer with the given id</para>
895                        </description>
896
897                        <ircexample>
898                                <ircline nick="ulim">transfers cancel 1</ircline>
899                                <ircline nick="root">Canceling file transfer for test</ircline>
900                        </ircexample>
901                </bitlbee-command>
902
903                <bitlbee-command name="reject">
904                        <short-description>Rejects all incoming transfers</short-description>
905                        <syntax>transfers &lt;reject&gt;</syntax>
906
907                        <description>
908                                <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>
909                        </description>
910
911                        <ircexample>
912                                <ircline nick="ulim">transfers reject</ircline>
913                        </ircexample>
914                </bitlbee-command>
915        </bitlbee-command>
916       
917</chapter>
Note: See TracBrowser for help on using the repository browser.