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

Last change on this file since c133d4b8 was 704dd38, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-06-01T21:51:27Z

Merging head.
  • Property mode set to 100644
File size: 46.4 KB
Line 
1<chapter id="commands">
2        <title>Bitlbee commands</title>
3
4        <command-list/>
5
6        <bitlbee-command name="account">
7                <short-description>IM-account list maintenance</short-description>
8                <syntax>account &lt;action&gt; [&lt;arguments&gt;]</syntax>
9
10                <description>
11
12                        <para>
13                                Available actions: add, del, list, on, off and set. See <emphasis>help account &lt;action&gt;</emphasis> for more information.
14                        </para>
15
16                </description>
17
18                <bitlbee-command name="add">
19                        <syntax>account add &lt;protocol&gt; &lt;username&gt; &lt;password&gt;</syntax>
20
21                        <description>
22                                <para>
23                                        Adds an account on the given server with the specified protocol, username and password to the account list. Supported protocols right now are: Jabber, MSN, OSCAR (AIM/ICQ), Yahoo and Twitter. For more information about adding an account, see <emphasis>help account add &lt;protocol&gt;</emphasis>.
24                                </para>
25                        </description>
26                       
27                        <bitlbee-command name="jabber">
28                                <syntax>account add jabber &lt;handle@server.tld&gt; &lt;password&gt;</syntax>
29
30                                <description>
31                                        <para>
32                                                The handle should be a full handle, including the domain name. You can specify a servername if necessary. Normally BitlBee doesn't need this though, since it's able to find out the server by doing DNS SRV lookups.
33                                        </para>
34
35                                        <para>
36                                                In previous versions it was also possible to specify port numbers and/or SSL in the server tag. This is deprecated and should now be done using the <emphasis>account set</emphasis> command. This also applies to specifying a resource in the handle (like <emphasis>wilmer@bitlbee.org/work</emphasis>).
37                                        </para>
38                                </description>
39                        </bitlbee-command>
40
41                        <bitlbee-command name="msn">
42                                <syntax>account add msn &lt;handle@server.tld&gt; &lt;password&gt;</syntax>
43
44                                <description>
45                                        <para>
46                                                For MSN connections there are no special arguments.
47                                        </para>
48                                </description>
49                        </bitlbee-command>
50                       
51                        <bitlbee-command name="oscar">
52                                <syntax>account add oscar &lt;handle&gt; &lt;password&gt;</syntax>
53
54                                <description>
55                                        <para>
56                                                OSCAR is the protocol used to connect to AIM and/or ICQ. The servers will automatically detect if you're using a numeric or non-numeric username so there's no need to tell which network you want to connect to.
57                                        </para>
58                                </description>
59
60                                <ircexample>
61                                        <ircline nick="wilmer">account add oscar 72696705 hobbelmeeuw</ircline>
62                                        <ircline nick="root">Account successfully added</ircline>
63                                </ircexample>
64                        </bitlbee-command>
65                       
66                        <bitlbee-command name="twitter">
67                                <syntax>account add twitter &lt;handle&gt; &lt;password&gt;</syntax>
68
69                                <description>
70                                        <para>
71                                                This module gives you simple access to Twitter. Although it uses the Twitter API, only Twitter itself is supported at the moment.
72                                        </para>
73                                       
74                                        <para>
75                                                By default all your Twitter contacts will come from a contact called twitter_(yourusername). You can change this behaviour using the <emphasis>mode</emphasis> setting (see <emphasis>help set mode</emphasis>).
76                                        </para>
77                                       
78                                        <para>
79                                                To send tweets yourself, send them to the twitter_(yourusername) contact, or just write in the groupchat channel if you enabled that option.
80                                        </para>
81
82                                        <para>
83                                                Since Twitter now requires OAuth authentication, you should not enter your Twitter password into BitlBee. Just type a bogus password. The first time you log in, BitlBee will start OAuth authentication. (See <emphasis>help set oauth</emphasis>.)
84                                        </para>
85                                </description>
86                        </bitlbee-command>
87
88                        <bitlbee-command name="yahoo">
89                                <syntax>account add yahoo &lt;handle&gt; &lt;password&gt;</syntax>
90
91                                <description>
92                                        <para>
93                                                For Yahoo! connections there are no special arguments.
94                                        </para>
95                                </description>
96                        </bitlbee-command>
97
98                </bitlbee-command>
99
100                <bitlbee-command name="del">
101                        <syntax>account del &lt;account id&gt;</syntax>
102
103                        <description>
104                                <para>
105                                        This commands deletes an account from your account list. You should signoff the account before deleting it.
106                                </para>
107
108
109                                <para>
110                                        The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
111                                </para>
112                        </description>
113                </bitlbee-command>
114
115                <bitlbee-command name="on">
116                        <syntax>account on [&lt;account id&gt;]</syntax>
117
118                        <description>
119                                <para>
120                                        This command will try to log into the specified account. If no account is specified, BitlBee will log into all the accounts that have the auto_connect flag set.
121                                </para>
122
123                                <para>
124                                        The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
125                                </para>
126                        </description>
127
128                </bitlbee-command>
129
130                <bitlbee-command name="off">
131                        <syntax>account off [&lt;account id&gt;]</syntax>
132
133                        <description>
134                                <para>
135                                        This command disconnects the connection for the specified account. If no account is specified, BitlBee will deactivate all active accounts and cancel all pending reconnects.
136                                </para>
137
138                                <para>
139                                        The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
140                                </para>
141                        </description>
142                </bitlbee-command>
143
144                <bitlbee-command name="list">
145                        <syntax>account list</syntax>
146
147                        <description>
148                                <para>
149                                        This command gives you a list of all the accounts known by BitlBee.
150                                </para>
151                        </description>
152                </bitlbee-command>
153
154                <bitlbee-command name="set">
155                        <syntax>account set &lt;account id&gt;</syntax>
156                        <syntax>account set &lt;account id&gt;/&lt;setting&gt;</syntax>
157                        <syntax>account set &lt;account id&gt;/&lt;setting&gt; &lt;value&gt;</syntax>
158                        <syntax>account set -del &lt;account id&gt;/&lt;setting&gt;</syntax>
159
160                        <description>
161                                <para>
162                                        This command can be used to change various settings for IM accounts. For all protocols, this command can be used to change the handle or the password BitlBee uses to log in and if it should be logged in automatically. Some protocols have additional settings. You can see the settings available for a connection by typing <emphasis>account set &lt;account id&gt;</emphasis>.
163                                </para>
164                               
165                                <para>
166                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
167                                </para>
168                               
169                                <para>
170                                        The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
171                                </para>
172                        </description>
173                </bitlbee-command>
174        </bitlbee-command>
175
176        <bitlbee-command name="chat">
177                <short-description>Chatroom list maintenance</short-description>
178                <syntax>chat &lt;action&gt; [&lt;arguments&gt;]</syntax>
179
180                <description>
181
182                        <para>
183                                Available actions: add, del, list, with and set. See <emphasis>help chat &lt;action&gt;</emphasis> for more information.
184                        </para>
185
186                </description>
187
188                <bitlbee-command name="add">
189                        <syntax>chat add &lt;account&gt; &lt;room&gt; [&lt;channel&gt;]</syntax>
190
191                        <description>
192                                <para>
193                                        Add a chatroom to the list of chatrooms you're interested in. BitlBee needs this list to map room names to a proper IRC channel name.
194                                </para>
195
196                                <para>
197                                        After adding a room to your list, you can simply use the IRC /join command to enter the room. Also, you can tell BitlBee to automatically join the room when you log in. (See <emphasis>chat set</emphasis>)
198                                </para>
199
200                                <para>
201                                        Password-protected rooms work exactly like on IRC, by passing the password as an extra argument to /join.
202                                </para>
203                        </description>
204
205                </bitlbee-command>
206
207                <bitlbee-command name="del">
208                        <syntax>chat del &lt;chat id&gt;</syntax>
209
210                        <description>
211                                <para>
212                                        This commands deletes an chatroom from your list.
213                                </para>
214
215                                <para>
216                                        The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.
217                                </para>
218                        </description>
219                </bitlbee-command>
220
221                <bitlbee-command name="list">
222                        <syntax>chat list</syntax>
223
224                        <description>
225                                <para>
226                                        This command gives you a list of all the chatrooms known by BitlBee.
227                                </para>
228                        </description>
229                </bitlbee-command>
230
231                <bitlbee-command name="with">
232                        <syntax>chat with &lt;nickname&gt;</syntax>
233
234                        <description>
235                                <para>
236                                        While most <emphasis>chat</emphasis> subcommands are about named chatrooms, this command can be used to open an unnamed groupchat with one or more persons. This command is what <emphasis>/join #nickname</emphasis> used to do in older BitlBee versions.
237                                </para>
238                        </description>
239                </bitlbee-command>
240
241                <bitlbee-command name="set">
242                        <syntax>chat set &lt;chat id&gt;</syntax>
243                        <syntax>chat set &lt;chat id&gt;/&lt;setting&gt;</syntax>
244                        <syntax>chat set &lt;chat id&gt;/&lt;setting&gt; &lt;value&gt;</syntax>
245                        <syntax>chat set -del &lt;chat id&gt;/&lt;setting&gt;</syntax>
246
247                        <description>
248                                <para>
249                                        This command can be used to change various settings for chatrooms.
250                                </para>
251                               
252                                <para>
253                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
254                                </para>
255                               
256                                <para>
257                                        The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.
258                                </para>
259                        </description>
260                </bitlbee-command>
261        </bitlbee-command>
262
263        <bitlbee-command name="add">
264                <short-description>Add a buddy to your contact list</short-description>
265                <syntax>add &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
266                <syntax>add -tmp &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
267
268                <description>
269                        <para>
270                                Adds the given buddy at the specified connection to your buddy list. The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
271                        </para>
272
273                        <para>
274                                If you want, you can also tell BitlBee what nick to give the new contact. The -tmp option adds the buddy to the internal BitlBee structures only, not to the real contact list (like done by <emphasis>set handle_unknown add</emphasis>). This allows you to talk to people who are not in your contact list. This normally won't show you any presence notifications.
275                        </para>
276                </description>
277
278                <ircexample>
279                        <ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
280                        <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
281                </ircexample>
282        </bitlbee-command>
283
284        <bitlbee-command name="info">
285                <short-description>Request user information</short-description>
286                <syntax>info &lt;connection&gt; &lt;handle&gt;</syntax>
287                <syntax>info &lt;nick&gt;</syntax>
288
289                <description>
290                        <para>
291                                Requests IM-network-specific information about the specified user. The amount of information you'll get differs per protocol. For some protocols (ATM Yahoo! and MSN) it'll give you an URL which you can visit with a normal web browser to get the information.
292                        </para>
293                </description>
294
295                <ircexample>
296                        <ircline nick="ctrlsoft">info 0 72696705</ircline>
297                        <ircline nick="root">User info - UIN: 72696705   Nick: Lintux   First/Last name: Wilmer van der Gaast   E-mail: lintux@lintux.cx</ircline>
298                </ircexample>
299
300        </bitlbee-command>
301
302        <bitlbee-command name="remove">
303                <short-description>Remove a buddy from your contact list</short-description>
304                <syntax>remove &lt;nick&gt;</syntax>
305
306                <description>
307                        <para>
308                                Removes the specified nick from your buddy list.
309                        </para>
310                </description>
311
312                <ircexample>
313                        <ircline nick="ctrlsoft">remove gryp</ircline>
314                        <ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction>
315                </ircexample>
316
317        </bitlbee-command>
318
319        <bitlbee-command name="block">
320                <short-description>Block someone</short-description>
321                <syntax>block &lt;nick&gt;</syntax>
322                <syntax>block &lt;connection&gt; &lt;handle&gt;</syntax>
323                <syntax>block &lt;connection&gt;</syntax>
324
325                <description>
326                        <para>
327                                Puts the specified user on your ignore list. Either specify the user's nick when you have him/her in your contact list or a connection number and a user handle.
328                        </para>
329                       
330                        <para>
331                                When called with only a connection specification as an argument, the command displays the current block list for that connection.
332                        </para>
333                </description>
334        </bitlbee-command>
335
336        <bitlbee-command name="allow">
337                <short-description>Unblock someone</short-description>
338                <syntax>allow &lt;nick&gt;</syntax>
339                <syntax>allow &lt;connection&gt; &lt;handle&gt;</syntax>
340
341                <description>
342                        <para>
343                                Reverse of block. Unignores the specified user or user handle on specified connection.
344                        </para>
345                       
346                        <para>
347                                When called with only a connection specification as an argument, the command displays the current allow list for that connection.
348                        </para>
349                </description>
350        </bitlbee-command>
351
352        <bitlbee-command name="set">
353                <short-description>Miscellaneous settings</short-description>
354                <syntax>set</syntax>
355                <syntax>set &lt;variable&gt;</syntax>
356                <syntax>set &lt;variable&gt; &lt;value&gt;</syntax>
357                <syntax>set -del &lt;variable&gt;</syntax>
358
359                <description>
360
361                        <para>
362                                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.
363                        </para>
364
365                        <para>
366                                To get more help information about a setting, try:
367                        </para>
368
369                </description>
370
371                <ircexample>
372                        <ircline nick="ctrlsoft">help set private</ircline>
373                </ircexample>
374
375        </bitlbee-command>
376
377        <bitlbee-command name="help">
378                <short-description>BitlBee help system</short-description>
379
380                <syntax>help [subject]</syntax>
381
382                <description>
383                        <para>
384                                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.
385                        </para>
386                </description>
387        </bitlbee-command>
388
389        <bitlbee-command name="save">
390                <short-description>Save your account data</short-description>
391                <syntax>save</syntax>
392
393                <description>
394                        <para>
395                                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... ;-)
396                        </para>
397                </description>
398        </bitlbee-command>
399
400        <bitlbee-setting name="auto_connect" type="boolean" scope="both">
401                <default>true</default>
402
403                <description>
404                        <para>
405                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
406                        </para>
407                       
408                        <para>
409                                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!)
410                        </para>
411                </description>
412        </bitlbee-setting>
413
414        <bitlbee-setting name="auto_join" type="boolean" scope="chat">
415                <default>false</default>
416
417                <description>
418                        <para>
419                                With this option enabled, BitlBee will automatically join this chatroom when you log in.
420                        </para>
421                </description>
422        </bitlbee-setting>
423
424        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
425                <default>true</default>
426
427                <description>
428                        <para>
429                                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.
430                        </para>
431
432                        <para>
433                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
434                        </para>
435
436                        <para>
437                                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!)
438                        </para>
439                </description>
440        </bitlbee-setting>
441
442        <bitlbee-setting name="auto_reconnect_delay" type="string" scope="global">
443                <default>5*3&lt;900</default>
444
445                <description>
446                        <para>
447                                Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up.
448                        </para>
449
450                        <para>
451                                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.
452                        </para>
453
454                        <para>
455                                See also the <emphasis>auto_reconnect</emphasis> setting.
456                        </para>
457                </description>
458        </bitlbee-setting>
459
460        <bitlbee-setting name="away" type="string" scope="both">
461                <description>
462                        <para>
463                                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.
464                        </para>
465
466                        <para>
467                                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.
468                        </para>
469
470                        <para>
471                                Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>.
472                        </para>
473                </description>
474        </bitlbee-setting>
475
476        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
477                <default>true</default>
478
479                <description>
480                        <para>
481                                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.
482                        </para>
483                </description>
484        </bitlbee-setting>
485
486        <bitlbee-setting name="buddy_sendbuffer" type="boolean" scope="global">
487                <default>false</default>
488
489                <description>
490                        <para>
491                                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.
492                        </para>
493
494                        <para>
495                                Using the <emphasis>buddy_sendbuffer_delay</emphasis> setting you can specify the number of seconds BitlBee should wait for more data before the complete message is sent.
496                        </para>
497
498                        <para>
499                                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.
500                        </para>
501                </description>
502        </bitlbee-setting>
503
504        <bitlbee-setting name="buddy_sendbuffer_delay" type="integer" scope="global">
505                <default>200</default>
506
507                <description>
508
509                        <para>
510                                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.
511                        </para>
512
513                        <para>
514                                See also the <emphasis>buddy_sendbuffer</emphasis> setting.
515                        </para>
516                </description>
517        </bitlbee-setting>
518
519        <bitlbee-setting name="charset" type="string" scope="global">
520                <default>utf-8</default>
521                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
522
523                <description>
524                        <para>
525                                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.
526                        </para>
527
528                        <para>
529                                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
530                        </para>
531                </description>
532
533        </bitlbee-setting>
534
535        <bitlbee-setting name="control_channel" type="string" scope="global">
536                <default>&amp;bitlbee</default>
537
538                <description>
539                        <para>
540                                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.
541                        </para>
542                </description>
543        </bitlbee-setting>
544
545        <bitlbee-setting name="debug" type="boolean" scope="global">
546                <default>false</default>
547
548                <description>
549                        <para>
550                                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.
551                        </para>
552                </description>
553        </bitlbee-setting>
554
555        <bitlbee-setting name="default_target" type="string" scope="global">
556                <default>root</default>
557                <possible-values>root, last</possible-values>
558
559                <description>
560                        <para>
561                                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>.
562                        </para>
563                </description>
564        </bitlbee-setting>
565
566        <bitlbee-setting name="display_name" type="string" scope="account">
567                <description>
568                        <para>
569                                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.
570                        </para>
571                </description>
572        </bitlbee-setting>
573
574        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
575                <default>false</default>
576
577                <description>
578                        <para>
579                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
580                        </para>
581                </description>
582        </bitlbee-setting>
583
584        <bitlbee-setting name="display_timestamps" type="boolean" scope="global">
585                <default>true</default>
586
587                <description>
588                        <para>
589                                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.
590                        </para>
591                </description>
592        </bitlbee-setting>
593
594        <bitlbee-setting name="handle_unknown" type="string" scope="global">
595                <default>root</default>
596                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
597
598                <description>
599                        <para>
600                                Messages from unknown users are echoed like this by default:
601                        </para>
602
603                        <ircexample>
604                                <ircline nick="root">Unknown message from handle 3137137:</ircline>
605                                <ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
606                        </ircexample>
607
608                        <para>
609                                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.
610                        </para>
611
612                        <note>
613                                <para>
614                                        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.
615                                </para>
616                        </note>
617                </description>
618
619        </bitlbee-setting>
620
621        <bitlbee-setting name="ignore_auth_requests" type="boolean" scope="account">
622                <default>false</default>
623
624                <description>
625                        <para>
626                                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.
627                        </para>
628                </description>
629
630        </bitlbee-setting>
631
632        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
633                <default>true</default>
634
635                <description>
636                        <para>
637                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
638                        </para>
639                </description>
640
641        </bitlbee-setting>
642
643        <bitlbee-setting name="local_display_name" type="boolean" scope="account">
644                <default>false</default>
645
646                <description>
647                        <para>
648                                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.
649                        </para>
650                </description>
651
652        </bitlbee-setting>
653
654        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
655                <default>false</default>
656
657                <description>
658                        <para>
659                                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.
660                        </para>
661                </description>
662
663        </bitlbee-setting>
664
665        <bitlbee-setting name="message_length" type="integer" scope="account">
666                <default>140</default>
667
668                <description>
669                        <para>
670                                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.
671                        </para>
672
673                        <para>
674                                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.
675                        </para>
676                </description>
677
678        </bitlbee-setting>
679
680        <bitlbee-setting name="mode" type="string" scope="account">
681                <possible-values>one, many, chat</possible-values>
682                <default>one</default>
683
684                <description>
685                        <para>
686                                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.
687                        </para>
688                       
689                        <para>
690                                If you prefer to have all your Twitter things in a separate channel, you can set this setting to "chat".
691                        </para>
692                       
693                        <para>
694                                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.
695                        </para>
696                </description>
697
698        </bitlbee-setting>
699
700        <bitlbee-setting name="nick" type="string" scope="chat">
701
702                <description>
703                        <para>
704                                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.
705                        </para>
706                </description>
707        </bitlbee-setting>
708
709        <bitlbee-setting name="nick_source" type="string" scope="account">
710                <default>handle</default>
711                <possible-values>handle, full_name, first_name</possible-values>
712
713                <description>
714                        <para>
715                                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.
716                        </para>
717
718                        <para>
719                                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.
720                        </para>
721                </description>
722        </bitlbee-setting>
723
724        <bitlbee-setting name="oauth" type="boolean" scope="account">
725                <default>true</default>
726
727                <description>
728                        <para>
729                                This enables OAuth authentication for Twitter accounts. From June 2010 this will be mandatory.
730                        </para>
731
732                        <para>
733                                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.
734                        </para>
735
736                        <para>
737                                The resulting access token will be saved permanently, so you have to do this only once.
738                        </para>
739                </description>
740
741        </bitlbee-setting>
742
743        <bitlbee-setting name="ops" type="string" scope="global">
744                <default>both</default>
745                <possible-values>both, root, user, none</possible-values>
746
747                <description>
748                        <para>
749                                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.
750                        </para>
751
752                        <para>
753                                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.
754                        </para>
755                </description>
756        </bitlbee-setting>
757
758        <bitlbee-setting name="password" type="string" scope="both">
759                <description>
760                        <para>
761                                Use this global setting to change your "NickServ" password.
762                        </para>
763                       
764                        <para>
765                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
766                        </para>
767                       
768                        <para>
769                                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.
770                        </para>
771                </description>
772        </bitlbee-setting>
773       
774        <bitlbee-setting name="port" type="integer" scope="account">
775                <description>
776                        <para>
777                                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.
778                        </para>
779                </description>
780        </bitlbee-setting>
781
782        <bitlbee-setting name="priority" type="integer" scope="account">
783                <default>0</default>
784
785                <description>
786                        <para>
787                                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).
788                        </para>
789
790                        <para>
791                                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).
792                        </para>
793                </description>
794        </bitlbee-setting>
795
796        <bitlbee-setting name="private" type="boolean" scope="global">
797                <default>true</default>
798
799                <description>
800                        <para>
801                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
802                        </para>
803
804                        <para>
805                                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.
806                        </para>
807                </description>
808        </bitlbee-setting>
809
810        <bitlbee-setting name="query_order" type="string" scope="global">
811                <default>lifo</default>
812                <possible-values>lifo, fifo</possible-values>
813
814                <description>
815                        <para>
816                                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.
817                        </para>
818
819                        <para>
820                                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).
821                        </para>
822                </description>
823        </bitlbee-setting>
824
825        <bitlbee-setting name="resource" type="string" scope="account">
826                <default>BitlBee</default>
827
828                <description>
829                        <para>
830                                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.
831                        </para>
832                </description>
833        </bitlbee-setting>
834
835        <bitlbee-setting name="resource_select" type="string" scope="account">
836                <default>activity</default>
837                <possible-values>priority, activity</possible-values>
838
839                <description>
840                        <para>
841                                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.
842                        </para>
843
844                        <para>
845                                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).
846                        </para>
847                </description>
848        </bitlbee-setting>
849
850        <bitlbee-setting name="root_nick" type="string" scope="global">
851                <default>root</default>
852
853                <description>
854                        <para>
855                                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.
856                        </para>
857                </description>
858        </bitlbee-setting>
859
860        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
861                <default>true</default>
862
863                <description>
864                        <para>
865                                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.
866                        </para>
867                </description>
868        </bitlbee-setting>
869
870        <bitlbee-setting name="server" type="string" scope="account">
871                <description>
872                        <para>
873                                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.
874                        </para>
875                </description>
876        </bitlbee-setting>
877
878        <bitlbee-setting name="show_offline" type="boolean" scope="global">
879                <default>false</default>
880
881                <description>
882                        <para>
883                                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.
884                        </para>
885                </description>
886        </bitlbee-setting>
887
888        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
889                <default>true</default>
890
891                <description>
892                        <para>
893                                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.
894                        </para>
895                </description>
896        </bitlbee-setting>
897
898        <bitlbee-setting name="ssl" type="boolean" scope="account">
899                <default>false</default>
900
901                <description>
902                        <para>
903                                Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
904                        </para>
905                </description>
906        </bitlbee-setting>
907
908        <bitlbee-setting name="status" type="string" scope="both">
909                <description>
910                        <para>
911                                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.
912                        </para>
913
914                        <para>
915                                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).
916                        </para>
917
918                        <para>
919                                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>.
920                        </para>
921                </description>
922        </bitlbee-setting>
923
924        <bitlbee-setting name="strip_html" type="boolean" scope="global">
925                <default>true</default>
926
927                <description>
928                        <para>
929                                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.
930                        </para>
931                        <para>
932                                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.
933                        </para>
934                </description>
935        </bitlbee-setting>
936
937        <bitlbee-setting name="switchboard_keepalives" type="boolean" scope="account">
938                <default>false</default>
939
940                <description>
941                        <para>
942                                Turn on this flag if you have difficulties talking to offline/invisible contacts.
943                        </para>
944                       
945                        <para>
946                                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.
947                        </para>
948                       
949                        <para>
950                                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.
951                        </para>
952                </description>
953        </bitlbee-setting>
954
955        <bitlbee-setting name="timezone" type="string" scope="global">
956                <default>local</default>
957                <possible-values>local, utc, gmt, timezone-spec</possible-values>
958
959                <description>
960                        <para>
961                                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.
962                        </para>
963
964                        <para>
965                                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.
966                        </para>
967                </description>
968        </bitlbee-setting>
969
970        <bitlbee-setting name="tls" type="boolean" scope="account">
971                <default>try</default>
972
973                <description>
974                        <para>
975                                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.
976                        </para>
977
978                        <para>
979                                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.
980                        </para>
981                </description>
982        </bitlbee-setting>
983
984        <bitlbee-setting name="to_char" type="string" scope="global">
985                <default>": "</default>
986
987                <description>
988                        <para>
989                                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>.
990                        </para>
991
992                        <para>
993                                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.
994                        </para>
995                </description>
996        </bitlbee-setting>
997
998        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
999                <default>false</default>
1000
1001                <description>
1002                        <para>
1003                                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.
1004                        </para>
1005                </description>
1006        </bitlbee-setting>
1007
1008        <bitlbee-setting name="web_aware" type="string" scope="account">
1009                <default>false</default>
1010
1011                <description>
1012                        <para>
1013                                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.
1014                        </para>
1015
1016                        <para>
1017                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
1018                        </para>
1019                </description>
1020        </bitlbee-setting>
1021
1022        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
1023                <default>false</default>
1024
1025                <description>
1026                        <para>
1027                                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.
1028                        </para>
1029                        <para>
1030                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
1031                        </para>
1032                </description>
1033        </bitlbee-setting>
1034
1035        <bitlbee-command name="rename">
1036                <short-description>Rename (renick) a buddy</short-description>
1037                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
1038
1039                <description>
1040                        <para>
1041                                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).
1042                        </para>
1043                </description>
1044
1045                <ircexample>
1046                        <ircline nick="itsme">rename itsme_ you</ircline>
1047                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
1048                </ircexample>
1049
1050        </bitlbee-command>
1051
1052        <bitlbee-command name="yes">
1053                <short-description>Accept a request</short-description>
1054                <syntax>yes [&lt;number&gt;]</syntax>
1055
1056                <description>
1057                        <para>
1058                                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.
1059                        </para>
1060
1061                        <para>
1062                                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.
1063                        </para>
1064                </description>
1065
1066        </bitlbee-command>
1067
1068        <bitlbee-command name="no">
1069                <short-description>Deny a request</short-description>
1070                <syntax>no [&lt;number&gt;]</syntax>
1071
1072                <description>
1073                        <para>
1074                                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.
1075                        </para>
1076
1077                        <para>
1078                                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.
1079                        </para>
1080                </description>
1081        </bitlbee-command>
1082
1083        <bitlbee-command name="qlist">
1084                <short-description>List all the unanswered questions root asked</short-description>
1085                <syntax>qlist</syntax>
1086
1087                <description>
1088                        <para>
1089                                This gives you a list of all the unanswered questions from root.
1090                        </para>
1091                </description>
1092
1093        </bitlbee-command>
1094
1095        <bitlbee-command name="register">
1096                <short-description>Register yourself</short-description>
1097                <syntax>register &lt;password&gt;</syntax>
1098
1099                <description>
1100                        <para>
1101                                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.
1102                        </para>
1103
1104                        <para>
1105                                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.. ;-)
1106                        </para>
1107
1108                        <para>
1109                                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.
1110                        </para>
1111                </description>
1112
1113        </bitlbee-command>
1114
1115        <bitlbee-command name="identify">
1116                <syntax>identify &lt;password&gt;</syntax>
1117                <short-description>Identify yourself with your password</short-description>
1118
1119                <description>
1120                        <para>
1121                                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.
1122                        </para>
1123
1124                        <para>
1125                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
1126                        </para>
1127                </description>
1128        </bitlbee-command>
1129
1130        <bitlbee-command name="drop">
1131                <syntax>drop &lt;password&gt;</syntax>
1132                <short-description>Drop your account</short-description>
1133
1134                <description>
1135                        <para>
1136                                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.
1137                        </para>
1138                </description>
1139        </bitlbee-command>
1140
1141        <bitlbee-command name="blist">
1142                <syntax>blist [all|online|offline|away]</syntax>
1143                <short-description>List all the buddies in your contact list</short-description>
1144
1145                <description>
1146                        <para>
1147                                You can get a better readable buddy list using the <emphasis>blist</emphasis> command. If you want a complete list (including the offline users) you can use the <emphasis>all</emphasis> argument.
1148                        </para>
1149                </description>
1150
1151        </bitlbee-command>
1152
1153        <bitlbee-command name="nick">
1154                <short-description>Change friendly name, nick</short-description>
1155                <syntax>nick &lt;connection&gt; [&lt;new nick&gt;]</syntax>
1156                <syntax>nick &lt;connection&gt;</syntax>
1157
1158                <description>
1159                        <para>
1160                                Deprecated: Use the per-account <emphasis>display_name</emphasis> setting to read and change this information.
1161                        </para>
1162                </description>
1163
1164                <ircexample>
1165                        <ircline nick="wouter">account set 1/display_name "The majestik møøse"</ircline>
1166                        <ircline nick="root">display_name = `The majestik møøse'</ircline>
1167                </ircexample>
1168
1169        </bitlbee-command>
1170       
1171        <bitlbee-command name="transfers">
1172                <short-description>Monitor, cancel, or reject file transfers</short-description>
1173                <syntax>transfers [&lt;cancel&gt; id | &lt;reject&gt;]</syntax>
1174               
1175                <description>
1176                        <para>
1177                                Without parameters the currently pending file transfers and their status will be listed. Available actions are <emphasis>cancel</emphasis> and <emphasis>reject</emphasis>. See <emphasis>help transfers &lt;action&gt;</emphasis> for more information.
1178                        </para>
1179
1180                        <ircexample>
1181                                <ircline nick="ulim">transfers</ircline>
1182                        </ircexample>
1183                </description>
1184               
1185                <bitlbee-command name="cancel">
1186                        <short-description>Cancels the file transfer with the given id</short-description>
1187                        <syntax>transfers &lt;cancel&gt; id</syntax>
1188
1189                        <description>
1190                                <para>Cancels the file transfer with the given id</para>
1191                        </description>
1192
1193                        <ircexample>
1194                                <ircline nick="ulim">transfers cancel 1</ircline>
1195                                <ircline nick="root">Canceling file transfer for test</ircline>
1196                        </ircexample>
1197                </bitlbee-command>
1198
1199                <bitlbee-command name="reject">
1200                        <short-description>Rejects all incoming transfers</short-description>
1201                        <syntax>transfers &lt;reject&gt;</syntax>
1202
1203                        <description>
1204                                <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>
1205                        </description>
1206
1207                        <ircexample>
1208                                <ircline nick="ulim">transfers reject</ircline>
1209                        </ircexample>
1210                </bitlbee-command>
1211        </bitlbee-command>
1212       
1213</chapter>
Note: See TracBrowser for help on using the repository browser.