source: doc/user-guide/commands.xml @ cce0450

Last change on this file since cce0450 was b79308b, checked in by ulim <a.sporto+bee@…>, at 2008-04-14T13:10:53Z

merged in upstream r379 (somewhere after 1.2-3).
Just one trivial conflict in the jabber Makefile, went smoothly.
  • Property mode set to 100644
File size: 35.9 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. 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.
166                        </para>
167                </description>
168
169                <ircexample>
170                        <ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
171                        <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
172                </ircexample>
173        </bitlbee-command>
174
175        <bitlbee-command name="info">
176                <short-description>Request user information</short-description>
177                <syntax>info &lt;connection&gt; &lt;handle&gt;</syntax>
178                <syntax>info &lt;nick&gt;</syntax>
179
180                <description>
181                        <para>
182                                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.
183                        </para>
184                </description>
185
186                <ircexample>
187                        <ircline nick="ctrlsoft">info 0 72696705</ircline>
188                        <ircline nick="root">User info - UIN: 72696705   Nick: Lintux   First/Last name: Wilmer van der Gaast   E-mail: lintux@lintux.cx</ircline>
189                </ircexample>
190
191        </bitlbee-command>
192
193        <bitlbee-command name="remove">
194                <short-description>Remove a buddy from your contact list</short-description>
195                <syntax>remove &lt;nick&gt;</syntax>
196
197                <description>
198                        <para>
199                                Removes the specified nick from your buddy list.
200                        </para>
201                </description>
202
203                <ircexample>
204                        <ircline nick="ctrlsoft">remove gryp</ircline>
205                        <ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction>
206                </ircexample>
207
208        </bitlbee-command>
209
210        <bitlbee-command name="block">
211                <short-description>Block someone</short-description>
212                <syntax>block &lt;nick&gt;</syntax>
213                <syntax>block &lt;connection&gt; &lt;handle&gt;</syntax>
214                <syntax>block &lt;connection&gt;</syntax>
215
216                <description>
217                        <para>
218                                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.
219                        </para>
220                       
221                        <para>
222                                When called with only a connection specification as an argument, the command displays the current block list for that connection.
223                        </para>
224                </description>
225        </bitlbee-command>
226
227        <bitlbee-command name="allow">
228                <short-description>Unblock someone</short-description>
229                <syntax>allow &lt;nick&gt;</syntax>
230                <syntax>allow &lt;connection&gt; &lt;handle&gt;</syntax>
231
232                <description>
233                        <para>
234                                Reverse of block. Unignores the specified user or user handle on specified connection.
235                        </para>
236                       
237                        <para>
238                                When called with only a connection specification as an argument, the command displays the current allow list for that connection.
239                        </para>
240                </description>
241        </bitlbee-command>
242
243        <bitlbee-command name="set">
244                <short-description>Miscellaneous settings</short-description>
245                <syntax>set</syntax>
246                <syntax>set &lt;variable&gt;</syntax>
247                <syntax>set &lt;variable&gt; &lt;value&gt;</syntax>
248                <syntax>set -del &lt;variable&gt;</syntax>
249
250                <description>
251
252                        <para>
253                                Without any arguments, this command lists all the set variables. You can also specify a single argument, a variable name, to get that variable's value. To change this value, specify the new value as the second argument. With <emphasis>-del</emphasis> you can reset a setting to its default value.
254                        </para>
255
256                        <para>
257                                To get more help information about a setting, try:
258                        </para>
259
260                </description>
261
262                <ircexample>
263                        <ircline nick="ctrlsoft">help set private</ircline>
264                </ircexample>
265
266        </bitlbee-command>
267
268        <bitlbee-command name="help">
269                <short-description>BitlBee help system</short-description>
270
271                <syntax>help [subject]</syntax>
272
273                <description>
274                        <para>
275                                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.
276                        </para>
277                </description>
278        </bitlbee-command>
279
280        <bitlbee-command name="save">
281                <short-description>Save your account data</short-description>
282                <syntax>save</syntax>
283
284                <description>
285                        <para>
286                                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... ;-)
287                        </para>
288                </description>
289        </bitlbee-command>
290
291        <bitlbee-setting name="auto_connect" type="boolean" scope="both">
292                <default>true</default>
293
294                <description>
295                        <para>
296                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
297                        </para>
298                       
299                        <para>
300                                This setting can also be changed for specific accounts using the <emphasis>account set</emphasis> command. (However, these values will be ignored if the global <emphasis>auto_connect</emphasis> setting is disabled!)
301                        </para>
302                </description>
303        </bitlbee-setting>
304
305        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
306                <default>false</default>
307
308                <description>
309                        <para>
310                                If an IM-connections breaks, you're supposed to bring it back up yourself. Having BitlBee do this automatically might not always be a good idea, for several reasons. If you want the connections to be restored automatically, you can enable this setting.
311                        </para>
312
313                        <para>
314                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
315                        </para>
316
317                        <para>
318                                This setting can also be changed for specific accounts using the <emphasis>account set</emphasis> command. (However, these values will be ignored if the global <emphasis>auto_reconnect</emphasis> setting is disabled!)
319                        </para>
320                </description>
321        </bitlbee-setting>
322
323        <bitlbee-setting name="auto_reconnect_delay" type="integer" scope="global">
324                <default>300</default>
325
326                <description>
327                        <para>
328                                Tell BitlBee after how many seconds it should attempt to bring an IM-connection back up after a crash. It's not a good idea to set this value very low, it will cause too much useless traffic when an IM-server is down for a few hours.
329                        </para>
330
331                        <para>
332                                See also the <emphasis>auto_reconnect</emphasis> setting.
333                        </para>
334                </description>
335        </bitlbee-setting>
336
337        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
338                <default>true</default>
339
340                <description>
341                        <para>
342                                With this option enabled, the root user devoices people when they go away (just away, not offline) and gives the voice back when they come back. You might dislike the voice-floods you'll get if your contact list is huge, so this option can be disabled.
343                        </para>
344                </description>
345        </bitlbee-setting>
346
347        <bitlbee-setting name="buddy_sendbuffer" type="boolean" scope="global">
348                <default>false</default>
349
350                <description>
351                        <para>
352                                By default, when you send a message to someone, BitlBee forwards this message to the user immediately. When you paste a large number of lines, the lines will be sent in separate messages, which might not be very nice to read. If you enable this setting, BitlBee will buffer your messages and wait for more data.
353                        </para>
354
355                        <para>
356                                Using the <emphasis>buddy_sendbuffer_delay</emphasis> setting you can specify the number of seconds BitlBee should wait for more data before the complete message is sent.
357                        </para>
358
359                        <para>
360                                Please note that if you remove a buddy from your list (or if the connection to that user drops) and there's still data in the buffer, this data will be lost. BitlBee will not try to send the message to the user in those cases.
361                        </para>
362                </description>
363        </bitlbee-setting>
364
365        <bitlbee-setting name="buddy_sendbuffer_delay" type="integer" scope="global">
366                <default>200</default>
367
368                <description>
369
370                        <para>
371                                Tell BitlBee after how many (mili)seconds a buffered message should be sent. Values greater than 5 will be interpreted as miliseconds, 5 and lower as seconds.
372                        </para>
373
374                        <para>
375                                See also the <emphasis>buddy_sendbuffer</emphasis> setting.
376                        </para>
377                </description>
378        </bitlbee-setting>
379
380        <bitlbee-setting name="charset" type="string" scope="global">
381                <default>utf-8</default>
382                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
383
384                <description>
385                        <para>
386                                This setting tells BitlBee what your IRC client sends and expects. It should be equal to the charset setting of your IRC client if you want to be able to send and receive non-ASCII text properly.
387                        </para>
388
389                        <para>
390                                Most systems use UTF-8 these days. On older systems, an iso8859 charset may work better. For example, iso8859-1 is the best choice for most Western countries. You can try to find what works best for you on http://www.unicodecharacter.com/charsets/iso8859.html
391                        </para>
392                </description>
393
394        </bitlbee-setting>
395
396        <bitlbee-setting name="debug" type="boolean" scope="global">
397                <default>false</default>
398
399                <description>
400                        <para>
401                                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.
402                        </para>
403                </description>
404        </bitlbee-setting>
405
406        <bitlbee-setting name="default_target" type="string" scope="global">
407                <default>root</default>
408                <possible-values>root, last</possible-values>
409
410                <description>
411                        <para>
412                                With this value set to <emphasis>root</emphasis>, lines written in the control channel without any nickname in front of them will be interpreted as commands. If you want BitlBee to send those lines to the last person you addressed in the control channel, set this to <emphasis>last</emphasis>.
413                        </para>
414                </description>
415        </bitlbee-setting>
416
417        <bitlbee-setting name="display_name" type="string" scope="account">
418                <description>
419                        <para>
420                                Currently only available for MSN connections. This setting allows you to read and change your "friendly name" for this connection. Since this is a server-side setting, it can't be changed when the account is off-line.
421                        </para>
422                </description>
423        </bitlbee-setting>
424
425        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
426                <default>false</default>
427
428                <description>
429                        <para>
430                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
431                        </para>
432                </description>
433        </bitlbee-setting>
434
435        <bitlbee-setting name="handle_unknown" type="string" scope="global">
436                <default>root</default>
437                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
438
439                <description>
440                        <para>
441                                Messages from unknown users are echoed like this by default:
442                        </para>
443
444                        <ircexample>
445                                <ircline nick="root">Unknown message from handle 3137137:</ircline>
446                                <ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
447                        </ircexample>
448
449                        <para>
450                                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.
451                        </para>
452
453                        <note>
454                                <para>
455                                        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.
456                                </para>
457                        </note>
458                </description>
459
460        </bitlbee-setting>
461
462        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
463                <default>true</default>
464
465                <description>
466                        <para>
467                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
468                        </para>
469                </description>
470
471        </bitlbee-setting>
472
473        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
474                <default>false</default>
475
476                <description>
477                        <para>
478                                Some protocols (MSN, Yahoo!) can notify via IM about new e-mail. Since most people use their Hotmail/Yahoo! addresses as a spam-box, this is disabled default. If you want these notifications, you can enable this setting.
479                        </para>
480                </description>
481
482        </bitlbee-setting>
483
484        <bitlbee-setting name="ops" type="string" scope="global">
485                <default>both</default>
486                <possible-values>both, root, user, none</possible-values>
487
488                <description>
489                        <para>
490                                Some people prefer themself and root to have operator status in &amp;bitlbee, other people don't. You can change these states using this setting.
491                        </para>
492
493                        <para>
494                                The value "both" means both user and root get ops. "root" means, well, just root. "user" means just the user. "none" means nobody will get operator status.
495                        </para>
496                </description>
497        </bitlbee-setting>
498
499        <bitlbee-setting name="password" type="string" scope="both">
500                <description>
501                        <para>
502                                Use this global setting to change your "NickServ" password.
503                        </para>
504                       
505                        <para>
506                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
507                        </para>
508                       
509                        <para>
510                                Note that BitlBee will always say this setting is empty. This doesn't mean there is no password, it just means that, for security reasons, BitlBee stores passwords somewhere else so they can't just be retrieved in plain text.
511                        </para>
512                </description>
513        </bitlbee-setting>
514       
515        <bitlbee-setting name="port" type="integer" scope="account">
516                <description>
517                        <para>
518                                Currently only available for Jabber connections. Specifies the port number to connect to. Usually this should be set to 5222, or 5223 for SSL-connections.
519                        </para>
520                </description>
521        </bitlbee-setting>
522
523        <bitlbee-setting name="priority" type="integer" scope="account">
524                <default>0</default>
525
526                <description>
527                        <para>
528                                Can be set for Jabber connections. When connecting to one account from multiple places, this priority value will help the server to determine where to deliver incoming messages (that aren't addressed to a specific resource already).
529                        </para>
530
531                        <para>
532                                According to RFC 3921 servers will always deliver messages to the server with the highest priority value. Mmessages will not be delivered to resources with a negative priority setting (and should be saved as an off-line message if all available resources have a negative priority value).
533                        </para>
534                </description>
535        </bitlbee-setting>
536
537        <bitlbee-setting name="private" type="boolean" scope="global">
538                <default>true</default>
539
540                <description>
541                        <para>
542                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
543                        </para>
544
545                        <para>
546                                This setting is remembered (during one session) per-user, this setting only changes the default state. This option takes effect as soon as you reconnect.
547                        </para>
548                </description>
549        </bitlbee-setting>
550
551        <bitlbee-setting name="query_order" type="string" scope="global">
552                <default>lifo</default>
553                <possible-values>lifo, fifo</possible-values>
554
555                <description>
556                        <para>
557                                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.
558                        </para>
559
560                        <para>
561                                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).
562                        </para>
563                </description>
564        </bitlbee-setting>
565
566        <bitlbee-setting name="resource" type="string" scope="account">
567                <default>BitlBee</default>
568
569                <description>
570                        <para>
571                                Can be set for Jabber connections. You can use this to connect to your Jabber account from multiple clients at once, with every client using a different resource string.
572                        </para>
573                </description>
574        </bitlbee-setting>
575
576        <bitlbee-setting name="resource_select" type="string" scope="account">
577                <default>priority</default>
578                <possible-values>priority, time</possible-values>
579
580                <description>
581                        <para>
582                                Because the IRC interface makes it pretty hard to specify the resource to talk to (when a buddy is online through different resources), this setting was added.
583                        </para>
584
585                        <para>
586                                Normally it's set to <emphasis>priority</emphasis> which means messages will always be delivered to the buddy's resource with the highest priority. If the setting is set to <emphasis>time</emphasis>, messages will be delivered to the resource that was last used to send you a message (or the resource that most recently connected).
587                        </para>
588                </description>
589        </bitlbee-setting>
590
591        <bitlbee-setting name="root_nick" type="string" scope="global">
592                <default>root</default>
593
594                <description>
595                        <para>
596                                Normally the "bot" that takes all your BitlBee commands is called "root". If you don't like this name, you can rename it to anything else using the <emphasis>rename</emphasis> command, or by changing this setting.
597                        </para>
598                </description>
599        </bitlbee-setting>
600
601        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
602                <default>true</default>
603
604                <description>
605                        <para>
606                                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.
607                        </para>
608                </description>
609        </bitlbee-setting>
610
611        <bitlbee-setting name="server" type="string" scope="account">
612                <description>
613                        <para>
614                                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.
615                        </para>
616                </description>
617        </bitlbee-setting>
618
619        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
620                <default>true</default>
621
622                <description>
623                        <para>
624                                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.
625                        </para>
626                </description>
627        </bitlbee-setting>
628
629        <bitlbee-setting name="ssl" type="boolean" scope="account">
630                <default>false</default>
631
632                <description>
633                        <para>
634                                Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
635                        </para>
636                </description>
637        </bitlbee-setting>
638
639        <bitlbee-setting name="strip_html" type="boolean" scope="global">
640                <default>true</default>
641
642                <description>
643                        <para>
644                                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.
645                        </para>
646                        <para>
647                                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.
648                        </para>
649                </description>
650        </bitlbee-setting>
651
652        <bitlbee-setting name="tls" type="boolean" scope="account">
653                <default>try</default>
654
655                <description>
656                        <para>
657                                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.
658                        </para>
659
660                        <para>
661                                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.
662                        </para>
663                </description>
664        </bitlbee-setting>
665
666        <bitlbee-setting name="to_char" type="string" scope="global">
667                <default>": "</default>
668
669                <description>
670                        <para>
671                                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>.
672                        </para>
673
674                        <para>
675                                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.
676                        </para>
677                </description>
678        </bitlbee-setting>
679
680        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
681                <default>false</default>
682
683                <description>
684                        <para>
685                                Sends you a /notice when a user starts typing a message (if supported by the IM protocol and the user's client). To use this, you most likely want to use a script in your IRC client to show this information in a more sensible way.
686                        </para>
687                </description>
688        </bitlbee-setting>
689
690        <bitlbee-setting name="web_aware" type="string" scope="account">
691                <default>false</default>
692
693                <description>
694                        <para>
695                                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.
696                        </para>
697
698                        <para>
699                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
700                        </para>
701                </description>
702        </bitlbee-setting>
703
704        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
705                <default>false</default>
706
707                <description>
708                        <para>
709                                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.
710                        </para>
711                        <para>
712                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
713                        </para>
714                </description>
715        </bitlbee-setting>
716
717        <bitlbee-command name="rename">
718                <short-description>Rename (renick) a buddy</short-description>
719                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
720
721                <description>
722                        <para>
723                                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).
724                        </para>
725                </description>
726
727                <ircexample>
728                        <ircline nick="itsme">rename itsme_ you</ircline>
729                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
730                </ircexample>
731
732        </bitlbee-command>
733
734        <bitlbee-command name="yes">
735                <short-description>Accept a request</short-description>
736                <syntax>yes [&lt;number&gt;]</syntax>
737
738                <description>
739                        <para>
740                                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.
741                        </para>
742
743                        <para>
744                                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.
745                        </para>
746                </description>
747
748        </bitlbee-command>
749
750        <bitlbee-command name="no">
751                <short-description>Deny a request</short-description>
752                <syntax>no [&lt;number&gt;]</syntax>
753
754                <description>
755                        <para>
756                                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.
757                        </para>
758
759                        <para>
760                                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.
761                        </para>
762                </description>
763        </bitlbee-command>
764
765        <bitlbee-command name="qlist">
766                <short-description>List all the unanswered questions root asked</short-description>
767                <syntax>qlist</syntax>
768
769                <description>
770                        <para>
771                                This gives you a list of all the unanswered questions from root.
772                        </para>
773                </description>
774
775        </bitlbee-command>
776
777        <bitlbee-command name="register">
778                <short-description>Register yourself</short-description>
779                <syntax>register &lt;password&gt;</syntax>
780
781                <description>
782                        <para>
783                                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.
784                        </para>
785
786                        <para>
787                                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.. ;-)
788                        </para>
789
790                        <para>
791                                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.
792                        </para>
793                </description>
794
795        </bitlbee-command>
796
797        <bitlbee-command name="identify">
798                <syntax>identify &lt;password&gt;</syntax>
799                <short-description>Identify yourself with your password</short-description>
800
801                <description>
802                        <para>
803                                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.
804                        </para>
805
806                        <para>
807                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
808                        </para>
809                </description>
810        </bitlbee-command>
811
812        <bitlbee-command name="drop">
813                <syntax>drop &lt;password&gt;</syntax>
814                <short-description>Drop your account</short-description>
815
816                <description>
817                        <para>
818                                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.
819                        </para>
820                </description>
821        </bitlbee-command>
822
823        <bitlbee-command name="blist">
824                <syntax>blist [all|online|offline|away]</syntax>
825                <short-description>List all the buddies in your contact list</short-description>
826
827                <description>
828                        <para>
829                                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.
830                        </para>
831                </description>
832
833        </bitlbee-command>
834
835        <bitlbee-command name="nick">
836                <short-description>Change friendly name, nick</short-description>
837                <syntax>nick &lt;connection&gt; [&lt;new nick&gt;]</syntax>
838                <syntax>nick &lt;connection&gt;</syntax>
839
840                <description>
841                        <para>
842                                Deprecated: Use the per-account <emphasis>display_name</emphasis> setting to read and change this information.
843                        </para>
844                </description>
845
846                <ircexample>
847                        <ircline nick="wouter">account set 1/display_name "The majestik møøse"</ircline>
848                        <ircline nick="root">display_name = `The majestik møøse'</ircline>
849                </ircexample>
850
851        </bitlbee-command>
852
853        <bitlbee-command name="join_chat">
854                <short-description>Join a named groupchat/conference room</short-description>
855                <syntax>join_chat &lt;connection&gt; &lt;room name&gt; [&lt;channel name&gt;] [&lt;room nickname&gt;] [&lt;password&gt;]</syntax>
856
857                <description>
858                        <para>
859                                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.
860                        </para>
861
862                        <para>
863                                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.
864                        </para>
865
866                        <para>
867                                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>.
868                        </para>
869                </description>
870
871                <ircexample>
872                        <ircline nick="wilmer">join_chat jabber bitlbee@conference.bitlbee.org &amp;bitlbee-help help-me</ircline>
873                </ircexample>
874
875        </bitlbee-command>
876       
877        <bitlbee-command name="transfers">
878                <short-description>Monitor, cancel, or reject file transfers</short-description>
879                <syntax>transfers [&lt;cancel&gt; id | &lt;reject&gt;]</syntax>
880               
881                <description>
882                        <para>
883                                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.
884                        </para>
885
886                        <ircexample>
887                                <ircline nick="ulim">transfers</ircline>
888                        </ircexample>
889                </description>
890               
891                <bitlbee-command name="cancel">
892                        <short-description>Cancels the file transfer with the given id</short-description>
893                        <syntax>transfers &lt;cancel&gt; id</syntax>
894
895                        <description>
896                                <para>Cancels the file transfer with the given id</para>
897                        </description>
898
899                        <ircexample>
900                                <ircline nick="ulim">transfers cancel 1</ircline>
901                                <ircline nick="root">Canceling file transfer for test</ircline>
902                        </ircexample>
903                </bitlbee-command>
904
905                <bitlbee-command name="reject">
906                        <short-description>Rejects all incoming transfers</short-description>
907                        <syntax>transfers &lt;reject&gt;</syntax>
908
909                        <description>
910                                <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>
911                        </description>
912
913                        <ircexample>
914                                <ircline nick="ulim">transfers reject</ircline>
915                        </ircexample>
916                </bitlbee-command>
917        </bitlbee-command>
918       
919</chapter>
Note: See TracBrowser for help on using the repository browser.