source: doc/user-guide/commands.xml @ 1dd3470

Last change on this file since 1dd3470 was bb09b3c, checked in by Sven Moritz Hallberg <pesco@…>, at 2010-06-03T21:13:57Z

merge in bitlbee 1.2.7
  • Property mode set to 100644
File size: 53.0 KB
Line 
1<chapter id="commands">
2        <title>Bitlbee commands</title>
3
4        <command-list/>
5
6        <bitlbee-command name="account">
7                <short-description>IM-account list maintenance</short-description>
8                <syntax>account &lt;action&gt; [&lt;arguments&gt;]</syntax>
9
10                <description>
11
12                        <para>
13                                Available actions: add, del, list, on, off and set. See <emphasis>help account &lt;action&gt;</emphasis> for more information.
14                        </para>
15
16                </description>
17
18                <bitlbee-command name="add">
19                        <syntax>account add &lt;protocol&gt; &lt;username&gt; &lt;password&gt;</syntax>
20
21                        <description>
22                                <para>
23                                        Adds an account on the given server with the specified protocol, username and password to the account list. Supported protocols right now are: Jabber, MSN, OSCAR (AIM/ICQ), Yahoo and Twitter. 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="twitter">
67                                <syntax>account add twitter &lt;handle&gt; &lt;password&gt;</syntax>
68
69                                <description>
70                                        <para>
71                                                This module gives you simple access to Twitter. Although it uses the Twitter API, only Twitter itself is supported at the moment.
72                                        </para>
73                                       
74                                        <para>
75                                                By default all your Twitter contacts will come from a contact called twitter_(yourusername). You can change this behaviour using the <emphasis>mode</emphasis> setting (see <emphasis>help set mode</emphasis>).
76                                        </para>
77                                       
78                                        <para>
79                                                To send tweets yourself, send them to the twitter_(yourusername) contact, or just write in the groupchat channel if you enabled that option.
80                                        </para>
81
82                                        <para>
83                                                Since Twitter now requires OAuth authentication, you should not enter your Twitter password into BitlBee. Just type a bogus password. The first time you log in, BitlBee will start OAuth authentication. (See <emphasis>help set oauth</emphasis>.)
84                                        </para>
85                                </description>
86                        </bitlbee-command>
87
88                        <bitlbee-command name="yahoo">
89                                <syntax>account add yahoo &lt;handle&gt; &lt;password&gt;</syntax>
90
91                                <description>
92                                        <para>
93                                                For Yahoo! connections there are no special arguments.
94                                        </para>
95                                </description>
96                        </bitlbee-command>
97
98                </bitlbee-command>
99
100                <bitlbee-command name="del">
101                        <syntax>account del &lt;account id&gt;</syntax>
102
103                        <description>
104                                <para>
105                                        This commands deletes an account from your account list. You should signoff the account before deleting it.
106                                </para>
107
108
109                                <para>
110                                        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.
111                                </para>
112                        </description>
113                </bitlbee-command>
114
115                <bitlbee-command name="on">
116                        <syntax>account on [&lt;account id&gt;]</syntax>
117
118                        <description>
119                                <para>
120                                        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.
121                                </para>
122
123                                <para>
124                                        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.
125                                </para>
126                        </description>
127
128                </bitlbee-command>
129
130                <bitlbee-command name="off">
131                        <syntax>account off [&lt;account id&gt;]</syntax>
132
133                        <description>
134                                <para>
135                                        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.
136                                </para>
137
138                                <para>
139                                        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.
140                                </para>
141                        </description>
142                </bitlbee-command>
143
144                <bitlbee-command name="list">
145                        <syntax>account list</syntax>
146
147                        <description>
148                                <para>
149                                        This command gives you a list of all the accounts known by BitlBee.
150                                </para>
151                        </description>
152                </bitlbee-command>
153
154                <bitlbee-command name="set">
155                        <syntax>account set &lt;account id&gt;</syntax>
156                        <syntax>account set &lt;account id&gt;/&lt;setting&gt;</syntax>
157                        <syntax>account set &lt;account id&gt;/&lt;setting&gt; &lt;value&gt;</syntax>
158                        <syntax>account set -del &lt;account id&gt;/&lt;setting&gt;</syntax>
159
160                        <description>
161                                <para>
162                                        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>.
163                                </para>
164                               
165                                <para>
166                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
167                                </para>
168                               
169                                <para>
170                                        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.
171                                </para>
172                        </description>
173                </bitlbee-command>
174        </bitlbee-command>
175
176        <bitlbee-command name="chat">
177                <short-description>Chatroom list maintenance</short-description>
178                <syntax>chat &lt;action&gt; [&lt;arguments&gt;]</syntax>
179
180                <description>
181
182                        <para>
183                                Available actions: add, del, list, with and set. See <emphasis>help chat &lt;action&gt;</emphasis> for more information.
184                        </para>
185
186                </description>
187
188                <bitlbee-command name="add">
189                        <syntax>chat add &lt;account&gt; &lt;room&gt; [&lt;channel&gt;]</syntax>
190
191                        <description>
192                                <para>
193                                        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.
194                                </para>
195
196                                <para>
197                                        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>)
198                                </para>
199
200                                <para>
201                                        Password-protected rooms work exactly like on IRC, by passing the password as an extra argument to /join.
202                                </para>
203                        </description>
204
205                </bitlbee-command>
206
207                <bitlbee-command name="del">
208                        <syntax>chat del &lt;chat id&gt;</syntax>
209
210                        <description>
211                                <para>
212                                        This commands deletes an chatroom from your list.
213                                </para>
214
215                                <para>
216                                        The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.
217                                </para>
218                        </description>
219                </bitlbee-command>
220
221                <bitlbee-command name="list">
222                        <syntax>chat list</syntax>
223
224                        <description>
225                                <para>
226                                        This command gives you a list of all the chatrooms known by BitlBee.
227                                </para>
228                        </description>
229                </bitlbee-command>
230
231                <bitlbee-command name="with">
232                        <syntax>chat with &lt;nickname&gt;</syntax>
233
234                        <description>
235                                <para>
236                                        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.
237                                </para>
238                        </description>
239                </bitlbee-command>
240
241                <bitlbee-command name="set">
242                        <syntax>chat set &lt;chat id&gt;</syntax>
243                        <syntax>chat set &lt;chat id&gt;/&lt;setting&gt;</syntax>
244                        <syntax>chat set &lt;chat id&gt;/&lt;setting&gt; &lt;value&gt;</syntax>
245                        <syntax>chat set -del &lt;chat id&gt;/&lt;setting&gt;</syntax>
246
247                        <description>
248                                <para>
249                                        This command can be used to change various settings for chatrooms.
250                                </para>
251                               
252                                <para>
253                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
254                                </para>
255                               
256                                <para>
257                                        The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.
258                                </para>
259                        </description>
260                </bitlbee-command>
261        </bitlbee-command>
262
263        <bitlbee-command name="add">
264                <short-description>Add a buddy to your contact list</short-description>
265                <syntax>add &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
266                <syntax>add -tmp &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
267
268                <description>
269                        <para>
270                                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.
271                        </para>
272
273                        <para>
274                                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.
275                        </para>
276                </description>
277
278                <ircexample>
279                        <ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
280                        <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
281                </ircexample>
282        </bitlbee-command>
283
284        <bitlbee-command name="info">
285                <short-description>Request user information</short-description>
286                <syntax>info &lt;connection&gt; &lt;handle&gt;</syntax>
287                <syntax>info &lt;nick&gt;</syntax>
288
289                <description>
290                        <para>
291                                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.
292                        </para>
293                </description>
294
295                <ircexample>
296                        <ircline nick="ctrlsoft">info 0 72696705</ircline>
297                        <ircline nick="root">User info - UIN: 72696705   Nick: Lintux   First/Last name: Wilmer van der Gaast   E-mail: lintux@lintux.cx</ircline>
298                </ircexample>
299
300        </bitlbee-command>
301
302        <bitlbee-command name="remove">
303                <short-description>Remove a buddy from your contact list</short-description>
304                <syntax>remove &lt;nick&gt;</syntax>
305
306                <description>
307                        <para>
308                                Removes the specified nick from your buddy list.
309                        </para>
310                </description>
311
312                <ircexample>
313                        <ircline nick="ctrlsoft">remove gryp</ircline>
314                        <ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction>
315                </ircexample>
316
317        </bitlbee-command>
318
319        <bitlbee-command name="block">
320                <short-description>Block someone</short-description>
321                <syntax>block &lt;nick&gt;</syntax>
322                <syntax>block &lt;connection&gt; &lt;handle&gt;</syntax>
323                <syntax>block &lt;connection&gt;</syntax>
324
325                <description>
326                        <para>
327                                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.
328                        </para>
329                       
330                        <para>
331                                When called with only a connection specification as an argument, the command displays the current block list for that connection.
332                        </para>
333                </description>
334        </bitlbee-command>
335
336        <bitlbee-command name="allow">
337                <short-description>Unblock someone</short-description>
338                <syntax>allow &lt;nick&gt;</syntax>
339                <syntax>allow &lt;connection&gt; &lt;handle&gt;</syntax>
340
341                <description>
342                        <para>
343                                Reverse of block. Unignores the specified user or user handle on specified connection.
344                        </para>
345                       
346                        <para>
347                                When called with only a connection specification as an argument, the command displays the current allow list for that connection.
348                        </para>
349                </description>
350        </bitlbee-command>
351       
352        <bitlbee-command name="otr">
353                <short-description>Off-the-Record encryption control</short-description>
354                <syntax>otr &lt;subcommand&gt; [&lt;arguments&gt;]</syntax>
355
356                <description>
357
358                        <para>
359                                Available subcommands: connect, disconnect, smp, trust, info, keygen, and forget. See <emphasis>help otr &lt;subcommand&gt;</emphasis> for more information.
360                        </para>
361
362                </description>
363               
364                <bitlbee-command name="connect">
365                        <syntax>otr connect &lt;nick&gt;</syntax>
366                       
367                        <description>
368                       
369                                <para>
370                                        Attempts to establish an encrypted connection with the specified user by sending a magic string.
371                                </para>
372                               
373                        </description>
374               
375                </bitlbee-command>
376               
377                <bitlbee-command name="disconnect">
378                        <syntax>otr disconnect &lt;nick&gt;</syntax>
379                       
380                        <description>
381                       
382                                <para>
383                                        Resets the connection with the specified user to cleartext.
384                                </para>
385                               
386                        </description>
387               
388                </bitlbee-command>
389               
390                <bitlbee-command name="smp">
391                        <syntax>otr smp &lt;nick&gt; &lt;secret&gt;</syntax>
392                       
393                        <description>
394                       
395                                <para>
396                                        Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol.
397                                </para>
398                               
399                                <para>
400                                        If an SMP challenge has already been received from the given user, responds with the specified secret. Otherwise, a challenge for the secret will be sent. If the protocol succeeds (i.e. both parties gave the same secret), the fingerprint will be trusted.
401                                </para>
402                               
403                        </description>
404               
405                </bitlbee-command>
406               
407                <bitlbee-command name="trust">
408                        <syntax>otr trust &lt;nick&gt; &lt;fp1&gt; &lt;fp2&gt; &lt;fp3&gt; &lt;fp4&gt; &lt;fp5&gt;</syntax>
409                       
410                        <description>
411                       
412                                <para>
413                                        Manually affirms trust in the specified fingerprint, given as five blocks of precisely eight (hexadecimal) digits each.
414                                </para>
415                               
416                        </description>
417               
418                </bitlbee-command>
419               
420                <bitlbee-command name="info">
421                        <syntax>otr info</syntax>
422                        <syntax>otr info &lt;nick&gt;</syntax>
423                       
424                        <description>
425                       
426                                <para>
427                                        Shows information about the OTR state. The first form lists our private keys and current OTR contexts. The second form displays information about the connection with a given user, including the list of their known fingerprints.
428                                </para>
429                               
430                        </description>
431               
432                </bitlbee-command>
433               
434                <bitlbee-command name="keygen">
435                        <syntax>otr keygen &lt;account-no&gt;</syntax>
436                       
437                        <description>
438                       
439                                <para>
440                                        Generates a new OTR private key for the given account.
441                                </para>
442                               
443                        </description>
444               
445                </bitlbee-command>
446               
447                <bitlbee-command name="forget">
448                        <syntax>otr forget &lt;thing&gt; &lt;arguments&gt;</syntax>
449                       
450                        <description>
451                       
452                                <para>
453                                        Forgets some part of our OTR userstate. Available things: fingerprint, context, and key. See <emphasis>help otr forget &lt;thing&gt;</emphasis> for more information.
454                                </para>
455                       
456                        </description>
457                       
458                        <bitlbee-command name="fingerprint">
459                                <syntax>otr forget fingerprint &lt;nick&gt; &lt;fingerprint&gt;</syntax>
460                               
461                                <description>
462                               
463                                        <para>
464                                                Drops the specified fingerprint from the given user's OTR connection context. It is allowed to specify only a (unique) prefix of the desired fingerprint.
465                                        </para>
466                                       
467                                </description>
468                               
469                        </bitlbee-command>
470                               
471                        <bitlbee-command name="context">
472                                <syntax>otr forget context &lt;nick&gt;</syntax>
473                               
474                                <description>
475                               
476                                        <para>
477                                                Forgets the entire OTR context associated with the given user. This includes current message and protocol states, as well as any fingerprints for that user.
478                                        </para>
479                                       
480                                </description>
481                               
482                        </bitlbee-command>
483
484                        <bitlbee-command name="key">
485                                <syntax>otr forget key &lt;fingerprint&gt;</syntax>
486                               
487                                <description>
488                               
489                                        <para>
490                                                Forgets an OTR private key matching the specified fingerprint. It is allowed to specify only a (unique) prefix of the fingerprint.
491                                        </para>
492                                       
493                                </description>
494                               
495                        </bitlbee-command>
496               
497                </bitlbee-command>
498               
499        </bitlbee-command>
500
501        <bitlbee-command name="set">
502                <short-description>Miscellaneous settings</short-description>
503                <syntax>set</syntax>
504                <syntax>set &lt;variable&gt;</syntax>
505                <syntax>set &lt;variable&gt; &lt;value&gt;</syntax>
506                <syntax>set -del &lt;variable&gt;</syntax>
507
508                <description>
509
510                        <para>
511                                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.
512                        </para>
513
514                        <para>
515                                To get more help information about a setting, try:
516                        </para>
517
518                </description>
519
520                <ircexample>
521                        <ircline nick="ctrlsoft">help set private</ircline>
522                </ircexample>
523
524        </bitlbee-command>
525
526        <bitlbee-command name="help">
527                <short-description>BitlBee help system</short-description>
528
529                <syntax>help [subject]</syntax>
530
531                <description>
532                        <para>
533                                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.
534                        </para>
535                </description>
536        </bitlbee-command>
537
538        <bitlbee-command name="save">
539                <short-description>Save your account data</short-description>
540                <syntax>save</syntax>
541
542                <description>
543                        <para>
544                                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... ;-)
545                        </para>
546                </description>
547        </bitlbee-command>
548
549        <bitlbee-setting name="auto_connect" type="boolean" scope="both">
550                <default>true</default>
551
552                <description>
553                        <para>
554                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
555                        </para>
556                       
557                        <para>
558                                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!)
559                        </para>
560                </description>
561        </bitlbee-setting>
562
563        <bitlbee-setting name="auto_join" type="boolean" scope="chat">
564                <default>false</default>
565
566                <description>
567                        <para>
568                                With this option enabled, BitlBee will automatically join this chatroom when you log in.
569                        </para>
570                </description>
571        </bitlbee-setting>
572
573        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
574                <default>true</default>
575
576                <description>
577                        <para>
578                                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.
579                        </para>
580
581                        <para>
582                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
583                        </para>
584
585                        <para>
586                                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!)
587                        </para>
588                </description>
589        </bitlbee-setting>
590
591        <bitlbee-setting name="auto_reconnect_delay" type="string" scope="global">
592                <default>5*3&lt;900</default>
593
594                <description>
595                        <para>
596                                Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up.
597                        </para>
598
599                        <para>
600                                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.
601                        </para>
602
603                        <para>
604                                See also the <emphasis>auto_reconnect</emphasis> setting.
605                        </para>
606                </description>
607        </bitlbee-setting>
608
609        <bitlbee-setting name="away" type="string" scope="both">
610                <description>
611                        <para>
612                                To mark yourself as away, it is recommended to just use <emphasis>/away</emphasis>, like on normal IRC networks. If you want to mark yourself as away on only one IM network, you can use this per-account setting.
613                        </para>
614
615                        <para>
616                                You can set it to any value and BitlBee will try to map it to the most appropriate away state for every open IM connection, or set it as a free-form away message where possible.
617                        </para>
618
619                        <para>
620                                Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>.
621                        </para>
622                </description>
623        </bitlbee-setting>
624
625        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
626                <default>true</default>
627
628                <description>
629                        <para>
630                                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.
631                        </para>
632                </description>
633        </bitlbee-setting>
634
635        <bitlbee-setting name="buddy_sendbuffer" type="boolean" scope="global">
636                <default>false</default>
637
638                <description>
639                        <para>
640                                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.
641                        </para>
642
643                        <para>
644                                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.
645                        </para>
646
647                        <para>
648                                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.
649                        </para>
650                </description>
651        </bitlbee-setting>
652
653        <bitlbee-setting name="buddy_sendbuffer_delay" type="integer" scope="global">
654                <default>200</default>
655
656                <description>
657
658                        <para>
659                                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.
660                        </para>
661
662                        <para>
663                                See also the <emphasis>buddy_sendbuffer</emphasis> setting.
664                        </para>
665                </description>
666        </bitlbee-setting>
667
668        <bitlbee-setting name="charset" type="string" scope="global">
669                <default>utf-8</default>
670                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
671
672                <description>
673                        <para>
674                                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.
675                        </para>
676
677                        <para>
678                                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
679                        </para>
680                </description>
681
682        </bitlbee-setting>
683
684        <bitlbee-setting name="color_encrypted" type="boolean" scope="global">
685                <default>true</default>
686
687                <description>
688                        <para>
689                                If set to true, BitlBee will color incoming encrypted messages according to their fingerprint trust level: untrusted=red, trusted=green.
690                        </para>
691                </description>
692        </bitlbee-setting>
693
694        <bitlbee-setting name="control_channel" type="string" scope="global">
695                <default>&amp;bitlbee</default>
696
697                <description>
698                        <para>
699                                Normally the control channel where you can see all your contacts is called "&amp;bitlbee". 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.
700                        </para>
701                </description>
702        </bitlbee-setting>
703
704        <bitlbee-setting name="debug" type="boolean" scope="global">
705                <default>false</default>
706
707                <description>
708                        <para>
709                                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.
710                        </para>
711                </description>
712        </bitlbee-setting>
713
714        <bitlbee-setting name="default_target" type="string" scope="global">
715                <default>root</default>
716                <possible-values>root, last</possible-values>
717
718                <description>
719                        <para>
720                                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>.
721                        </para>
722                </description>
723        </bitlbee-setting>
724
725        <bitlbee-setting name="display_name" type="string" scope="account">
726                <description>
727                        <para>
728                                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.
729                        </para>
730                </description>
731        </bitlbee-setting>
732
733        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
734                <default>false</default>
735
736                <description>
737                        <para>
738                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
739                        </para>
740                </description>
741        </bitlbee-setting>
742
743        <bitlbee-setting name="display_timestamps" type="boolean" scope="global">
744                <default>true</default>
745
746                <description>
747                        <para>
748                                When incoming messages are old (i.e. offline messages and channel backlogs), BitlBee will prepend them with a timestamp. If you find them ugly or useless, you can use this setting to hide them.
749                        </para>
750                </description>
751        </bitlbee-setting>
752
753        <bitlbee-setting name="handle_unknown" type="string" scope="global">
754                <default>root</default>
755                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
756
757                <description>
758                        <para>
759                                Messages from unknown users are echoed like this by default:
760                        </para>
761
762                        <ircexample>
763                                <ircline nick="root">Unknown message from handle 3137137:</ircline>
764                                <ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
765                        </ircexample>
766
767                        <para>
768                                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.
769                        </para>
770
771                        <note>
772                                <para>
773                                        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.
774                                </para>
775                        </note>
776                </description>
777
778        </bitlbee-setting>
779
780        <bitlbee-setting name="halfop_buddies" type="string" scope="global">
781                <default>encrypted</default>
782                <possible-values>encrypted, trusted, notaway, online, false</possible-values>
783
784                <description>
785                        <para>
786                                Specifies under which circumstances BitlBee should give the "halfop" mode flag (+h) to buddies.
787                        </para>
788                       
789                        <para>
790                                If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key. On "online", the flag is set whenever the user is online; only meaningful in conjunction with "show_offline".
791                        </para>
792                </description>
793        </bitlbee-setting>
794
795        <bitlbee-setting name="ignore_auth_requests" type="boolean" scope="account">
796                <default>true</default>
797
798                <description>
799                        <para>
800                                Only supported by OSCAR so far, you can use this setting to ignore ICQ authorization requests, which are hardly used for legitimate (i.e. non-spam) reasons anymore.
801                        </para>
802                </description>
803        </bitlbee-setting>
804
805        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
806                <default>true</default>
807
808                <description>
809                        <para>
810                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
811                        </para>
812                </description>
813
814        </bitlbee-setting>
815
816        <bitlbee-setting name="local_display_name" type="boolean" scope="account">
817                <default>false</default>
818
819                <description>
820                        <para>
821                                Mostly meant to work around a bug in MSN servers (forgetting the display name set by the user), this setting tells BitlBee to store your display name locally and set this name on the MSN servers when connecting.
822                        </para>
823                </description>
824
825        </bitlbee-setting>
826
827        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
828                <default>false</default>
829
830                <description>
831                        <para>
832                                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.
833                        </para>
834                </description>
835
836        </bitlbee-setting>
837
838        <bitlbee-setting name="op_buddies" type="string" scope="global">
839                <default>trusted</default>
840                <possible-values>encrypted, trusted, notaway, online, false</possible-values>
841
842                <description>
843                        <para>
844                                Specifies under which circumstances BitlBee should give the "op" mode flag (+o) to buddies.
845                        </para>
846                       
847                        <para>
848                                If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key. On "online", the flag is set whenever the user is online; only meaningful in conjunction with "show_offline".
849                        </para>
850                </description>
851
852        </bitlbee-setting>
853
854        <bitlbee-setting name="op_root" type="bool" scope="global">
855                <default>true</default>
856
857                <description>
858                        <para>
859                                Some people prefer themself and root to have operator status in &amp;bitlbee, other people don't. You can set the desired state for root using this setting.
860                        </para>
861                </description>
862        </bitlbee-setting>
863
864        <bitlbee-setting name="op_user" type="bool" scope="global">
865                <default>true</default>
866
867                <description>
868                        <para>
869                                Some people prefer themself and root to have operator status in &amp;bitlbee, other people don't. You can set the desired state for yourself using this setting.
870                        </para>
871                </description>
872        </bitlbee-setting>
873
874        <bitlbee-setting name="otr_policy" type="string" scope="global">
875                <default>opportunistic</default>
876                <possible-values>never, opportunistic, manual, always</possible-values>
877
878                <description>
879                        <para>
880                                This setting controls the policy for establishing Off-the-Record connections.
881                        </para>
882                        <para>
883                                A value of "never" effectively disables the OTR subsystem. In "opportunistic" mode, a magic whitespace pattern will be appended to the first message sent to any user. If the peer is also running opportunistic OTR, an encrypted connection will be set up automatically. On "manual", on the other hand, OTR connections must be established explicitly using <emphasis>otr connect</emphasis>. Finally, the setting "always" enforces encrypted communication by causing BitlBee to refuse to send any cleartext messages at all.
884                        </para>
885                </description>
886        </bitlbee-setting>
887
888        <bitlbee-setting name="message_length" type="integer" scope="account">
889                <default>140</default>
890
891                <description>
892                        <para>
893                                Since Twitter rejects messages longer than 140 characters, BitlBee can count message length and emit a warning instead of waiting for Twitter to reject it.
894                        </para>
895
896                        <para>
897                                You can change this limit here but this won't disable length checks on Twitter's side. You can also set it to 0 to disable the check in case you believe BitlBee doesn't count the characters correctly.
898                        </para>
899                </description>
900
901        </bitlbee-setting>
902
903        <bitlbee-setting name="mode" type="string" scope="account">
904                <possible-values>one, many, chat</possible-values>
905                <default>one</default>
906
907                <description>
908                        <para>
909                                By default, everything from the Twitter module will come from one nick, twitter_(yourusername). If you prefer to have individual nicks for everyone, you can set this setting to "many" instead.
910                        </para>
911                       
912                        <para>
913                                If you prefer to have all your Twitter things in a separate channel, you can set this setting to "chat".
914                        </para>
915                       
916                        <para>
917                                In the last two modes, you can send direct messages by /msg'ing your contacts directly. Note, however, that incoming DMs are not fetched yet.
918                        </para>
919                </description>
920        </bitlbee-setting>
921
922        <bitlbee-setting name="nick" type="string" scope="chat">
923
924                <description>
925                        <para>
926                                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.
927                        </para>
928                </description>
929        </bitlbee-setting>
930
931        <bitlbee-setting name="nick_source" type="string" scope="account">
932                <default>handle</default>
933                <possible-values>handle, full_name, first_name</possible-values>
934
935                <description>
936                        <para>
937                                By default, BitlBee generates a nickname for every contact by taking its handle and chopping off everything after the @. In some cases, this gives very inconvenient nicknames. The Facebook XMPP server is a good example, as all Facebook XMPP handles are numeric.
938                        </para>
939
940                        <para>
941                                With this setting set to <emphasis>full_name</emphasis>, the person's full name is used to generate a nickname. Or if you don't like long nicknames, set this setting to <emphasis>first_name</emphasis> instead and only the first word will be used. Note that the full name can be full of non-ASCII characters which will be stripped off.
942                        </para>
943                </description>
944        </bitlbee-setting>
945
946        <bitlbee-setting name="oauth" type="boolean" scope="account">
947                <default>true</default>
948
949                <description>
950                        <para>
951                                This enables OAuth authentication for Twitter accounts. From June 2010 this will be mandatory.
952                        </para>
953
954                        <para>
955                                With OAuth enabled, you shouldn't tell BitlBee your Twitter password. Just add your account with a bogus password and type <emphasis>account on</emphasis>. BitlBee will then give you a URL to authenticate with Twitter. If this succeeds, Twitter will return a PIN code which you can give back to BitlBee to finish the process.
956                        </para>
957
958                        <para>
959                                The resulting access token will be saved permanently, so you have to do this only once.
960                        </para>
961                </description>
962
963        </bitlbee-setting>
964
965        <bitlbee-setting name="ops" type="string" scope="global">
966                <default>both</default>
967                <possible-values>both, root, user, none</possible-values>
968
969                <description>
970                        <para>
971                                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.
972                        </para>
973
974                        <para>
975                                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.
976                        </para>
977                </description>
978        </bitlbee-setting>
979
980        <bitlbee-setting name="password" type="string" scope="both">
981                <description>
982                        <para>
983                                Use this global setting to change your "NickServ" password.
984                        </para>
985                       
986                        <para>
987                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
988                        </para>
989                       
990                        <para>
991                                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.
992                        </para>
993                </description>
994        </bitlbee-setting>
995       
996        <bitlbee-setting name="port" type="integer" scope="account">
997                <description>
998                        <para>
999                                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.
1000                        </para>
1001                </description>
1002        </bitlbee-setting>
1003
1004        <bitlbee-setting name="priority" type="integer" scope="account">
1005                <default>0</default>
1006
1007                <description>
1008                        <para>
1009                                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).
1010                        </para>
1011
1012                        <para>
1013                                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).
1014                        </para>
1015                </description>
1016        </bitlbee-setting>
1017
1018        <bitlbee-setting name="private" type="boolean" scope="global">
1019                <default>true</default>
1020
1021                <description>
1022                        <para>
1023                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
1024                        </para>
1025
1026                        <para>
1027                                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.
1028                        </para>
1029                </description>
1030        </bitlbee-setting>
1031
1032        <bitlbee-setting name="query_order" type="string" scope="global">
1033                <default>lifo</default>
1034                <possible-values>lifo, fifo</possible-values>
1035
1036                <description>
1037                        <para>
1038                                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.
1039                        </para>
1040
1041                        <para>
1042                                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).
1043                        </para>
1044                </description>
1045        </bitlbee-setting>
1046
1047        <bitlbee-setting name="resource" type="string" scope="account">
1048                <default>BitlBee</default>
1049
1050                <description>
1051                        <para>
1052                                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.
1053                        </para>
1054                </description>
1055        </bitlbee-setting>
1056
1057        <bitlbee-setting name="resource_select" type="string" scope="account">
1058                <default>activity</default>
1059                <possible-values>priority, activity</possible-values>
1060
1061                <description>
1062                        <para>
1063                                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.
1064                        </para>
1065
1066                        <para>
1067                                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).
1068                        </para>
1069                </description>
1070        </bitlbee-setting>
1071
1072        <bitlbee-setting name="root_nick" type="string" scope="global">
1073                <default>root</default>
1074
1075                <description>
1076                        <para>
1077                                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.
1078                        </para>
1079                </description>
1080        </bitlbee-setting>
1081
1082        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
1083                <default>true</default>
1084
1085                <description>
1086                        <para>
1087                                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.
1088                        </para>
1089                </description>
1090        </bitlbee-setting>
1091
1092        <bitlbee-setting name="server" type="string" scope="account">
1093                <description>
1094                        <para>
1095                                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.
1096                        </para>
1097                </description>
1098        </bitlbee-setting>
1099
1100        <bitlbee-setting name="show_offline" type="boolean" scope="global">
1101                <default>false</default>
1102
1103                <description>
1104                        <para>
1105                                If enabled causes BitlBee to also show offline users in Channel. You may want to adjust the settings "voice_buddies", "halfop_buddies" and "op_buddies" according to your liking. A reasonable candidate is "voice_buddies=online", "halfop_buddies=false", "op_buddies=notaway".
1106                        </para>
1107                        <para>
1108                                This option takes effect as soon as you reconnect.
1109                        </para>
1110                </description>
1111        </bitlbee-setting>
1112
1113        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
1114                <default>true</default>
1115
1116                <description>
1117                        <para>
1118                                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.
1119                        </para>
1120                </description>
1121        </bitlbee-setting>
1122
1123        <bitlbee-setting name="ssl" type="boolean" scope="account">
1124                <default>false</default>
1125
1126                <description>
1127                        <para>
1128                                Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
1129                        </para>
1130                </description>
1131        </bitlbee-setting>
1132
1133        <bitlbee-setting name="status" type="string" scope="both">
1134                <description>
1135                        <para>
1136                                Certain protocols (like Jabber/XMPP) support status messages, similar to away messages. They can be used to indicate things like your location or activity, without showing up as away/busy.
1137                        </para>
1138
1139                        <para>
1140                                This setting can be used to set such a message. It will be available as a per-account setting for protocols that support it, and also as a global setting (which will then automatically be used for all protocols that support it).
1141                        </para>
1142
1143                        <para>
1144                                Away states set using <emphasis>/away</emphasis> or the <emphasis>away</emphasis> setting will override this setting. To un-set the setting, use <emphasis>set -del status</emphasis>.
1145                        </para>
1146                </description>
1147        </bitlbee-setting>
1148
1149        <bitlbee-setting name="strip_html" type="boolean" scope="global">
1150                <default>true</default>
1151
1152                <description>
1153                        <para>
1154                                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.
1155                        </para>
1156                        <para>
1157                                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.
1158                        </para>
1159                </description>
1160        </bitlbee-setting>
1161
1162        <bitlbee-setting name="switchboard_keepalives" type="boolean" scope="account">
1163                <default>false</default>
1164
1165                <description>
1166                        <para>
1167                                Turn on this flag if you have difficulties talking to offline/invisible contacts.
1168                        </para>
1169                       
1170                        <para>
1171                                With this setting enabled, BitlBee will send keepalives to MSN switchboards with offline/invisible contacts every twenty seconds. This should keep the server and client on the other side from shutting it down.
1172                        </para>
1173                       
1174                        <para>
1175                                This is useful because BitlBee doesn't support MSN offline messages yet and the MSN servers won't let the user reopen switchboards to offline users. Once offline messaging is supported, this flag might be removed.
1176                        </para>
1177                </description>
1178        </bitlbee-setting>
1179
1180        <bitlbee-setting name="timezone" type="string" scope="global">
1181                <default>local</default>
1182                <possible-values>local, utc, gmt, timezone-spec</possible-values>
1183
1184                <description>
1185                        <para>
1186                                If message timestamps are available for offline messages or chatroom backlogs, BitlBee will display them as part of the message. By default it will use the local timezone. If you're not in the same timezone as the BitlBee server, you can adjust the timestamps using this setting.
1187                        </para>
1188
1189                        <para>
1190                                Values local/utc/gmt should be self-explanatory. timezone-spec is a time offset in hours:minutes, for example: -8 for Pacific Standard Time, +2 for Central European Summer Time, +5:30 for Indian Standard Time.
1191                        </para>
1192                </description>
1193        </bitlbee-setting>
1194
1195        <bitlbee-setting name="tls" type="boolean" scope="account">
1196                <default>try</default>
1197
1198                <description>
1199                        <para>
1200                                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.
1201                        </para>
1202
1203                        <para>
1204                                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.
1205                        </para>
1206                </description>
1207        </bitlbee-setting>
1208
1209        <bitlbee-setting name="to_char" type="string" scope="global">
1210                <default>": "</default>
1211
1212                <description>
1213                        <para>
1214                                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>.
1215                        </para>
1216
1217                        <para>
1218                                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.
1219                        </para>
1220                </description>
1221        </bitlbee-setting>
1222
1223        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
1224                <default>false</default>
1225
1226                <description>
1227                        <para>
1228                                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.
1229                        </para>
1230                </description>
1231        </bitlbee-setting>
1232
1233        <bitlbee-setting name="voice_buddies" type="string" scope="global">
1234                <default>notaway</default>
1235                <possible-values>encrypted, trusted, notaway, online, false</possible-values>
1236
1237                <description>
1238                        <para>
1239                                Specifies under which circumstances BitlBee should give the "voice" mode flag (+v) to buddies.
1240                        </para>
1241                       
1242                        <para>
1243                                If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key. On "online", the flag is set whenever the user is online; only meaningful in conjunction with "show_offline".
1244                        </para>
1245                </description>
1246
1247        </bitlbee-setting>
1248
1249        <bitlbee-setting name="web_aware" type="string" scope="account">
1250                <default>false</default>
1251
1252                <description>
1253                        <para>
1254                                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.
1255                        </para>
1256
1257                        <para>
1258                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
1259                        </para>
1260                </description>
1261        </bitlbee-setting>
1262
1263        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
1264                <default>false</default>
1265
1266                <description>
1267                        <para>
1268                                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.
1269                        </para>
1270                        <para>
1271                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
1272                        </para>
1273                </description>
1274        </bitlbee-setting>
1275
1276        <bitlbee-command name="rename">
1277                <short-description>Rename (renick) a buddy</short-description>
1278                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
1279
1280                <description>
1281                        <para>
1282                                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).
1283                        </para>
1284                </description>
1285
1286                <ircexample>
1287                        <ircline nick="itsme">rename itsme_ you</ircline>
1288                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
1289                </ircexample>
1290
1291        </bitlbee-command>
1292
1293        <bitlbee-command name="yes">
1294                <short-description>Accept a request</short-description>
1295                <syntax>yes [&lt;number&gt;]</syntax>
1296
1297                <description>
1298                        <para>
1299                                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.
1300                        </para>
1301
1302                        <para>
1303                                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.
1304                        </para>
1305                </description>
1306
1307        </bitlbee-command>
1308
1309        <bitlbee-command name="no">
1310                <short-description>Deny a request</short-description>
1311                <syntax>no [&lt;number&gt;]</syntax>
1312
1313                <description>
1314                        <para>
1315                                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.
1316                        </para>
1317
1318                        <para>
1319                                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.
1320                        </para>
1321                </description>
1322        </bitlbee-command>
1323
1324        <bitlbee-command name="qlist">
1325                <short-description>List all the unanswered questions root asked</short-description>
1326                <syntax>qlist</syntax>
1327
1328                <description>
1329                        <para>
1330                                This gives you a list of all the unanswered questions from root.
1331                        </para>
1332                </description>
1333
1334        </bitlbee-command>
1335
1336        <bitlbee-command name="register">
1337                <short-description>Register yourself</short-description>
1338                <syntax>register &lt;password&gt;</syntax>
1339
1340                <description>
1341                        <para>
1342                                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.
1343                        </para>
1344
1345                        <para>
1346                                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.. ;-)
1347                        </para>
1348
1349                        <para>
1350                                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.
1351                        </para>
1352                </description>
1353
1354        </bitlbee-command>
1355
1356        <bitlbee-command name="identify">
1357                <syntax>identify &lt;password&gt;</syntax>
1358                <short-description>Identify yourself with your password</short-description>
1359
1360                <description>
1361                        <para>
1362                                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.
1363                        </para>
1364
1365                        <para>
1366                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
1367                        </para>
1368                </description>
1369        </bitlbee-command>
1370
1371        <bitlbee-command name="drop">
1372                <syntax>drop &lt;password&gt;</syntax>
1373                <short-description>Drop your account</short-description>
1374
1375                <description>
1376                        <para>
1377                                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.
1378                        </para>
1379                </description>
1380        </bitlbee-command>
1381
1382        <bitlbee-command name="blist">
1383                <syntax>blist [all|online|offline|away]</syntax>
1384                <short-description>List all the buddies in your contact list</short-description>
1385
1386                <description>
1387                        <para>
1388                                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.
1389                        </para>
1390                </description>
1391
1392        </bitlbee-command>
1393
1394        <bitlbee-command name="nick">
1395                <short-description>Change friendly name, nick</short-description>
1396                <syntax>nick &lt;connection&gt; [&lt;new nick&gt;]</syntax>
1397                <syntax>nick &lt;connection&gt;</syntax>
1398
1399                <description>
1400                        <para>
1401                                Deprecated: Use the per-account <emphasis>display_name</emphasis> setting to read and change this information.
1402                        </para>
1403                </description>
1404
1405                <ircexample>
1406                        <ircline nick="wouter">account set 1/display_name "The majestik møøse"</ircline>
1407                        <ircline nick="root">display_name = `The majestik møøse'</ircline>
1408                </ircexample>
1409
1410        </bitlbee-command>
1411</chapter>
Note: See TracBrowser for help on using the repository browser.