source: doc/user-guide/commands.xml @ 796da03

Last change on this file since 796da03 was 9e768da, checked in by Wilmer van der Gaast <wilmer@…>, at 2009-01-13T18:59:28Z

Fixed an embarassing typo that even fooled me into believing BitlBee is
broken. :-(
  • Property mode set to 100644
File size: 36.2 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.
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 command 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>.
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="chat">
155                <short-description>Chatroom list maintenance</short-description>
156                <syntax>chat &lt;action&gt; [&lt;arguments&gt;]</syntax>
157
158                <description>
159
160                        <para>
161                                Available actions: add, del, list, with and set. See <emphasis>help chat &lt;action&gt;</emphasis> for more information.
162                        </para>
163
164                </description>
165
166                <bitlbee-command name="add">
167                        <syntax>chat add &lt;account&gt; &lt;room&gt; [&lt;channel&gt;]</syntax>
168
169                        <description>
170                                <para>
171                                        Add a chatroom to the list of chatrooms you're interested in. BitlBee needs this list to map room names to a proper IRC channel name.
172                                </para>
173
174                                <para>
175                                        After adding a room to your list, you can simply use the IRC /join command to enter the room. Also, you can tell BitlBee to automatically join the room when you log in. (See <emphasis>chat set</emphasis>)
176                                </para>
177                        </description>
178
179                </bitlbee-command>
180
181                <bitlbee-command name="del">
182                        <syntax>chat del &lt;chat id&gt;</syntax>
183
184                        <description>
185                                <para>
186                                        This commands deletes an chatroom from your list.
187                                </para>
188
189                                <para>
190                                        The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.
191                                </para>
192                        </description>
193                </bitlbee-command>
194
195                <bitlbee-command name="list">
196                        <syntax>chat list</syntax>
197
198                        <description>
199                                <para>
200                                        This command gives you a list of all the chatrooms known by BitlBee.
201                                </para>
202                        </description>
203                </bitlbee-command>
204
205                <bitlbee-command name="with">
206                        <syntax>chat with &lt;nickname&gt;</syntax>
207
208                        <description>
209                                <para>
210                                        While most <emphasis>chat</emphasis> subcommands are about named chatrooms, this command can be used to open an unnamed groupchat with one or more persons. This command is what <emphasis>/join #nickname</emphasis> used to do in older BitlBee versions.
211                                </para>
212                        </description>
213                </bitlbee-command>
214
215                <bitlbee-command name="set">
216                        <syntax>chat set &lt;chat id&gt;</syntax>
217                        <syntax>chat set &lt;chat id&gt;/&lt;setting&gt;</syntax>
218                        <syntax>chat set &lt;chat id&gt;/&lt;setting&gt; &lt;value&gt;</syntax>
219                        <syntax>chat set -del &lt;chat id&gt;/&lt;setting&gt;</syntax>
220
221                        <description>
222                                <para>
223                                        This command can be used to change various settings for chatrooms.
224                                </para>
225                               
226                                <para>
227                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
228                                </para>
229                               
230                                <para>
231                                        The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.
232                                </para>
233                        </description>
234                </bitlbee-command>
235        </bitlbee-command>
236
237        <bitlbee-command name="add">
238                <short-description>Add a buddy to your contact list</short-description>
239                <syntax>add &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
240                <syntax>add -tmp &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
241
242                <description>
243                        <para>
244                                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.
245                        </para>
246
247                        <para>
248                                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.
249                        </para>
250                </description>
251
252                <ircexample>
253                        <ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
254                        <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
255                </ircexample>
256        </bitlbee-command>
257
258        <bitlbee-command name="info">
259                <short-description>Request user information</short-description>
260                <syntax>info &lt;connection&gt; &lt;handle&gt;</syntax>
261                <syntax>info &lt;nick&gt;</syntax>
262
263                <description>
264                        <para>
265                                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.
266                        </para>
267                </description>
268
269                <ircexample>
270                        <ircline nick="ctrlsoft">info 0 72696705</ircline>
271                        <ircline nick="root">User info - UIN: 72696705   Nick: Lintux   First/Last name: Wilmer van der Gaast   E-mail: lintux@lintux.cx</ircline>
272                </ircexample>
273
274        </bitlbee-command>
275
276        <bitlbee-command name="remove">
277                <short-description>Remove a buddy from your contact list</short-description>
278                <syntax>remove &lt;nick&gt;</syntax>
279
280                <description>
281                        <para>
282                                Removes the specified nick from your buddy list.
283                        </para>
284                </description>
285
286                <ircexample>
287                        <ircline nick="ctrlsoft">remove gryp</ircline>
288                        <ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction>
289                </ircexample>
290
291        </bitlbee-command>
292
293        <bitlbee-command name="block">
294                <short-description>Block someone</short-description>
295                <syntax>block &lt;nick&gt;</syntax>
296                <syntax>block &lt;connection&gt; &lt;handle&gt;</syntax>
297                <syntax>block &lt;connection&gt;</syntax>
298
299                <description>
300                        <para>
301                                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.
302                        </para>
303                       
304                        <para>
305                                When called with only a connection specification as an argument, the command displays the current block list for that connection.
306                        </para>
307                </description>
308        </bitlbee-command>
309
310        <bitlbee-command name="allow">
311                <short-description>Unblock someone</short-description>
312                <syntax>allow &lt;nick&gt;</syntax>
313                <syntax>allow &lt;connection&gt; &lt;handle&gt;</syntax>
314
315                <description>
316                        <para>
317                                Reverse of block. Unignores the specified user or user handle on specified connection.
318                        </para>
319                       
320                        <para>
321                                When called with only a connection specification as an argument, the command displays the current allow list for that connection.
322                        </para>
323                </description>
324        </bitlbee-command>
325
326        <bitlbee-command name="set">
327                <short-description>Miscellaneous settings</short-description>
328                <syntax>set</syntax>
329                <syntax>set &lt;variable&gt;</syntax>
330                <syntax>set &lt;variable&gt; &lt;value&gt;</syntax>
331                <syntax>set -del &lt;variable&gt;</syntax>
332
333                <description>
334
335                        <para>
336                                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.
337                        </para>
338
339                        <para>
340                                To get more help information about a setting, try:
341                        </para>
342
343                </description>
344
345                <ircexample>
346                        <ircline nick="ctrlsoft">help set private</ircline>
347                </ircexample>
348
349        </bitlbee-command>
350
351        <bitlbee-command name="help">
352                <short-description>BitlBee help system</short-description>
353
354                <syntax>help [subject]</syntax>
355
356                <description>
357                        <para>
358                                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.
359                        </para>
360                </description>
361        </bitlbee-command>
362
363        <bitlbee-command name="save">
364                <short-description>Save your account data</short-description>
365                <syntax>save</syntax>
366
367                <description>
368                        <para>
369                                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... ;-)
370                        </para>
371                </description>
372        </bitlbee-command>
373
374        <bitlbee-setting name="auto_connect" type="boolean" scope="both">
375                <default>true</default>
376
377                <description>
378                        <para>
379                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
380                        </para>
381                       
382                        <para>
383                                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!)
384                        </para>
385                </description>
386        </bitlbee-setting>
387
388        <bitlbee-setting name="auto_join" type="boolean" scope="chat">
389                <default>false</default>
390
391                <description>
392                        <para>
393                                With this option enabled, BitlBee will automatically join this chatroom when you log in.
394                        </para>
395                </description>
396        </bitlbee-setting>
397
398        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
399                <default>false</default>
400
401                <description>
402                        <para>
403                                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.
404                        </para>
405
406                        <para>
407                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
408                        </para>
409
410                        <para>
411                                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!)
412                        </para>
413                </description>
414        </bitlbee-setting>
415
416        <bitlbee-setting name="auto_reconnect_delay" type="string" scope="global">
417                <default>5*3&lt;900</default>
418
419                <description>
420                        <para>
421                                Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up.
422                        </para>
423
424                        <para>
425                                This can be one integer, for a constant delay. One can also set it to something like &quot;10*10&quot;, which means wait for ten seconds on the first reconnect, multiply it by ten on every failure. Once successfully connected, this delay is re-set to the initial value. With &lt; you can give a maximum delay.
426                        </para>
427
428                        <para>
429                                See also the <emphasis>auto_reconnect</emphasis> setting.
430                        </para>
431                </description>
432        </bitlbee-setting>
433
434        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
435                <default>true</default>
436
437                <description>
438                        <para>
439                                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.
440                        </para>
441                </description>
442        </bitlbee-setting>
443
444        <bitlbee-setting name="buddy_sendbuffer" type="boolean" scope="global">
445                <default>false</default>
446
447                <description>
448                        <para>
449                                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.
450                        </para>
451
452                        <para>
453                                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.
454                        </para>
455
456                        <para>
457                                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.
458                        </para>
459                </description>
460        </bitlbee-setting>
461
462        <bitlbee-setting name="buddy_sendbuffer_delay" type="integer" scope="global">
463                <default>200</default>
464
465                <description>
466
467                        <para>
468                                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.
469                        </para>
470
471                        <para>
472                                See also the <emphasis>buddy_sendbuffer</emphasis> setting.
473                        </para>
474                </description>
475        </bitlbee-setting>
476
477        <bitlbee-setting name="charset" type="string" scope="global">
478                <default>utf-8</default>
479                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
480
481                <description>
482                        <para>
483                                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.
484                        </para>
485
486                        <para>
487                                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
488                        </para>
489                </description>
490
491        </bitlbee-setting>
492
493        <bitlbee-setting name="debug" type="boolean" scope="global">
494                <default>false</default>
495
496                <description>
497                        <para>
498                                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.
499                        </para>
500                </description>
501        </bitlbee-setting>
502
503        <bitlbee-setting name="default_target" type="string" scope="global">
504                <default>root</default>
505                <possible-values>root, last</possible-values>
506
507                <description>
508                        <para>
509                                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>.
510                        </para>
511                </description>
512        </bitlbee-setting>
513
514        <bitlbee-setting name="display_name" type="string" scope="account">
515                <description>
516                        <para>
517                                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.
518                        </para>
519                </description>
520        </bitlbee-setting>
521
522        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
523                <default>false</default>
524
525                <description>
526                        <para>
527                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
528                        </para>
529                </description>
530        </bitlbee-setting>
531
532        <bitlbee-setting name="handle_unknown" type="string" scope="global">
533                <default>root</default>
534                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
535
536                <description>
537                        <para>
538                                Messages from unknown users are echoed like this by default:
539                        </para>
540
541                        <ircexample>
542                                <ircline nick="root">Unknown message from handle 3137137:</ircline>
543                                <ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
544                        </ircexample>
545
546                        <para>
547                                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.
548                        </para>
549
550                        <note>
551                                <para>
552                                        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.
553                                </para>
554                        </note>
555                </description>
556
557        </bitlbee-setting>
558
559        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
560                <default>true</default>
561
562                <description>
563                        <para>
564                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
565                        </para>
566                </description>
567
568        </bitlbee-setting>
569
570        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
571                <default>false</default>
572
573                <description>
574                        <para>
575                                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.
576                        </para>
577                </description>
578
579        </bitlbee-setting>
580
581        <bitlbee-setting name="nick" type="string" scope="chat">
582
583                <description>
584                        <para>
585                                You can use this option to set your nickname in a chatroom. You won't see this nickname yourself, but other people in the room will. By default, BitlBee will use your username as the chatroom nickname.
586                        </para>
587                </description>
588        </bitlbee-setting>
589
590        <bitlbee-setting name="ops" type="string" scope="global">
591                <default>both</default>
592                <possible-values>both, root, user, none</possible-values>
593
594                <description>
595                        <para>
596                                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.
597                        </para>
598
599                        <para>
600                                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.
601                        </para>
602                </description>
603        </bitlbee-setting>
604
605        <bitlbee-setting name="password" type="string" scope="both">
606                <description>
607                        <para>
608                                Use this global setting to change your "NickServ" password.
609                        </para>
610                       
611                        <para>
612                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
613                        </para>
614                       
615                        <para>
616                                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.
617                        </para>
618                </description>
619        </bitlbee-setting>
620       
621        <bitlbee-setting name="port" type="integer" scope="account">
622                <description>
623                        <para>
624                                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.
625                        </para>
626                </description>
627        </bitlbee-setting>
628
629        <bitlbee-setting name="priority" type="integer" scope="account">
630                <default>0</default>
631
632                <description>
633                        <para>
634                                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).
635                        </para>
636
637                        <para>
638                                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).
639                        </para>
640                </description>
641        </bitlbee-setting>
642
643        <bitlbee-setting name="private" type="boolean" scope="global">
644                <default>true</default>
645
646                <description>
647                        <para>
648                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
649                        </para>
650
651                        <para>
652                                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.
653                        </para>
654                </description>
655        </bitlbee-setting>
656
657        <bitlbee-setting name="query_order" type="string" scope="global">
658                <default>lifo</default>
659                <possible-values>lifo, fifo</possible-values>
660
661                <description>
662                        <para>
663                                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.
664                        </para>
665
666                        <para>
667                                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).
668                        </para>
669                </description>
670        </bitlbee-setting>
671
672        <bitlbee-setting name="resource" type="string" scope="account">
673                <default>BitlBee</default>
674
675                <description>
676                        <para>
677                                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.
678                        </para>
679                </description>
680        </bitlbee-setting>
681
682        <bitlbee-setting name="resource_select" type="string" scope="account">
683                <default>priority</default>
684                <possible-values>priority, activity</possible-values>
685
686                <description>
687                        <para>
688                                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.
689                        </para>
690
691                        <para>
692                                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>activity</emphasis>, messages will be delivered to the resource that was last used to send you a message (or the resource that most recently connected).
693                        </para>
694                </description>
695        </bitlbee-setting>
696
697        <bitlbee-setting name="root_nick" type="string" scope="global">
698                <default>root</default>
699
700                <description>
701                        <para>
702                                Normally the "bot" that takes all your BitlBee commands is called "root". If you don't like this name, you can rename it to anything else using the <emphasis>rename</emphasis> command, or by changing this setting.
703                        </para>
704                </description>
705        </bitlbee-setting>
706
707        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
708                <default>true</default>
709
710                <description>
711                        <para>
712                                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.
713                        </para>
714                </description>
715        </bitlbee-setting>
716
717        <bitlbee-setting name="server" type="string" scope="account">
718                <description>
719                        <para>
720                                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.
721                        </para>
722                </description>
723        </bitlbee-setting>
724
725        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
726                <default>true</default>
727
728                <description>
729                        <para>
730                                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.
731                        </para>
732                </description>
733        </bitlbee-setting>
734
735        <bitlbee-setting name="ssl" type="boolean" scope="account">
736                <default>false</default>
737
738                <description>
739                        <para>
740                                Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
741                        </para>
742                </description>
743        </bitlbee-setting>
744
745        <bitlbee-setting name="strip_html" type="boolean" scope="global">
746                <default>true</default>
747
748                <description>
749                        <para>
750                                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.
751                        </para>
752                        <para>
753                                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.
754                        </para>
755                </description>
756        </bitlbee-setting>
757
758        <bitlbee-setting name="tls" type="boolean" scope="account">
759                <default>try</default>
760
761                <description>
762                        <para>
763                                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.
764                        </para>
765
766                        <para>
767                                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.
768                        </para>
769                </description>
770        </bitlbee-setting>
771
772        <bitlbee-setting name="to_char" type="string" scope="global">
773                <default>": "</default>
774
775                <description>
776                        <para>
777                                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>.
778                        </para>
779
780                        <para>
781                                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.
782                        </para>
783                </description>
784        </bitlbee-setting>
785
786        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
787                <default>false</default>
788
789                <description>
790                        <para>
791                                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.
792                        </para>
793                </description>
794        </bitlbee-setting>
795
796        <bitlbee-setting name="web_aware" type="string" scope="account">
797                <default>false</default>
798
799                <description>
800                        <para>
801                                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.
802                        </para>
803
804                        <para>
805                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
806                        </para>
807                </description>
808        </bitlbee-setting>
809
810        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
811                <default>false</default>
812
813                <description>
814                        <para>
815                                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.
816                        </para>
817                        <para>
818                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
819                        </para>
820                </description>
821        </bitlbee-setting>
822
823        <bitlbee-command name="rename">
824                <short-description>Rename (renick) a buddy</short-description>
825                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
826
827                <description>
828                        <para>
829                                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).
830                        </para>
831                </description>
832
833                <ircexample>
834                        <ircline nick="itsme">rename itsme_ you</ircline>
835                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
836                </ircexample>
837
838        </bitlbee-command>
839
840        <bitlbee-command name="yes">
841                <short-description>Accept a request</short-description>
842                <syntax>yes [&lt;number&gt;]</syntax>
843
844                <description>
845                        <para>
846                                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.
847                        </para>
848
849                        <para>
850                                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.
851                        </para>
852                </description>
853
854        </bitlbee-command>
855
856        <bitlbee-command name="no">
857                <short-description>Deny a request</short-description>
858                <syntax>no [&lt;number&gt;]</syntax>
859
860                <description>
861                        <para>
862                                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.
863                        </para>
864
865                        <para>
866                                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.
867                        </para>
868                </description>
869        </bitlbee-command>
870
871        <bitlbee-command name="qlist">
872                <short-description>List all the unanswered questions root asked</short-description>
873                <syntax>qlist</syntax>
874
875                <description>
876                        <para>
877                                This gives you a list of all the unanswered questions from root.
878                        </para>
879                </description>
880
881        </bitlbee-command>
882
883        <bitlbee-command name="register">
884                <short-description>Register yourself</short-description>
885                <syntax>register &lt;password&gt;</syntax>
886
887                <description>
888                        <para>
889                                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.
890                        </para>
891
892                        <para>
893                                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.. ;-)
894                        </para>
895
896                        <para>
897                                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.
898                        </para>
899                </description>
900
901        </bitlbee-command>
902
903        <bitlbee-command name="identify">
904                <syntax>identify &lt;password&gt;</syntax>
905                <short-description>Identify yourself with your password</short-description>
906
907                <description>
908                        <para>
909                                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.
910                        </para>
911
912                        <para>
913                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
914                        </para>
915                </description>
916        </bitlbee-command>
917
918        <bitlbee-command name="drop">
919                <syntax>drop &lt;password&gt;</syntax>
920                <short-description>Drop your account</short-description>
921
922                <description>
923                        <para>
924                                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.
925                        </para>
926                </description>
927        </bitlbee-command>
928
929        <bitlbee-command name="blist">
930                <syntax>blist [all|online|offline|away]</syntax>
931                <short-description>List all the buddies in your contact list</short-description>
932
933                <description>
934                        <para>
935                                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.
936                        </para>
937                </description>
938
939        </bitlbee-command>
940
941        <bitlbee-command name="nick">
942                <short-description>Change friendly name, nick</short-description>
943                <syntax>nick &lt;connection&gt; [&lt;new nick&gt;]</syntax>
944                <syntax>nick &lt;connection&gt;</syntax>
945
946                <description>
947                        <para>
948                                Deprecated: Use the per-account <emphasis>display_name</emphasis> setting to read and change this information.
949                        </para>
950                </description>
951
952                <ircexample>
953                        <ircline nick="wouter">account set 1/display_name "The majestik møøse"</ircline>
954                        <ircline nick="root">display_name = `The majestik møøse'</ircline>
955                </ircexample>
956
957        </bitlbee-command>
958</chapter>
Note: See TracBrowser for help on using the repository browser.