source: doc/user-guide/commands.xml @ 858ea01

Last change on this file since 858ea01 was f5c0d8e, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-08-31T20:06:14Z

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