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

Last change on this file since df61c35a was 3f10fad, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-08-25T21:37:57Z

The "transfers" command was renamed to "transfer" but this wasn't reflected
in the docs so far.

  • Property mode set to 100644
File size: 59.1 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 come from a contact called twitter_(yourusername). You can change this behaviour using the <emphasis>mode</emphasis> setting (see <emphasis>help set mode</emphasis>).
76                                        </para>
77                                       
78                                        <para>
79                                                To send tweets yourself, send them to the twitter_(yourusername) contact, or just write in the groupchat channel if you enabled that option.
80                                        </para>
81
82                                        <para>
83                                                Since Twitter now requires OAuth authentication, you should not enter your Twitter password into BitlBee. Just type a bogus password. The first time you log in, BitlBee will start OAuth authentication. (See <emphasis>help set oauth</emphasis>.)
84                                        </para>
85                                </description>
86                        </bitlbee-command>
87
88                        <bitlbee-command name="yahoo">
89                                <syntax>account add yahoo &lt;handle&gt; &lt;password&gt;</syntax>
90
91                                <description>
92                                        <para>
93                                                For Yahoo! connections there are no special arguments.
94                                        </para>
95                                </description>
96                        </bitlbee-command>
97
98                </bitlbee-command>
99
100                <bitlbee-command name="del">
101                        <syntax>account &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="set">
371                <short-description>Miscellaneous settings</short-description>
372                <syntax>set</syntax>
373                <syntax>set &lt;variable&gt;</syntax>
374                <syntax>set &lt;variable&gt; &lt;value&gt;</syntax>
375                <syntax>set -del &lt;variable&gt;</syntax>
376
377                <description>
378
379                        <para>
380                                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.
381                        </para>
382
383                        <para>
384                                To get more help information about a setting, try:
385                        </para>
386
387                </description>
388
389                <ircexample>
390                        <ircline nick="ctrlsoft">help set private</ircline>
391                </ircexample>
392
393        </bitlbee-command>
394
395        <bitlbee-command name="help">
396                <short-description>BitlBee help system</short-description>
397
398                <syntax>help [subject]</syntax>
399
400                <description>
401                        <para>
402                                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.
403                        </para>
404                </description>
405        </bitlbee-command>
406
407        <bitlbee-command name="save">
408                <short-description>Save your account data</short-description>
409                <syntax>save</syntax>
410
411                <description>
412                        <para>
413                                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... ;-)
414                        </para>
415                </description>
416        </bitlbee-command>
417
418        <bitlbee-setting name="account" type="string" scope="channel">
419
420                <description>
421                        <para>
422                                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.
423                        </para>
424                </description>
425        </bitlbee-setting>
426
427        <bitlbee-setting name="allow_takeover" type="boolean" scope="global">
428                <default>true</default>
429
430                <description>
431                        <para>
432                                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.
433                        </para>
434                </description>
435        </bitlbee-setting>
436
437        <bitlbee-setting name="auto_connect" type="boolean" scope="both">
438                <default>true</default>
439
440                <description>
441                        <para>
442                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
443                        </para>
444                       
445                        <para>
446                                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!)
447                        </para>
448                </description>
449        </bitlbee-setting>
450
451        <bitlbee-setting name="auto_join" type="boolean" scope="channel">
452                <default>false</default>
453
454                <description>
455                        <para>
456                                With this option enabled, BitlBee will automatically join this channel when you log in.
457                        </para>
458                </description>
459        </bitlbee-setting>
460
461        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
462                <default>true</default>
463
464                <description>
465                        <para>
466                                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.
467                        </para>
468
469                        <para>
470                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
471                        </para>
472
473                        <para>
474                                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!)
475                        </para>
476                </description>
477        </bitlbee-setting>
478
479        <bitlbee-setting name="auto_reconnect_delay" type="string" scope="global">
480                <default>5*3&lt;900</default>
481
482                <description>
483                        <para>
484                                Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up.
485                        </para>
486
487                        <para>
488                                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.
489                        </para>
490
491                        <para>
492                                See also the <emphasis>auto_reconnect</emphasis> setting.
493                        </para>
494                </description>
495        </bitlbee-setting>
496
497        <bitlbee-setting name="auto_reply_timeout" type="integer" scope="account">
498                <default>10800</default>
499
500                <description>
501                        <para>
502                                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").
503                        </para>
504
505                        <para>
506                                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.
507                        </para>
508
509                        <para>
510                                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).
511                        </para>
512                </description>
513        </bitlbee-setting>
514
515        <bitlbee-setting name="away" type="string" scope="both">
516                <description>
517                        <para>
518                                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.
519                        </para>
520
521                        <para>
522                                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.
523                        </para>
524
525                        <para>
526                                Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>.
527                        </para>
528                </description>
529        </bitlbee-setting>
530
531        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
532                <default>true</default>
533
534                <description>
535                        <para>
536                                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.
537                        </para>
538                       
539                        <para>
540                                Replaced with the <emphasis>show_users</emphasis> setting. See <emphasis>help show_users</emphasis>.
541                        </para>
542                </description>
543        </bitlbee-setting>
544
545        <bitlbee-setting name="away_reply_timeout" type="integer" scope="global">
546                <default>3600</default>
547
548                <description>
549                        <para>
550                                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.
551                        </para>
552
553                        <para>
554                                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.
555                        </para>
556                </description>
557        </bitlbee-setting>
558
559        <bitlbee-setting name="base_url" type="string" scope="account">
560                <default>http://twitter.com</default>
561
562                <description>
563                        <para>
564                                There are more services that understand the Twitter API than just Twitter.com. BitlBee can connect to all Twitter API implementations.
565                        </para>
566
567                        <para>
568                                For example, set this setting to <emphasis>http://identi.ca/api</emphasis> to use Identi.ca.
569                        </para>
570
571                        <para>
572                                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.
573                        </para>
574                </description>
575        </bitlbee-setting>
576
577        <bitlbee-setting name="charset" type="string" scope="global">
578                <default>utf-8</default>
579                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
580
581                <description>
582                        <para>
583                                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.
584                        </para>
585
586                        <para>
587                                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
588                        </para>
589                </description>
590
591        </bitlbee-setting>
592
593        <bitlbee-setting name="control_channel" type="string" scope="global">
594                <default>&amp;bitlbee</default>
595
596                <description>
597                        <para>
598                                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.
599                        </para>
600                </description>
601        </bitlbee-setting>
602
603        <bitlbee-setting name="chat_type" type="string" scope="channel">
604                <default>groupchat</default>
605                <possible-values>groupchat, room</possible-values>
606
607                <description>
608                        <para>
609                                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.
610                        </para>
611                       
612                        <para>
613                                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.
614                        </para>
615                       
616                        <para>
617                                For setting up named chatrooms, it's currently easier to just use the <emphasis>chat add</emphasis> command.
618                        </para>
619                </description>
620        </bitlbee-setting>
621
622        <bitlbee-setting name="commands" type="boolean" scope="account">
623                <default>true</default>
624
625                <description>
626                        <para>
627                                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:
628                        </para>
629
630                        <variablelist>
631                                <varlistentry><term>undo [&lt;id&gt;]</term><listitem><para>Delete your last Tweet (or one with the given ID)</para></listitem></varlistentry>
632                                <varlistentry><term>rt &lt;screenname|id&gt;</term><listitem><para>Retweet someone's last Tweet (or one with the given ID)</para></listitem></varlistentry>
633                                <varlistentry><term>follow &lt;screenname&gt;</term><listitem><para>Start following a person</para></listitem></varlistentry>
634                                <varlistentry><term>unfollow &lt;screenname&gt;</term><listitem><para>Stop following a person</para></listitem></varlistentry>
635                                <varlistentry><term>post &lt;message&gt;</term><listitem><para>Post a tweet</para></listitem></varlistentry>
636                        </variablelist>
637
638                        <para>
639                                Anything that doesn't look like a command will be treated as a tweet. Watch out for typos! :-)
640                        </para>
641                </description>
642        </bitlbee-setting>
643
644        <bitlbee-setting name="debug" type="boolean" scope="global">
645                <default>false</default>
646
647                <description>
648                        <para>
649                                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.
650                        </para>
651                </description>
652        </bitlbee-setting>
653
654        <bitlbee-setting name="default_target" type="string" scope="global">
655                <default>root</default>
656                <possible-values>root, last</possible-values>
657
658                <description>
659                        <para>
660                                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>.
661                        </para>
662                </description>
663        </bitlbee-setting>
664
665        <bitlbee-setting name="display_name" type="string" scope="account">
666                <description>
667                        <para>
668                                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.
669                        </para>
670                </description>
671        </bitlbee-setting>
672
673        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
674                <default>false</default>
675
676                <description>
677                        <para>
678                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
679                        </para>
680                </description>
681        </bitlbee-setting>
682
683        <bitlbee-setting name="display_timestamps" type="boolean" scope="global">
684                <default>true</default>
685
686                <description>
687                        <para>
688                                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.
689                        </para>
690                </description>
691        </bitlbee-setting>
692
693        <bitlbee-setting name="fill_by" type="string" scope="channel">
694                <default>all</default>
695                <possible-values>all, group, account, protocol</possible-values>
696
697                <description>
698                        <para>
699                                For control channels only: This setting determines which contacts the channel gets populated with.
700                        </para>
701
702                        <para>
703                                By default, control channels will contain all your contacts. You instead select contacts by buddy group, IM account or IM protocol.
704                        </para>
705                       
706                        <para>
707                                Change this setting and the corresponding <emphasis>account</emphasis>/<emphasis>group</emphasis>/<emphasis>protocol</emphasis> setting to set up this selection.
708                        </para>
709                       
710                        <para>
711                                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>.
712                        </para>
713                </description>
714        </bitlbee-setting>
715
716        <bitlbee-setting name="group" type="string" scope="channel">
717
718                <description>
719                        <para>
720                                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.
721                        </para>
722                </description>
723        </bitlbee-setting>
724
725        <bitlbee-setting name="handle_unknown" type="string" scope="global">
726                <default>add_channel</default>
727                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
728
729                <description>
730                        <para>
731                                Messages from unknown users are echoed like this by default:
732                        </para>
733
734                        <ircexample>
735                                <ircline nick="root">Unknown message from handle 3137137:</ircline>
736                                <ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
737                        </ircexample>
738
739                        <para>
740                                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.
741                        </para>
742
743                        <note>
744                                <para>
745                                        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.
746                                </para>
747                        </note>
748                </description>
749
750        </bitlbee-setting>
751
752        <bitlbee-setting name="ignore_auth_requests" type="boolean" scope="account">
753                <default>false</default>
754
755                <description>
756                        <para>
757                                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.
758                        </para>
759                </description>
760
761        </bitlbee-setting>
762
763        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
764                <default>true</default>
765
766                <description>
767                        <para>
768                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
769                        </para>
770                </description>
771
772        </bitlbee-setting>
773
774        <bitlbee-setting name="local_display_name" type="boolean" scope="account">
775                <default>false</default>
776
777                <description>
778                        <para>
779                                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.
780                        </para>
781                </description>
782
783        </bitlbee-setting>
784
785        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
786                <default>false</default>
787
788                <description>
789                        <para>
790                                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.
791                        </para>
792                </description>
793
794        </bitlbee-setting>
795
796        <bitlbee-setting name="message_length" type="integer" scope="account">
797                <default>140</default>
798
799                <description>
800                        <para>
801                                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.
802                        </para>
803
804                        <para>
805                                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.
806                        </para>
807                </description>
808
809        </bitlbee-setting>
810
811        <bitlbee-setting name="mode" type="string" scope="account">
812                <possible-values>one, many, chat</possible-values>
813                <default>one</default>
814
815                <description>
816                        <para>
817                                By default, everything from the Twitter module will come from one nick, twitter_(yourusername). If you prefer to have individual nicks for everyone, you can set this setting to "many" instead.
818                        </para>
819                       
820                        <para>
821                                If you prefer to have all your Twitter things in a separate channel, you can set this setting to "chat".
822                        </para>
823                       
824                        <para>
825                                In the last two modes, you can send direct messages by /msg'ing your contacts directly. Note, however, that incoming DMs are not fetched yet.
826                        </para>
827                </description>
828
829        </bitlbee-setting>
830
831        <bitlbee-setting name="mobile_is_away" type="boolean" scope="global">
832                <default>false</default>
833
834                <description>
835                        <para>
836                                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.
837                        </para>
838                </description>
839
840        </bitlbee-setting>
841
842        <bitlbee-setting name="nick" type="string" scope="chat">
843                <description>
844                        <para>
845                                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.
846                        </para>
847                </description>
848        </bitlbee-setting>
849
850        <bitlbee-setting name="nick_format" type="string" scope="both">
851                <default>%-@nick</default>
852
853                <description>
854                        <para>
855                                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.
856                        </para>
857
858                        <para>
859                                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.
860                        </para>
861
862                        <para>
863                                It's easier to describe this setting using a few examples:
864                        </para>
865
866                        <para>
867                                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.
868                        </para>
869
870                        <para>
871                                [%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.
872                        </para>
873
874                        <para>
875                                See <emphasis>help nick_format</emphasis> for more information.
876                        </para>
877                </description>
878        </bitlbee-setting>
879
880        <bitlbee-setting name="nick_source" type="string" scope="account">
881                <default>handle</default>
882                <possible-values>handle, full_name, first_name</possible-values>
883
884                <description>
885                        <para>
886                                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.
887                        </para>
888
889                        <para>
890                                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.
891                        </para>
892                </description>
893        </bitlbee-setting>
894
895        <bitlbee-setting name="oauth" type="boolean" scope="account">
896                <default>true</default>
897
898                <description>
899                        <para>
900                                This enables OAuth authentication for Twitter accounts. From June 2010 this will be mandatory.
901                        </para>
902
903                        <para>
904                                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.
905                        </para>
906
907                        <para>
908                                The resulting access token will be saved permanently, so you have to do this only once.
909                        </para>
910                </description>
911
912        </bitlbee-setting>
913
914        <bitlbee-setting name="ops" type="string" scope="global">
915                <default>both</default>
916                <possible-values>both, root, user, none</possible-values>
917
918                <description>
919                        <para>
920                                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.
921                        </para>
922
923                        <para>
924                                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.
925                        </para>
926                </description>
927        </bitlbee-setting>
928
929        <bitlbee-setting name="password" type="string" scope="both">
930                <description>
931                        <para>
932                                Use this global setting to change your "NickServ" password.
933                        </para>
934                       
935                        <para>
936                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
937                        </para>
938                       
939                        <para>
940                                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.
941                        </para>
942                </description>
943        </bitlbee-setting>
944
945        <bitlbee-setting name="paste_buffer" type="boolean" scope="global">
946                <default>false</default>
947
948                <description>
949                        <para>
950                                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.
951                        </para>
952
953                        <para>
954                                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.
955                        </para>
956
957                        <para>
958                                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.
959                        </para>
960                </description>
961        </bitlbee-setting>
962
963        <bitlbee-setting name="paste_buffer_delay" type="integer" scope="global">
964                <default>200</default>
965
966                <description>
967
968                        <para>
969                                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.
970                        </para>
971
972                        <para>
973                                See also the <emphasis>paste_buffer</emphasis> setting.
974                        </para>
975                </description>
976        </bitlbee-setting>
977       
978        <bitlbee-setting name="port" type="integer" scope="account">
979                <description>
980                        <para>
981                                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.
982                        </para>
983                </description>
984        </bitlbee-setting>
985
986        <bitlbee-setting name="priority" type="integer" scope="account">
987                <default>0</default>
988
989                <description>
990                        <para>
991                                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).
992                        </para>
993
994                        <para>
995                                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).
996                        </para>
997                </description>
998        </bitlbee-setting>
999
1000        <bitlbee-setting name="private" type="boolean" scope="global">
1001                <default>true</default>
1002
1003                <description>
1004                        <para>
1005                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
1006                        </para>
1007
1008                        <para>
1009                                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.
1010                        </para>
1011                </description>
1012        </bitlbee-setting>
1013
1014        <bitlbee-setting name="protocol" type="string" scope="channel">
1015
1016                <description>
1017                        <para>
1018                                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.
1019                        </para>
1020                </description>
1021        </bitlbee-setting>
1022
1023        <bitlbee-setting name="query_order" type="string" scope="global">
1024                <default>lifo</default>
1025                <possible-values>lifo, fifo</possible-values>
1026
1027                <description>
1028                        <para>
1029                                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.
1030                        </para>
1031
1032                        <para>
1033                                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).
1034                        </para>
1035                </description>
1036        </bitlbee-setting>
1037
1038        <bitlbee-setting name="resource" type="string" scope="account">
1039                <default>BitlBee</default>
1040
1041                <description>
1042                        <para>
1043                                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.
1044                        </para>
1045                </description>
1046        </bitlbee-setting>
1047
1048        <bitlbee-setting name="resource_select" type="string" scope="account">
1049                <default>activity</default>
1050                <possible-values>priority, activity</possible-values>
1051
1052                <description>
1053                        <para>
1054                                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.
1055                        </para>
1056
1057                        <para>
1058                                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).
1059                        </para>
1060                </description>
1061        </bitlbee-setting>
1062
1063        <bitlbee-setting name="root_nick" type="string" scope="global">
1064                <default>root</default>
1065
1066                <description>
1067                        <para>
1068                                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.
1069                        </para>
1070                </description>
1071        </bitlbee-setting>
1072
1073        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
1074                <default>true</default>
1075
1076                <description>
1077                        <para>
1078                                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.
1079                        </para>
1080                </description>
1081        </bitlbee-setting>
1082
1083        <bitlbee-setting name="server" type="string" scope="account">
1084                <description>
1085                        <para>
1086                                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.
1087                        </para>
1088                </description>
1089        </bitlbee-setting>
1090
1091        <bitlbee-setting name="show_offline" type="boolean" scope="global">
1092                <default>false</default>
1093
1094                <description>
1095                        <para>
1096                                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.
1097                        </para>
1098                       
1099                        <para>
1100                                Replaced with the <emphasis>show_users</emphasis> setting. See <emphasis>help show_users</emphasis>.
1101                        </para>
1102                </description>
1103        </bitlbee-setting>
1104
1105        <bitlbee-setting name="show_users" type="string" scope="channel">
1106                <default>online+,away</default>
1107
1108                <description>
1109                        <para>
1110                                Comma-separated list of statuses of users you want in the channel,
1111                                and any modes they should have. The following statuses are currently
1112                                recognised: <emphasis>online</emphasis> (i.e. available, not
1113                                away), <emphasis>away</emphasis>, and <emphasis>offline</emphasis>.
1114                        </para>
1115                       
1116                        <para>
1117                                If a status is followed by a valid channel mode character
1118                                (@, % or +), it will be given to users with that status.
1119                                For example, <emphasis>online@,away+,offline</emphasis> will
1120                                show all users in the channel. Online people will
1121                                have +o, people who are online but away will have +v,
1122                                and others will have no special modes.
1123                        </para>
1124                </description>
1125        </bitlbee-setting>
1126
1127        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
1128                <default>true</default>
1129
1130                <description>
1131                        <para>
1132                                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.
1133                        </para>
1134                </description>
1135        </bitlbee-setting>
1136
1137        <bitlbee-setting name="ssl" type="boolean" scope="account">
1138                <default>false</default>
1139
1140                <description>
1141                        <para>
1142                                Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
1143                        </para>
1144                </description>
1145        </bitlbee-setting>
1146
1147        <bitlbee-setting name="status" type="string" scope="both">
1148                <description>
1149                        <para>
1150                                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.
1151                        </para>
1152
1153                        <para>
1154                                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).
1155                        </para>
1156
1157                        <para>
1158                                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>.
1159                        </para>
1160                </description>
1161        </bitlbee-setting>
1162
1163        <bitlbee-setting name="strip_html" type="boolean" scope="global">
1164                <default>true</default>
1165
1166                <description>
1167                        <para>
1168                                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.
1169                        </para>
1170                        <para>
1171                                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.
1172                        </para>
1173                </description>
1174        </bitlbee-setting>
1175
1176        <bitlbee-setting name="switchboard_keepalives" type="boolean" scope="account">
1177                <default>false</default>
1178
1179                <description>
1180                        <para>
1181                                Turn on this flag if you have difficulties talking to offline/invisible contacts.
1182                        </para>
1183                       
1184                        <para>
1185                                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.
1186                        </para>
1187                       
1188                        <para>
1189                                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.
1190                        </para>
1191                </description>
1192        </bitlbee-setting>
1193
1194        <bitlbee-setting name="tag" type="string" scope="account">
1195                <description>
1196                        <para>
1197                                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.
1198                        </para>
1199
1200                        <para>
1201                                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.
1202                        </para>
1203                </description>
1204        </bitlbee-setting>
1205
1206        <bitlbee-setting name="timezone" type="string" scope="global">
1207                <default>local</default>
1208                <possible-values>local, utc, gmt, timezone-spec</possible-values>
1209
1210                <description>
1211                        <para>
1212                                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.
1213                        </para>
1214
1215                        <para>
1216                                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.
1217                        </para>
1218                </description>
1219        </bitlbee-setting>
1220
1221        <bitlbee-setting name="tls" type="boolean" scope="account">
1222                <default>try</default>
1223
1224                <description>
1225                        <para>
1226                                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.
1227                        </para>
1228
1229                        <para>
1230                                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.
1231                        </para>
1232                </description>
1233        </bitlbee-setting>
1234
1235        <bitlbee-setting name="to_char" type="string" scope="global">
1236                <default>": "</default>
1237
1238                <description>
1239                        <para>
1240                                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>.
1241                        </para>
1242
1243                        <para>
1244                                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.
1245                        </para>
1246                </description>
1247        </bitlbee-setting>
1248
1249        <bitlbee-setting name="translate_to_nicks" type="boolean" scope="channel">
1250                <default>true</default>
1251
1252                <description>
1253                        <para>
1254                                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.
1255                        </para>
1256
1257                        <para>
1258                                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.
1259                        </para>
1260                </description>
1261        </bitlbee-setting>
1262
1263        <bitlbee-setting name="type" type="string" scope="channel">
1264                <default>control</default>
1265                <possible-values>control, chat</possible-values>
1266
1267                <description>
1268                        <para>
1269                                BitlBee supports two kinds of channels: control channels (usually with a name starting with a &amp;) and chatroom channels (name usually starts with a #).
1270                        </para>
1271
1272                        <para>
1273                                See <emphasis>help channels</emphasis> for a full description of channel types in BitlBee.
1274                        </para>
1275                </description>
1276        </bitlbee-setting>
1277
1278        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
1279                <default>false</default>
1280
1281                <description>
1282                        <para>
1283                                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.
1284                        </para>
1285                </description>
1286        </bitlbee-setting>
1287
1288        <bitlbee-setting name="user_agent" type="string" scope="account">
1289                <default>BitlBee</default>
1290
1291                <description>
1292                        <para>
1293                                Some Jabber servers are configured to only allow a few (or even just one) kinds of XMPP clients to connect to them.
1294                        </para>
1295                       
1296                        <para>
1297                                You can change this setting to make BitlBee present itself as a different client, so that you can still connect to these servers.
1298                        </para>
1299                </description>
1300        </bitlbee-setting>
1301
1302        <bitlbee-setting name="web_aware" type="string" scope="account">
1303                <default>false</default>
1304
1305                <description>
1306                        <para>
1307                                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.
1308                        </para>
1309
1310                        <para>
1311                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
1312                        </para>
1313                </description>
1314        </bitlbee-setting>
1315
1316        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
1317                <default>false</default>
1318
1319                <description>
1320                        <para>
1321                                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.
1322                        </para>
1323                        <para>
1324                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
1325                        </para>
1326                </description>
1327        </bitlbee-setting>
1328
1329        <bitlbee-command name="rename">
1330                <short-description>Rename (renick) a buddy</short-description>
1331                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
1332
1333                <description>
1334                        <para>
1335                                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).
1336                        </para>
1337                </description>
1338
1339                <ircexample>
1340                        <ircline nick="itsme">rename itsme_ you</ircline>
1341                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
1342                </ircexample>
1343
1344        </bitlbee-command>
1345
1346        <bitlbee-command name="yes">
1347                <short-description>Accept a request</short-description>
1348                <syntax>yes [&lt;number&gt;]</syntax>
1349
1350                <description>
1351                        <para>
1352                                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.
1353                        </para>
1354
1355                        <para>
1356                                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.
1357                        </para>
1358                </description>
1359
1360        </bitlbee-command>
1361
1362        <bitlbee-command name="no">
1363                <short-description>Deny a request</short-description>
1364                <syntax>no [&lt;number&gt;]</syntax>
1365
1366                <description>
1367                        <para>
1368                                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.
1369                        </para>
1370
1371                        <para>
1372                                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.
1373                        </para>
1374                </description>
1375        </bitlbee-command>
1376
1377        <bitlbee-command name="qlist">
1378                <short-description>List all the unanswered questions root asked</short-description>
1379                <syntax>qlist</syntax>
1380
1381                <description>
1382                        <para>
1383                                This gives you a list of all the unanswered questions from root.
1384                        </para>
1385                </description>
1386
1387        </bitlbee-command>
1388
1389        <bitlbee-command name="register">
1390                <short-description>Register yourself</short-description>
1391                <syntax>register &lt;password&gt;</syntax>
1392
1393                <description>
1394                        <para>
1395                                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.
1396                        </para>
1397
1398                        <para>
1399                                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.. ;-)
1400                        </para>
1401
1402                        <para>
1403                                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.
1404                        </para>
1405                </description>
1406
1407        </bitlbee-command>
1408
1409        <bitlbee-command name="identify">
1410                <syntax>identify [-noload|-force] &lt;password&gt;</syntax>
1411                <short-description>Identify yourself with your password</short-description>
1412
1413                <description>
1414                        <para>
1415                                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.
1416                        </para>
1417
1418                        <para>
1419                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
1420                        </para>
1421
1422                        <para>
1423                                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).
1424                        </para>
1425                       
1426                        <para>
1427                                <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).
1428                        </para>
1429                </description>
1430        </bitlbee-command>
1431
1432        <bitlbee-command name="drop">
1433                <syntax>drop &lt;password&gt;</syntax>
1434                <short-description>Drop your account</short-description>
1435
1436                <description>
1437                        <para>
1438                                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.
1439                        </para>
1440                </description>
1441        </bitlbee-command>
1442
1443        <bitlbee-command name="blist">
1444                <syntax>blist [all|online|offline|away]</syntax>
1445                <short-description>List all the buddies in the current channel</short-description>
1446
1447                <description>
1448                        <para>
1449                                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.
1450                        </para>
1451                </description>
1452
1453        </bitlbee-command>
1454
1455        <bitlbee-command name="group">
1456                <short-description>Contact group management</short-description>
1457                <syntax>group list</syntax>
1458
1459                <description>
1460                        <para>
1461                                Only the <emphasis>group list</emphasis> command is supported at the moment, which shows a list of all groups defined so far.
1462                        </para>
1463                </description>
1464        </bitlbee-command>
1465       
1466        <bitlbee-command name="transfer">
1467                <short-description>Monitor, cancel, or reject file transfers</short-description>
1468                <syntax>transfer [&lt;cancel&gt; id | &lt;reject&gt;]</syntax>
1469               
1470                <description>
1471                        <para>
1472                                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.
1473                        </para>
1474
1475                        <ircexample>
1476                                <ircline nick="ulim">transfer</ircline>
1477                        </ircexample>
1478                </description>
1479               
1480                <bitlbee-command name="cancel">
1481                        <short-description>Cancels the file transfer with the given id</short-description>
1482                        <syntax>transfer &lt;cancel&gt; id</syntax>
1483
1484                        <description>
1485                                <para>Cancels the file transfer with the given id</para>
1486                        </description>
1487
1488                        <ircexample>
1489                                <ircline nick="ulim">transfer cancel 1</ircline>
1490                                <ircline nick="root">Canceling file transfer for test</ircline>
1491                        </ircexample>
1492                </bitlbee-command>
1493
1494                <bitlbee-command name="reject">
1495                        <short-description>Rejects all incoming transfers</short-description>
1496                        <syntax>transfer &lt;reject&gt;</syntax>
1497
1498                        <description>
1499                                <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>
1500                        </description>
1501
1502                        <ircexample>
1503                                <ircline nick="ulim">transfer reject</ircline>
1504                        </ircexample>
1505                </bitlbee-command>
1506        </bitlbee-command>
1507       
1508</chapter>
Note: See TracBrowser for help on using the repository browser.