source: doc/user-guide/commands.xml @ 5282ffd

Last change on this file since 5282ffd was a429907, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-12-05T12:28:07Z

rename -del
  • Property mode set to 100644
File size: 66.6 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;account id&gt;] &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
26                                <para>
27                                        If you omit the password, you should use the IRC /OPER command to enter it separately. The advantage of this approach is that most IRC clients will not show OPER passwords on screen/save them in logs.
28                                </para>
29                        </description>
30                       
31                        <bitlbee-command name="jabber">
32                                <syntax>account add jabber &lt;handle@server.tld&gt; [&lt;password&gt;]</syntax>
33
34                                <description>
35                                        <para>
36                                                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.
37                                        </para>
38
39                                        <para>
40                                                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>).
41                                        </para>
42                                </description>
43                        </bitlbee-command>
44
45                        <bitlbee-command name="msn">
46                                <syntax>account add msn &lt;handle@server.tld&gt; [&lt;password&gt;]</syntax>
47
48                                <description>
49                                        <para>
50                                                For MSN connections there are no special arguments.
51                                        </para>
52                                </description>
53                        </bitlbee-command>
54                       
55                        <bitlbee-command name="oscar">
56                                <syntax>account add oscar &lt;handle&gt; [&lt;password&gt;]</syntax>
57
58                                <description>
59                                        <para>
60                                                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.
61                                        </para>
62                                </description>
63
64                                <ircexample>
65                                        <ircline nick="wilmer">account add oscar 72696705 hobbelmeeuw</ircline>
66                                        <ircline nick="root">Account successfully added</ircline>
67                                </ircexample>
68                        </bitlbee-command>
69                       
70                        <bitlbee-command name="twitter">
71                                <syntax>account add twitter &lt;handle&gt; [&lt;password&gt;]</syntax>
72
73                                <description>
74                                        <para>
75                                                This module gives you simple access to Twitter. Although it uses the Twitter API, only Twitter itself is supported at the moment.
76                                        </para>
77                                       
78                                        <para>
79                                                By default all your Twitter contacts will appear in a new channel called #twitter_yourusername. You can change this behaviour using the <emphasis>mode</emphasis> setting (see <emphasis>help set mode</emphasis>).
80                                        </para>
81                                       
82                                        <para>
83                                                To send tweets yourself, send them to the twitter_(yourusername) contact, or just write in the groupchat channel if you enabled that option.
84                                        </para>
85
86                                        <para>
87                                                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>.)
88                                        </para>
89                                </description>
90                        </bitlbee-command>
91
92                        <bitlbee-command name="yahoo">
93                                <syntax>account add yahoo &lt;handle&gt; [&lt;password&gt;]</syntax>
94
95                                <description>
96                                        <para>
97                                                For Yahoo! connections there are no special arguments.
98                                        </para>
99                                </description>
100                        </bitlbee-command>
101
102                </bitlbee-command>
103
104                <bitlbee-command name="del">
105                        <syntax>account &lt;account id&gt; del</syntax>
106
107                        <description>
108                                <para>
109                                        This commands deletes an account from your account list. You should signoff the account before deleting it.
110                                </para>
111
112
113                                <para>
114                                        The account ID can be a number/tag (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
115                                </para>
116                        </description>
117                </bitlbee-command>
118
119                <bitlbee-command name="on">
120                        <syntax>account [&lt;account id&gt;] on</syntax>
121
122                        <description>
123                                <para>
124                                        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.
125                                </para>
126
127                                <para>
128                                        The account ID can be a number/tag (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
129                                </para>
130                        </description>
131
132                </bitlbee-command>
133
134                <bitlbee-command name="off">
135                        <syntax>account [&lt;account id&gt;] off</syntax>
136
137                        <description>
138                                <para>
139                                        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.
140                                </para>
141
142                                <para>
143                                        The account ID can be a number/tag (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
144                                </para>
145                        </description>
146                </bitlbee-command>
147
148                <bitlbee-command name="list">
149                        <syntax>account list</syntax>
150
151                        <description>
152                                <para>
153                                        This command gives you a list of all the accounts known by BitlBee.
154                                </para>
155                        </description>
156                </bitlbee-command>
157
158                <bitlbee-command name="set">
159                        <syntax>account &lt;account id&gt; set</syntax>
160                        <syntax>account &lt;account id&gt; set &lt;setting&gt;</syntax>
161                        <syntax>account &lt;account id&gt; set &lt;setting&gt; &lt;value&gt;</syntax>
162                        <syntax>account &lt;account id&gt; set -del &lt;setting&gt;</syntax>
163
164                        <description>
165                                <para>
166                                        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 &lt;account id&gt; set</emphasis>.
167                                </para>
168                               
169                                <para>
170                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
171                                </para>
172                               
173                                <para>
174                                        The account ID can be a number/tag (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
175                                </para>
176                        </description>
177                </bitlbee-command>
178        </bitlbee-command>
179
180        <bitlbee-command name="channel">
181                <short-description>Channel list maintenance</short-description>
182                <syntax>channel [&lt;account id&gt;] &lt;action&gt; [&lt;arguments&gt;]</syntax>
183
184                <description>
185                        <para>
186                                Available actions: del, list, set. See <emphasis>help channel &lt;action&gt;</emphasis> for more information.
187                        </para>
188                       
189                        <para>
190                                There is no <emphasis>channel add</emphasis> command. To create a new channel, just use the IRC <emphasis>/join</emphasis> command. See also <emphasis>help channels</emphasis> and <emphasis>help groupchats</emphasis>.
191                        </para>
192                </description>
193
194                <bitlbee-command name="del">
195                        <syntax>channel &lt;channel id&gt; del</syntax>
196
197                        <description>
198                                <para>
199                                        Remove a channel and forget all its settings. You can only remove channels you're not currently in, and can't remove the main control channel. (You can, however, leave it.)
200                                </para>
201                        </description>
202
203                </bitlbee-command>
204
205                <bitlbee-command name="list">
206                        <syntax>channel list</syntax>
207
208                        <description>
209                                <para>
210                                        This command gives you a list of all the channels you configured.
211                                </para>
212                        </description>
213
214                </bitlbee-command>
215
216                <bitlbee-command name="set">
217                        <syntax>channel [&lt;channel id&gt;] set</syntax>
218                        <syntax>channel [&lt;channel id&gt;] set &lt;setting&gt;</syntax>
219                        <syntax>channel [&lt;channel id&gt;] set &lt;setting&gt; &lt;value&gt;</syntax>
220                        <syntax>channel [&lt;channel id&gt;] set -del &lt;setting&gt;</syntax>
221
222                        <description>
223                                <para>
224                                        This command can be used to change various settings for channels. Different channel types support different settings. You can see the settings available for a channel by typing <emphasis>channel &lt;channel id&gt; set</emphasis>.
225                                </para>
226                               
227                                <para>
228                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
229                                </para>
230                               
231                                <para>
232                                        The channel ID can be a number (see <emphasis>channel list</emphasis>), or (part of) its name, as long as it matches only one channel. If you want to change settings of the current channel, you can omit the channel ID.
233                                </para>
234                        </description>
235                </bitlbee-command>
236
237        </bitlbee-command>
238
239        <bitlbee-command name="chat">
240                <short-description>Chatroom list maintenance</short-description>
241                <syntax>chat &lt;action&gt; [&lt;arguments&gt;]</syntax>
242
243                <description>
244
245                        <para>
246                                Available actions: add, with. See <emphasis>help chat &lt;action&gt;</emphasis> for more information.
247                        </para>
248
249                </description>
250
251                <bitlbee-command name="add">
252                        <syntax>chat add &lt;account id&gt; &lt;room&gt; [&lt;channel&gt;]</syntax>
253
254                        <description>
255                                <para>
256                                        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.
257                                </para>
258
259                                <para>
260                                        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>)
261                                </para>
262
263                                <para>
264                                        Password-protected rooms work exactly like on IRC, by passing the password as an extra argument to /join.
265                                </para>
266                        </description>
267
268                </bitlbee-command>
269
270                <bitlbee-command name="with">
271                        <syntax>chat with &lt;nickname&gt;</syntax>
272
273                        <description>
274                                <para>
275                                        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.
276                                </para>
277                        </description>
278                </bitlbee-command>
279        </bitlbee-command>
280
281        <bitlbee-command name="add">
282                <short-description>Add a buddy to your contact list</short-description>
283                <syntax>add &lt;account id&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
284                <syntax>add -tmp &lt;account id&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
285
286                <description>
287                        <para>
288                                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.
289                        </para>
290
291                        <para>
292                                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.
293                        </para>
294
295                        <para>
296                                If you use this command in a control channel containing people from only one group, the new contact will be added to that group automatically.
297                        </para>
298                </description>
299
300                <ircexample>
301                        <ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
302                        <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
303                </ircexample>
304        </bitlbee-command>
305
306        <bitlbee-command name="info">
307                <short-description>Request user information</short-description>
308                <syntax>info &lt;connection&gt; &lt;handle&gt;</syntax>
309                <syntax>info &lt;nick&gt;</syntax>
310
311                <description>
312                        <para>
313                                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.
314                        </para>
315                </description>
316
317                <ircexample>
318                        <ircline nick="ctrlsoft">info 0 72696705</ircline>
319                        <ircline nick="root">User info - UIN: 72696705   Nick: Lintux   First/Last name: Wilmer van der Gaast   E-mail: lintux@lintux.cx</ircline>
320                </ircexample>
321
322        </bitlbee-command>
323
324        <bitlbee-command name="remove">
325                <short-description>Remove a buddy from your contact list</short-description>
326                <syntax>remove &lt;nick&gt;</syntax>
327
328                <description>
329                        <para>
330                                Removes the specified nick from your buddy list.
331                        </para>
332                </description>
333
334                <ircexample>
335                        <ircline nick="ctrlsoft">remove gryp</ircline>
336                        <ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction>
337                </ircexample>
338
339        </bitlbee-command>
340
341        <bitlbee-command name="block">
342                <short-description>Block someone</short-description>
343                <syntax>block &lt;nick&gt;</syntax>
344                <syntax>block &lt;connection&gt; &lt;handle&gt;</syntax>
345                <syntax>block &lt;connection&gt;</syntax>
346
347                <description>
348                        <para>
349                                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.
350                        </para>
351                       
352                        <para>
353                                When called with only a connection specification as an argument, the command displays the current block list for that connection.
354                        </para>
355                </description>
356        </bitlbee-command>
357
358        <bitlbee-command name="allow">
359                <short-description>Unblock someone</short-description>
360                <syntax>allow &lt;nick&gt;</syntax>
361                <syntax>allow &lt;connection&gt; &lt;handle&gt;</syntax>
362
363                <description>
364                        <para>
365                                Reverse of block. Unignores the specified user or user handle on specified connection.
366                        </para>
367                       
368                        <para>
369                                When called with only a connection specification as an argument, the command displays the current allow list for that connection.
370                        </para>
371                </description>
372        </bitlbee-command>
373       
374        <bitlbee-command name="otr">
375                <short-description>Off-the-Record encryption control</short-description>
376                <syntax>otr &lt;subcommand&gt; [&lt;arguments&gt;]</syntax>
377
378                <description>
379
380                        <para>
381                                Available subcommands: connect, disconnect, smp, smpq, trust, info, keygen, and forget. See <emphasis>help otr &lt;subcommand&gt;</emphasis> for more information.
382                        </para>
383
384                </description>
385               
386                <bitlbee-command name="connect">
387                        <syntax>otr connect &lt;nick&gt;</syntax>
388                       
389                        <description>
390                       
391                                <para>
392                                        Attempts to establish an encrypted connection with the specified user by sending a magic string.
393                                </para>
394                               
395                        </description>
396               
397                </bitlbee-command>
398               
399                <bitlbee-command name="disconnect">
400                        <syntax>otr disconnect &lt;nick&gt;</syntax>
401                       
402                        <description>
403                       
404                                <para>
405                                        Resets the connection with the specified user to cleartext.
406                                </para>
407                               
408                        </description>
409               
410                </bitlbee-command>
411               
412                <bitlbee-command name="smp">
413                        <syntax>otr smp &lt;nick&gt; &lt;secret&gt;</syntax>
414                       
415                        <description>
416                       
417                                <para>
418                                        Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol.
419                                </para>
420                               
421                                <para>
422                                        If an SMP challenge has been received from the given user, responds with the specified secret/answer. Otherwise, sends a challenge for the given secret.
423                                </para>
424                               
425                                <para>
426                                        Note that there are two flavors of SMP challenges: "shared-secret" and "question &amp; answer". This command is used to respond to both of them, or to initiate a shared-secret style exchange. Use the <emphasis>otr smpq</emphasis> command to initiate a "Q&amp;A" session.
427                                </para>
428                               
429                                <para>
430                                        When responding to a "Q&amp;A" challenge, the local trust value is not altered. Only the <emphasis>asking party</emphasis> sets trust in the case of success. Use <emphasis>otr smpq</emphasis> to pose your challenge. In a shared-secret exchange, both parties set their trust according to the outcome.
431                                </para>
432                               
433                        </description>
434               
435                </bitlbee-command>
436               
437                <bitlbee-command name="smpq">
438                        <syntax>otr smpq &lt;nick&gt; &lt;question&gt; &lt;answer&gt;</syntax>
439                       
440                        <description>
441                       
442                                <para>
443                                        Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol, Q&amp;A style.
444                                </para>
445
446                                <para>
447                                        Initiates an SMP session in "question &amp; answer" style. The question is transmitted with the initial SMP packet and used to prompt the other party. You must be confident that only they know the answer. If the protocol succeeds (i.e. they answer correctly), the fingerprint will be trusted. Note that the answer must be entered exactly, case and punctuation count!
448                                </para>
449                               
450                                <para>
451                                        Note that this style of SMP only affects the trust setting on your side. Expect your opponent to send you their own challenge. Alternatively, if you and the other party have a shared secret, use the <emphasis>otr smp</emphasis> command.
452                                </para>
453                               
454                        </description>
455               
456                </bitlbee-command>
457               
458                <bitlbee-command name="trust">
459                        <syntax>otr trust &lt;nick&gt; &lt;fp1&gt; &lt;fp2&gt; &lt;fp3&gt; &lt;fp4&gt; &lt;fp5&gt;</syntax>
460                       
461                        <description>
462                       
463                                <para>
464                                        Manually affirms trust in the specified fingerprint, given as five blocks of precisely eight (hexadecimal) digits each.
465                                </para>
466                               
467                        </description>
468               
469                </bitlbee-command>
470               
471                <bitlbee-command name="info">
472                        <syntax>otr info</syntax>
473                        <syntax>otr info &lt;nick&gt;</syntax>
474                       
475                        <description>
476                       
477                                <para>
478                                        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.
479                                </para>
480                               
481                        </description>
482               
483                </bitlbee-command>
484               
485                <bitlbee-command name="keygen">
486                        <syntax>otr keygen &lt;account-no&gt;</syntax>
487                       
488                        <description>
489                       
490                                <para>
491                                        Generates a new OTR private key for the given account.
492                                </para>
493                               
494                        </description>
495               
496                </bitlbee-command>
497               
498                <bitlbee-command name="forget">
499                        <syntax>otr forget &lt;thing&gt; &lt;arguments&gt;</syntax>
500                       
501                        <description>
502                       
503                                <para>
504                                        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.
505                                </para>
506                       
507                        </description>
508                       
509                        <bitlbee-command name="fingerprint">
510                                <syntax>otr forget fingerprint &lt;nick&gt; &lt;fingerprint&gt;</syntax>
511                               
512                                <description>
513                               
514                                        <para>
515                                                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.
516                                        </para>
517                                       
518                                </description>
519                               
520                        </bitlbee-command>
521                               
522                        <bitlbee-command name="context">
523                                <syntax>otr forget context &lt;nick&gt;</syntax>
524                               
525                                <description>
526                               
527                                        <para>
528                                                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.
529                                        </para>
530                                       
531                                </description>
532                               
533                        </bitlbee-command>
534
535                        <bitlbee-command name="key">
536                                <syntax>otr forget key &lt;fingerprint&gt;</syntax>
537                               
538                                <description>
539                               
540                                        <para>
541                                                Forgets an OTR private key matching the specified fingerprint. It is allowed to specify only a (unique) prefix of the fingerprint.
542                                        </para>
543                                       
544                                </description>
545                               
546                        </bitlbee-command>
547               
548                </bitlbee-command>
549               
550        </bitlbee-command>
551
552        <bitlbee-command name="set">
553                <short-description>Miscellaneous settings</short-description>
554                <syntax>set</syntax>
555                <syntax>set &lt;variable&gt;</syntax>
556                <syntax>set &lt;variable&gt; &lt;value&gt;</syntax>
557                <syntax>set -del &lt;variable&gt;</syntax>
558
559                <description>
560
561                        <para>
562                                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.
563                        </para>
564
565                        <para>
566                                To get more help information about a setting, try:
567                        </para>
568
569                </description>
570
571                <ircexample>
572                        <ircline nick="ctrlsoft">help set private</ircline>
573                </ircexample>
574
575        </bitlbee-command>
576
577        <bitlbee-command name="help">
578                <short-description>BitlBee help system</short-description>
579
580                <syntax>help [subject]</syntax>
581
582                <description>
583                        <para>
584                                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.
585                        </para>
586                </description>
587        </bitlbee-command>
588
589        <bitlbee-command name="save">
590                <short-description>Save your account data</short-description>
591                <syntax>save</syntax>
592
593                <description>
594                        <para>
595                                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... ;-)
596                        </para>
597                </description>
598        </bitlbee-command>
599
600        <bitlbee-setting name="account" type="string" scope="channel">
601
602                <description>
603                        <para>
604                                For control channels with <emphasis>fill_by</emphasis> set to <emphasis>account</emphasis>: Set this setting to the account id (numeric, or part of the username) of the account containing the contacts you want to see in this channel.
605                        </para>
606                </description>
607        </bitlbee-setting>
608
609        <bitlbee-setting name="allow_takeover" type="boolean" scope="global">
610                <default>true</default>
611
612                <description>
613                        <para>
614                                When you're already connected to a BitlBee server and you connect (and identify) again, BitlBee will offer to migrate your existing session to the new connection. If for whatever reason you don't want this, you can disable this setting.
615                        </para>
616                </description>
617        </bitlbee-setting>
618
619        <bitlbee-setting name="auto_connect" type="boolean" scope="both">
620                <default>true</default>
621
622                <description>
623                        <para>
624                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
625                        </para>
626                       
627                        <para>
628                                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!)
629                        </para>
630                </description>
631        </bitlbee-setting>
632
633        <bitlbee-setting name="auto_join" type="boolean" scope="channel">
634                <default>false</default>
635
636                <description>
637                        <para>
638                                With this option enabled, BitlBee will automatically join this channel when you log in.
639                        </para>
640                </description>
641        </bitlbee-setting>
642
643        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
644                <default>true</default>
645
646                <description>
647                        <para>
648                                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.
649                        </para>
650
651                        <para>
652                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
653                        </para>
654
655                        <para>
656                                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!)
657                        </para>
658                </description>
659        </bitlbee-setting>
660
661        <bitlbee-setting name="auto_reconnect_delay" type="string" scope="global">
662                <default>5*3&lt;900</default>
663
664                <description>
665                        <para>
666                                Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up.
667                        </para>
668
669                        <para>
670                                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.
671                        </para>
672
673                        <para>
674                                See also the <emphasis>auto_reconnect</emphasis> setting.
675                        </para>
676                </description>
677        </bitlbee-setting>
678
679        <bitlbee-setting name="auto_reply_timeout" type="integer" scope="account">
680                <default>10800</default>
681
682                <description>
683                        <para>
684                                For Twitter accounts: If you respond to Tweets IRC-style (like "nickname: reply"), this will automatically be converted to the usual Twitter format ("@screenname reply").
685                        </para>
686
687                        <para>
688                                By default, BitlBee will then also add a reference to that person's most recent Tweet, unless that message is older than the value of this setting in seconds.
689                        </para>
690
691                        <para>
692                                If you want to disable this feature, just set this to 0. Alternatively, if you want to write a message once that is <emphasis>not</emphasis> a reply, use the Twitter reply syntax (@screenname).
693                        </para>
694                </description>
695        </bitlbee-setting>
696
697        <bitlbee-setting name="away" type="string" scope="both">
698                <description>
699                        <para>
700                                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.
701                        </para>
702
703                        <para>
704                                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.
705                        </para>
706
707                        <para>
708                                Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>.
709                        </para>
710                </description>
711        </bitlbee-setting>
712
713        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
714                <default>true</default>
715
716                <description>
717                        <para>
718                                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.
719                        </para>
720                       
721                        <para>
722                                Replaced with the <emphasis>show_users</emphasis> setting. See <emphasis>help show_users</emphasis>.
723                        </para>
724                </description>
725        </bitlbee-setting>
726
727        <bitlbee-setting name="away_reply_timeout" type="integer" scope="global">
728                <default>3600</default>
729
730                <description>
731                        <para>
732                                Most IRC servers send a user's away message every time s/he gets a private message, to inform the sender that they may not get a response immediately. With this setting set to 0, BitlBee will also behave like this.
733                        </para>
734
735                        <para>
736                                Since not all IRC clients do an excellent job at suppressing these messages, this setting lets BitlBee do it instead. BitlBee will wait this many seconds (or until the away state/message changes) before re-informing you that the person's away.
737                        </para>
738                </description>
739        </bitlbee-setting>
740
741        <bitlbee-setting name="base_url" type="string" scope="account">
742                <default>http://twitter.com</default>
743
744                <description>
745                        <para>
746                                There are more services that understand the Twitter API than just Twitter.com. BitlBee can connect to all Twitter API implementations.
747                        </para>
748
749                        <para>
750                                For example, set this setting to <emphasis>http://identi.ca/api</emphasis> to use Identi.ca.
751                        </para>
752
753                        <para>
754                                Keep two things in mind: When not using Twitter, you <emphasis>must</emphasis> also disable the <emphasis>oauth</emphasis> setting as it currently only works with Twitter. If you're still having issues, make sure there is <emphasis>no</emphasis> slash at the end of the URL you enter here.
755                        </para>
756                </description>
757        </bitlbee-setting>
758
759        <bitlbee-setting name="charset" type="string" scope="global">
760                <default>utf-8</default>
761                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
762
763                <description>
764                        <para>
765                                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.
766                        </para>
767
768                        <para>
769                                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
770                        </para>
771                </description>
772
773        </bitlbee-setting>
774
775        <bitlbee-setting name="color_encrypted" type="boolean" scope="global">
776                <default>true</default>
777
778                <description>
779                        <para>
780                                If set to true, BitlBee will color incoming encrypted messages according to their fingerprint trust level: untrusted=red, trusted=green.
781                        </para>
782                </description>
783        </bitlbee-setting>
784
785        <bitlbee-setting name="control_channel" type="string" scope="global">
786                <default>&amp;bitlbee</default>
787
788                <description>
789                        <para>
790                                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.
791                        </para>
792                </description>
793        </bitlbee-setting>
794
795        <bitlbee-setting name="chat_type" type="string" scope="channel">
796                <default>groupchat</default>
797                <possible-values>groupchat, room</possible-values>
798
799                <description>
800                        <para>
801                                There are two kinds of chat channels: simple groupchats (basically normal IM chats with more than two participants) and names chatrooms, more similar to IRC channels.
802                        </para>
803                       
804                        <para>
805                                BitlBee supports both types. With this setting set to <emphasis>groupchat</emphasis> (the default), you can just invite people into the room and start talking.
806                        </para>
807                       
808                        <para>
809                                For setting up named chatrooms, it's currently easier to just use the <emphasis>chat add</emphasis> command.
810                        </para>
811                </description>
812        </bitlbee-setting>
813
814        <bitlbee-setting name="commands" type="boolean" scope="account">
815                <default>true</default>
816
817                <description>
818                        <para>
819                                With this setting enabled, you can use some commands in your Twitter channel/query. The commands are simple and not documented in too much detail:
820                        </para>
821
822                        <variablelist>
823                                <varlistentry><term>undo [&lt;id&gt;]</term><listitem><para>Delete your last Tweet (or one with the given ID)</para></listitem></varlistentry>
824                                <varlistentry><term>rt &lt;screenname|id&gt;</term><listitem><para>Retweet someone's last Tweet (or one with the given ID)</para></listitem></varlistentry>
825                                <varlistentry><term>follow &lt;screenname&gt;</term><listitem><para>Start following a person</para></listitem></varlistentry>
826                                <varlistentry><term>unfollow &lt;screenname&gt;</term><listitem><para>Stop following a person</para></listitem></varlistentry>
827                                <varlistentry><term>post &lt;message&gt;</term><listitem><para>Post a tweet</para></listitem></varlistentry>
828                        </variablelist>
829
830                        <para>
831                                Anything that doesn't look like a command will be treated as a tweet. Watch out for typos! :-)
832                        </para>
833                </description>
834        </bitlbee-setting>
835
836        <bitlbee-setting name="debug" type="boolean" scope="global">
837                <default>false</default>
838
839                <description>
840                        <para>
841                                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.
842                        </para>
843                </description>
844        </bitlbee-setting>
845
846        <bitlbee-setting name="default_target" type="string" scope="global">
847                <default>root</default>
848                <possible-values>root, last</possible-values>
849
850                <description>
851                        <para>
852                                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>.
853                        </para>
854                </description>
855        </bitlbee-setting>
856
857        <bitlbee-setting name="display_name" type="string" scope="account">
858                <description>
859                        <para>
860                                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.
861                        </para>
862                </description>
863        </bitlbee-setting>
864
865        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
866                <default>false</default>
867
868                <description>
869                        <para>
870                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
871                        </para>
872                </description>
873        </bitlbee-setting>
874
875        <bitlbee-setting name="display_timestamps" type="boolean" scope="global">
876                <default>true</default>
877
878                <description>
879                        <para>
880                                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.
881                        </para>
882                </description>
883        </bitlbee-setting>
884
885        <bitlbee-setting name="fill_by" type="string" scope="channel">
886                <default>all</default>
887                <possible-values>all, group, account, protocol</possible-values>
888
889                <description>
890                        <para>
891                                For control channels only: This setting determines which contacts the channel gets populated with.
892                        </para>
893
894                        <para>
895                                By default, control channels will contain all your contacts. You instead select contacts by buddy group, IM account or IM protocol.
896                        </para>
897                       
898                        <para>
899                                Change this setting and the corresponding <emphasis>account</emphasis>/<emphasis>group</emphasis>/<emphasis>protocol</emphasis> setting to set up this selection.
900                        </para>
901                       
902                        <para>
903                                Note that, when creating a new channel, BitlBee will try to preconfigure the channel for you, based on the channel name. See <emphasis>help channels</emphasis>.
904                        </para>
905                </description>
906        </bitlbee-setting>
907
908        <bitlbee-setting name="group" type="string" scope="channel">
909
910                <description>
911                        <para>
912                                For control channels with <emphasis>fill_by</emphasis> set to <emphasis>group</emphasis>: Set this setting to the name of the group containing the contacts you want to see in this channel.
913                        </para>
914                </description>
915        </bitlbee-setting>
916
917        <bitlbee-setting name="handle_unknown" type="string" scope="global">
918                <default>add_channel</default>
919                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
920
921                <description>
922                        <para>
923                                Messages from unknown users are echoed like this by default:
924                        </para>
925
926                        <ircexample>
927                                <ircline nick="root">Unknown message from handle 3137137:</ircline>
928                                <ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
929                        </ircexample>
930
931                        <para>
932                                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.
933                        </para>
934
935                        <note>
936                                <para>
937                                        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.
938                                </para>
939                        </note>
940                </description>
941
942        </bitlbee-setting>
943
944        <bitlbee-setting name="ignore_auth_requests" type="boolean" scope="account">
945                <default>false</default>
946
947                <description>
948                        <para>
949                                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.
950                        </para>
951                </description>
952
953        </bitlbee-setting>
954
955        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
956                <default>true</default>
957
958                <description>
959                        <para>
960                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
961                        </para>
962                </description>
963
964        </bitlbee-setting>
965
966        <bitlbee-setting name="local_display_name" type="boolean" scope="account">
967                <default>false</default>
968
969                <description>
970                        <para>
971                                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.
972                        </para>
973                </description>
974
975        </bitlbee-setting>
976
977        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
978                <default>false</default>
979
980                <description>
981                        <para>
982                                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.
983                        </para>
984                </description>
985
986        </bitlbee-setting>
987
988        <bitlbee-setting name="message_length" type="integer" scope="account">
989                <default>140</default>
990
991                <description>
992                        <para>
993                                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.
994                        </para>
995
996                        <para>
997                                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.
998                        </para>
999                </description>
1000
1001        </bitlbee-setting>
1002
1003        <bitlbee-setting name="mode" type="string" scope="account">
1004                <possible-values>one, many, chat</possible-values>
1005                <default>chat</default>
1006
1007                <description>
1008                        <para>
1009                                By default, BitlBee will create a separate channel (called #twitter_yourusername) for all your Twitter contacts/messages.
1010                        </para>
1011
1012                        <para>
1013                                If you don't want an extra channel, you can set this setting to "one" (everything will come from one nick, twitter_yourusername), or to "many" (individual nicks for everyone).
1014                        </para>
1015                       
1016                        <para>
1017                                With modes "chat" and "many", you can send direct messages by /msg'ing your contacts directly. Note, however, that incoming DMs are not fetched yet.
1018                        </para>
1019                       
1020                        <para>
1021                                With modes "many" and "one", you can post tweets by /msg'ing the twitter_yourusername contact. In mode "chat", messages posted in the Twitter channel will also be posted as tweets.
1022                        </para>
1023                </description>
1024
1025        </bitlbee-setting>
1026
1027        <bitlbee-setting name="mobile_is_away" type="boolean" scope="global">
1028                <default>false</default>
1029
1030                <description>
1031                        <para>
1032                                Most IM networks have a mobile version of their client. People who use these may not be paying that much attention to messages coming in. By enabling this setting, people using mobile clients will always be shown as away.
1033                        </para>
1034                </description>
1035
1036        </bitlbee-setting>
1037
1038        <bitlbee-setting name="nick" type="string" scope="chat">
1039                <description>
1040                        <para>
1041                                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.
1042                        </para>
1043                </description>
1044        </bitlbee-setting>
1045
1046        <bitlbee-setting name="nick_format" type="string" scope="both">
1047                <default>%-@nick</default>
1048
1049                <description>
1050                        <para>
1051                                By default, BitlBee tries to derive sensible nicknames for all your contacts from their IM handles. In some cases, IM modules (ICQ for example) will provide a nickname suggestion, which will then be used instead. This setting lets you change this behaviour.
1052                        </para>
1053
1054                        <para>
1055                                Whenever this setting is set for an account, it will be used for all its contacts. If it's not set, the global value will be used.
1056                        </para>
1057
1058                        <para>
1059                                It's easier to describe this setting using a few examples:
1060                        </para>
1061
1062                        <para>
1063                                FB-%full_name will make all nicknames start with "FB-", followed by the person's full name. For example you can set this format for your Facebook account so all Facebook contacts are clearly marked.
1064                        </para>
1065
1066                        <para>
1067                                [%group]%-@nick will make all nicknames start with the group the contact is in between square brackets, followed by the nickname suggestions from the IM module if available, or otherwise the handle. Because of the "-@" part, everything from the first @ will be stripped.
1068                        </para>
1069
1070                        <para>
1071                                See <emphasis>help nick_format</emphasis> for more information.
1072                        </para>
1073                </description>
1074        </bitlbee-setting>
1075
1076        <bitlbee-setting name="nick_source" type="string" scope="account">
1077                <default>handle</default>
1078                <possible-values>handle, full_name, first_name</possible-values>
1079
1080                <description>
1081                        <para>
1082                                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.
1083                        </para>
1084
1085                        <para>
1086                                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.
1087                        </para>
1088                </description>
1089        </bitlbee-setting>
1090
1091        <bitlbee-setting name="oauth" type="boolean" scope="account">
1092                <default>true</default>
1093
1094                <description>
1095                        <para>
1096                                This enables OAuth authentication for Twitter accounts. From June 2010 this will be mandatory.
1097                        </para>
1098
1099                        <para>
1100                                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.
1101                        </para>
1102
1103                        <para>
1104                                The resulting access token will be saved permanently, so you have to do this only once.
1105                        </para>
1106                </description>
1107
1108        </bitlbee-setting>
1109
1110        <bitlbee-setting name="ops" type="string" scope="global">
1111                <default>both</default>
1112                <possible-values>both, root, user, none</possible-values>
1113
1114                <description>
1115                        <para>
1116                                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.
1117                        </para>
1118
1119                        <para>
1120                                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.
1121                        </para>
1122                </description>
1123        </bitlbee-setting>
1124
1125        <bitlbee-setting name="otr_policy" type="string" scope="global">
1126                <default>opportunistic</default>
1127                <possible-values>never, opportunistic, manual, always</possible-values>
1128
1129                <description>
1130                        <para>
1131                                This setting controls the policy for establishing Off-the-Record connections.
1132                        </para>
1133                        <para>
1134                                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.
1135                        </para>
1136                </description>
1137        </bitlbee-setting>
1138
1139        <bitlbee-setting name="password" type="string" scope="both">
1140                <description>
1141                        <para>
1142                                Use this global setting to change your "NickServ" password.
1143                        </para>
1144                       
1145                        <para>
1146                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
1147                        </para>
1148                       
1149                        <para>
1150                                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.
1151                        </para>
1152                </description>
1153        </bitlbee-setting>
1154
1155        <bitlbee-setting name="paste_buffer" type="boolean" scope="global">
1156                <default>false</default>
1157
1158                <description>
1159                        <para>
1160                                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.
1161                        </para>
1162
1163                        <para>
1164                                Using the <emphasis>paste_buffer_delay</emphasis> setting you can specify the number of seconds BitlBee should wait for more data before the complete message is sent.
1165                        </para>
1166
1167                        <para>
1168                                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.
1169                        </para>
1170                </description>
1171        </bitlbee-setting>
1172
1173        <bitlbee-setting name="paste_buffer_delay" type="integer" scope="global">
1174                <default>200</default>
1175
1176                <description>
1177
1178                        <para>
1179                                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.
1180                        </para>
1181
1182                        <para>
1183                                See also the <emphasis>paste_buffer</emphasis> setting.
1184                        </para>
1185                </description>
1186        </bitlbee-setting>
1187       
1188        <bitlbee-setting name="port" type="integer" scope="account">
1189                <description>
1190                        <para>
1191                                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.
1192                        </para>
1193                </description>
1194        </bitlbee-setting>
1195
1196        <bitlbee-setting name="priority" type="integer" scope="account">
1197                <default>0</default>
1198
1199                <description>
1200                        <para>
1201                                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).
1202                        </para>
1203
1204                        <para>
1205                                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).
1206                        </para>
1207                </description>
1208        </bitlbee-setting>
1209
1210        <bitlbee-setting name="private" type="boolean" scope="global">
1211                <default>true</default>
1212
1213                <description>
1214                        <para>
1215                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
1216                        </para>
1217
1218                        <para>
1219                                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.
1220                        </para>
1221                </description>
1222        </bitlbee-setting>
1223
1224        <bitlbee-setting name="protocol" type="string" scope="channel">
1225
1226                <description>
1227                        <para>
1228                                For control channels with <emphasis>fill_by</emphasis> set to <emphasis>protocol</emphasis>: Set this setting to the name of the IM protocol of all contacts you want to see in this channel.
1229                        </para>
1230                </description>
1231        </bitlbee-setting>
1232
1233        <bitlbee-setting name="query_order" type="string" scope="global">
1234                <default>lifo</default>
1235                <possible-values>lifo, fifo</possible-values>
1236
1237                <description>
1238                        <para>
1239                                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.
1240                        </para>
1241
1242                        <para>
1243                                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).
1244                        </para>
1245                </description>
1246        </bitlbee-setting>
1247
1248        <bitlbee-setting name="resource" type="string" scope="account">
1249                <default>BitlBee</default>
1250
1251                <description>
1252                        <para>
1253                                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.
1254                        </para>
1255                </description>
1256        </bitlbee-setting>
1257
1258        <bitlbee-setting name="resource_select" type="string" scope="account">
1259                <default>activity</default>
1260                <possible-values>priority, activity</possible-values>
1261
1262                <description>
1263                        <para>
1264                                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.
1265                        </para>
1266
1267                        <para>
1268                                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).
1269                        </para>
1270                </description>
1271        </bitlbee-setting>
1272
1273        <bitlbee-setting name="root_nick" type="string" scope="global">
1274                <default>root</default>
1275
1276                <description>
1277                        <para>
1278                                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.
1279                        </para>
1280                </description>
1281        </bitlbee-setting>
1282
1283        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
1284                <default>true</default>
1285
1286                <description>
1287                        <para>
1288                                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.
1289                        </para>
1290                </description>
1291        </bitlbee-setting>
1292
1293        <bitlbee-setting name="server" type="string" scope="account">
1294                <description>
1295                        <para>
1296                                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.
1297                        </para>
1298                </description>
1299        </bitlbee-setting>
1300
1301        <bitlbee-setting name="show_offline" type="boolean" scope="global">
1302                <default>false</default>
1303
1304                <description>
1305                        <para>
1306                                If enabled causes BitlBee to also show offline users in Channel. Online-users will get op, away-users voice and offline users none of both. This option takes effect as soon as you reconnect.
1307                        </para>
1308                       
1309                        <para>
1310                                Replaced with the <emphasis>show_users</emphasis> setting. See <emphasis>help show_users</emphasis>.
1311                        </para>
1312                </description>
1313        </bitlbee-setting>
1314
1315        <bitlbee-setting name="show_users" type="string" scope="channel">
1316                <default>online+,away</default>
1317
1318                <description>
1319                        <para>
1320                                Comma-separated list of statuses of users you want in the channel,
1321                                and any modes they should have. The following statuses are currently
1322                                recognised: <emphasis>online</emphasis> (i.e. available, not
1323                                away), <emphasis>away</emphasis>, and <emphasis>offline</emphasis>.
1324                        </para>
1325                       
1326                        <para>
1327                                If a status is followed by a valid channel mode character
1328                                (@, % or +), it will be given to users with that status.
1329                                For example, <emphasis>online@,away+,offline</emphasis> will
1330                                show all users in the channel. Online people will
1331                                have +o, people who are online but away will have +v,
1332                                and others will have no special modes.
1333                        </para>
1334                </description>
1335        </bitlbee-setting>
1336
1337        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
1338                <default>true</default>
1339
1340                <description>
1341                        <para>
1342                                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.
1343                        </para>
1344                </description>
1345        </bitlbee-setting>
1346
1347        <bitlbee-setting name="ssl" type="boolean" scope="account">
1348                <default>false</default>
1349
1350                <description>
1351                        <para>
1352                                Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
1353                        </para>
1354                </description>
1355        </bitlbee-setting>
1356
1357        <bitlbee-setting name="status" type="string" scope="both">
1358                <description>
1359                        <para>
1360                                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.
1361                        </para>
1362
1363                        <para>
1364                                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).
1365                        </para>
1366
1367                        <para>
1368                                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>.
1369                        </para>
1370                </description>
1371        </bitlbee-setting>
1372
1373        <bitlbee-setting name="strip_html" type="boolean" scope="global">
1374                <default>true</default>
1375
1376                <description>
1377                        <para>
1378                                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.
1379                        </para>
1380                        <para>
1381                                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.
1382                        </para>
1383                </description>
1384        </bitlbee-setting>
1385
1386        <bitlbee-setting name="switchboard_keepalives" type="boolean" scope="account">
1387                <default>false</default>
1388
1389                <description>
1390                        <para>
1391                                Turn on this flag if you have difficulties talking to offline/invisible contacts.
1392                        </para>
1393                       
1394                        <para>
1395                                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.
1396                        </para>
1397                       
1398                        <para>
1399                                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.
1400                        </para>
1401                </description>
1402        </bitlbee-setting>
1403
1404        <bitlbee-setting name="tag" type="string" scope="account">
1405                <description>
1406                        <para>
1407                                For every account you have, you can set a tag you can use to uniquely identify that account. This tag can be used instead of the account number (or protocol name, or part of the screenname) when using commands like <emphasis>account</emphasis>, <emphasis>add</emphasis>, etc. You can't have two accounts with one and the same account tag.
1408                        </para>
1409
1410                        <para>
1411                                By default, it will be set to the name of the IM protocol. Once you add a second account on an IM network, a numeric suffix will be added, starting with 2.
1412                        </para>
1413                </description>
1414        </bitlbee-setting>
1415
1416        <bitlbee-setting name="timezone" type="string" scope="global">
1417                <default>local</default>
1418                <possible-values>local, utc, gmt, timezone-spec</possible-values>
1419
1420                <description>
1421                        <para>
1422                                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.
1423                        </para>
1424
1425                        <para>
1426                                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.
1427                        </para>
1428                </description>
1429        </bitlbee-setting>
1430
1431        <bitlbee-setting name="tls" type="boolean" scope="account">
1432                <default>try</default>
1433
1434                <description>
1435                        <para>
1436                                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.
1437                        </para>
1438
1439                        <para>
1440                                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.
1441                        </para>
1442                </description>
1443        </bitlbee-setting>
1444
1445        <bitlbee-setting name="to_char" type="string" scope="global">
1446                <default>": "</default>
1447
1448                <description>
1449                        <para>
1450                                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>.
1451                        </para>
1452
1453                        <para>
1454                                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.
1455                        </para>
1456                </description>
1457        </bitlbee-setting>
1458
1459        <bitlbee-setting name="translate_to_nicks" type="boolean" scope="channel">
1460                <default>true</default>
1461
1462                <description>
1463                        <para>
1464                                IRC's nickname namespace is quite limited compared to most IM protocols. Not any non-ASCII characters are allowed, in fact nicknames have to be mostly alpha-numeric. Also, BitlBee has to add underscores sometimes to avoid nickname collisions.
1465                        </para>
1466
1467                        <para>
1468                                While normally the BitlBee user is the only one seeing these names, they may be exposed to other chatroom participants for example when addressing someone in the channel (with or without tab completion). By default BitlBee will translate these stripped nicknames back to the original nick. If you don't want this, disable this setting.
1469                        </para>
1470                </description>
1471        </bitlbee-setting>
1472
1473        <bitlbee-setting name="type" type="string" scope="channel">
1474                <default>control</default>
1475                <possible-values>control, chat</possible-values>
1476
1477                <description>
1478                        <para>
1479                                BitlBee supports two kinds of channels: control channels (usually with a name starting with a &amp;) and chatroom channels (name usually starts with a #).
1480                        </para>
1481
1482                        <para>
1483                                See <emphasis>help channels</emphasis> for a full description of channel types in BitlBee.
1484                        </para>
1485                </description>
1486        </bitlbee-setting>
1487
1488        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
1489                <default>false</default>
1490
1491                <description>
1492                        <para>
1493                                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.
1494                        </para>
1495                </description>
1496        </bitlbee-setting>
1497
1498        <bitlbee-setting name="user_agent" type="string" scope="account">
1499                <default>BitlBee</default>
1500
1501                <description>
1502                        <para>
1503                                Some Jabber servers are configured to only allow a few (or even just one) kinds of XMPP clients to connect to them.
1504                        </para>
1505                       
1506                        <para>
1507                                You can change this setting to make BitlBee present itself as a different client, so that you can still connect to these servers.
1508                        </para>
1509                </description>
1510        </bitlbee-setting>
1511
1512        <bitlbee-setting name="web_aware" type="string" scope="account">
1513                <default>false</default>
1514
1515                <description>
1516                        <para>
1517                                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.
1518                        </para>
1519
1520                        <para>
1521                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
1522                        </para>
1523                </description>
1524        </bitlbee-setting>
1525
1526        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
1527                <default>false</default>
1528
1529                <description>
1530                        <para>
1531                                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.
1532                        </para>
1533                        <para>
1534                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
1535                        </para>
1536                </description>
1537        </bitlbee-setting>
1538
1539        <bitlbee-command name="rename">
1540                <short-description>Rename (renick) a buddy</short-description>
1541                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
1542                <syntax>rename -del &lt;oldnick&gt;</syntax>
1543
1544                <description>
1545                        <para>
1546                                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).
1547                        </para>
1548                       
1549                        <para>
1550                                <emphasis>rename -del</emphasis> can be used to erase your manually set nickname for a contact and reset it to what was automatically generated.
1551                        </para>
1552                </description>
1553
1554                <ircexample>
1555                        <ircline nick="itsme">rename itsme_ you</ircline>
1556                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
1557                </ircexample>
1558
1559        </bitlbee-command>
1560
1561        <bitlbee-command name="yes">
1562                <short-description>Accept a request</short-description>
1563                <syntax>yes [&lt;number&gt;]</syntax>
1564
1565                <description>
1566                        <para>
1567                                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.
1568                        </para>
1569
1570                        <para>
1571                                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.
1572                        </para>
1573                </description>
1574
1575        </bitlbee-command>
1576
1577        <bitlbee-command name="no">
1578                <short-description>Deny a request</short-description>
1579                <syntax>no [&lt;number&gt;]</syntax>
1580
1581                <description>
1582                        <para>
1583                                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.
1584                        </para>
1585
1586                        <para>
1587                                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.
1588                        </para>
1589                </description>
1590        </bitlbee-command>
1591
1592        <bitlbee-command name="qlist">
1593                <short-description>List all the unanswered questions root asked</short-description>
1594                <syntax>qlist</syntax>
1595
1596                <description>
1597                        <para>
1598                                This gives you a list of all the unanswered questions from root.
1599                        </para>
1600                </description>
1601
1602        </bitlbee-command>
1603
1604        <bitlbee-command name="register">
1605                <short-description>Register yourself</short-description>
1606                <syntax>register &lt;password&gt;</syntax>
1607
1608                <description>
1609                        <para>
1610                                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.
1611                        </para>
1612
1613                        <para>
1614                                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.. ;-)
1615                        </para>
1616
1617                        <para>
1618                                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.
1619                        </para>
1620                </description>
1621
1622        </bitlbee-command>
1623
1624        <bitlbee-command name="identify">
1625                <syntax>identify [-noload|-force] &lt;password&gt;</syntax>
1626                <short-description>Identify yourself with your password</short-description>
1627
1628                <description>
1629                        <para>
1630                                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.
1631                        </para>
1632
1633                        <para>
1634                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
1635                        </para>
1636
1637                        <para>
1638                                The <emphasis>-noload</emphasis> and <emphasis>-force</emphasis> flags can be used to identify when you're logged into some IM accounts already. <emphasis>-force</emphasis> will let you identify yourself and load all saved accounts (and keep the accounts you're logged into already).
1639                        </para>
1640                       
1641                        <para>
1642                                <emphasis>-noload</emphasis> will log you in but not load any accounts and settings saved under your current nickname. These will be overwritten once you save your settings (i.e. when you disconnect).
1643                        </para>
1644                </description>
1645        </bitlbee-command>
1646
1647        <bitlbee-command name="drop">
1648                <syntax>drop &lt;password&gt;</syntax>
1649                <short-description>Drop your account</short-description>
1650
1651                <description>
1652                        <para>
1653                                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.
1654                        </para>
1655                </description>
1656        </bitlbee-command>
1657
1658        <bitlbee-command name="blist">
1659                <syntax>blist [all|online|offline|away]</syntax>
1660                <short-description>List all the buddies in the current channel</short-description>
1661
1662                <description>
1663                        <para>
1664                                You can get a more 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.
1665                        </para>
1666                </description>
1667
1668        </bitlbee-command>
1669
1670        <bitlbee-command name="group">
1671                <short-description>Contact group management</short-description>
1672                <syntax>group list</syntax>
1673
1674                <description>
1675                        <para>
1676                                Only the <emphasis>group list</emphasis> command is supported at the moment, which shows a list of all groups defined so far.
1677                        </para>
1678                       
1679                        <para>
1680                                If you want to move contacts between groups, you can use the IRC <emphasis>/invite</emphasis> command. Also, if you use the <emphasis>add</emphasis> command in a control channel configured to show just one group, the new contact will automatically be added to that group.
1681                        </para>
1682                </description>
1683        </bitlbee-command>
1684       
1685        <bitlbee-command name="transfer">
1686                <short-description>Monitor, cancel, or reject file transfers</short-description>
1687                <syntax>transfer [&lt;cancel&gt; id | &lt;reject&gt;]</syntax>
1688               
1689                <description>
1690                        <para>
1691                                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 transfer &lt;action&gt;</emphasis> for more information.
1692                        </para>
1693
1694                        <ircexample>
1695                                <ircline nick="ulim">transfer</ircline>
1696                        </ircexample>
1697                </description>
1698               
1699                <bitlbee-command name="cancel">
1700                        <short-description>Cancels the file transfer with the given id</short-description>
1701                        <syntax>transfer &lt;cancel&gt; id</syntax>
1702
1703                        <description>
1704                                <para>Cancels the file transfer with the given id</para>
1705                        </description>
1706
1707                        <ircexample>
1708                                <ircline nick="ulim">transfer cancel 1</ircline>
1709                                <ircline nick="root">Canceling file transfer for test</ircline>
1710                        </ircexample>
1711                </bitlbee-command>
1712
1713                <bitlbee-command name="reject">
1714                        <short-description>Rejects all incoming transfers</short-description>
1715                        <syntax>transfer &lt;reject&gt;</syntax>
1716
1717                        <description>
1718                                <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>
1719                        </description>
1720
1721                        <ircexample>
1722                                <ircline nick="ulim">transfer reject</ircline>
1723                        </ircexample>
1724                </bitlbee-command>
1725        </bitlbee-command>
1726       
1727</chapter>
Note: See TracBrowser for help on using the repository browser.