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

Last change on this file since cca0692 was 7a90d02, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-04-08T22:16:38Z

Document the Twitter module. And fix the default for auto_reconnect while
I'm at it.
  • Property mode set to 100644
File size: 42.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;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) and Yahoo. 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 show up in your contact list and their tweets will show up as private messages or in &amp;bitlbee depending on your settings. If you want them in a separate channel, use the use_groupchat setting (see <emphasis>help set use_groupchat</emphasis>).
76                                        </para>
77                                       
78                                        <para>
79                                                To send tweets yourself, send them to any of your Twitter contacts via /query (doesn't matter who), or just write in the groupchat channel if you enabled that option.
80                                        </para>
81                                </description>
82                        </bitlbee-command>
83
84                        <bitlbee-command name="yahoo">
85                                <syntax>account add yahoo &lt;handle&gt; &lt;password&gt;</syntax>
86
87                                <description>
88                                        <para>
89                                                For Yahoo! connections there are no special arguments.
90                                        </para>
91                                </description>
92                        </bitlbee-command>
93
94                </bitlbee-command>
95
96                <bitlbee-command name="del">
97                        <syntax>account del &lt;account id&gt;</syntax>
98
99                        <description>
100                                <para>
101                                        This commands deletes an account from your account list. You should signoff the account before deleting it.
102                                </para>
103
104
105                                <para>
106                                        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.
107                                </para>
108                        </description>
109                </bitlbee-command>
110
111                <bitlbee-command name="on">
112                        <syntax>account on [&lt;account id&gt;]</syntax>
113
114                        <description>
115                                <para>
116                                        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.
117                                </para>
118
119                                <para>
120                                        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.
121                                </para>
122                        </description>
123
124                </bitlbee-command>
125
126                <bitlbee-command name="off">
127                        <syntax>account off [&lt;account id&gt;]</syntax>
128
129                        <description>
130                                <para>
131                                        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.
132                                </para>
133
134                                <para>
135                                        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.
136                                </para>
137                        </description>
138                </bitlbee-command>
139
140                <bitlbee-command name="list">
141                        <syntax>account list</syntax>
142
143                        <description>
144                                <para>
145                                        This command gives you a list of all the accounts known by BitlBee.
146                                </para>
147                        </description>
148                </bitlbee-command>
149
150                <bitlbee-command name="set">
151                        <syntax>account set &lt;account id&gt;</syntax>
152                        <syntax>account set &lt;account id&gt;/&lt;setting&gt;</syntax>
153                        <syntax>account set &lt;account id&gt;/&lt;setting&gt; &lt;value&gt;</syntax>
154                        <syntax>account set -del &lt;account id&gt;/&lt;setting&gt;</syntax>
155
156                        <description>
157                                <para>
158                                        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>.
159                                </para>
160                               
161                                <para>
162                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
163                                </para>
164                               
165                                <para>
166                                        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.
167                                </para>
168                        </description>
169                </bitlbee-command>
170        </bitlbee-command>
171
172        <bitlbee-command name="chat">
173                <short-description>Chatroom list maintenance</short-description>
174                <syntax>chat &lt;action&gt; [&lt;arguments&gt;]</syntax>
175
176                <description>
177
178                        <para>
179                                Available actions: add, del, list, with and set. See <emphasis>help chat &lt;action&gt;</emphasis> for more information.
180                        </para>
181
182                </description>
183
184                <bitlbee-command name="add">
185                        <syntax>chat add &lt;account&gt; &lt;room&gt; [&lt;channel&gt;]</syntax>
186
187                        <description>
188                                <para>
189                                        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.
190                                </para>
191
192                                <para>
193                                        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>)
194                                </para>
195
196                                <para>
197                                        Password-protected rooms work exactly like on IRC, by passing the password as an extra argument to /join.
198                                </para>
199                        </description>
200
201                </bitlbee-command>
202
203                <bitlbee-command name="del">
204                        <syntax>chat del &lt;chat id&gt;</syntax>
205
206                        <description>
207                                <para>
208                                        This commands deletes an chatroom from your list.
209                                </para>
210
211                                <para>
212                                        The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.
213                                </para>
214                        </description>
215                </bitlbee-command>
216
217                <bitlbee-command name="list">
218                        <syntax>chat list</syntax>
219
220                        <description>
221                                <para>
222                                        This command gives you a list of all the chatrooms known by BitlBee.
223                                </para>
224                        </description>
225                </bitlbee-command>
226
227                <bitlbee-command name="with">
228                        <syntax>chat with &lt;nickname&gt;</syntax>
229
230                        <description>
231                                <para>
232                                        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.
233                                </para>
234                        </description>
235                </bitlbee-command>
236
237                <bitlbee-command name="set">
238                        <syntax>chat set &lt;chat id&gt;</syntax>
239                        <syntax>chat set &lt;chat id&gt;/&lt;setting&gt;</syntax>
240                        <syntax>chat set &lt;chat id&gt;/&lt;setting&gt; &lt;value&gt;</syntax>
241                        <syntax>chat set -del &lt;chat id&gt;/&lt;setting&gt;</syntax>
242
243                        <description>
244                                <para>
245                                        This command can be used to change various settings for chatrooms.
246                                </para>
247                               
248                                <para>
249                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
250                                </para>
251                               
252                                <para>
253                                        The room ID can be a number (see <emphasis>chat list</emphasis>), or (part of) the name of the room/channel.
254                                </para>
255                        </description>
256                </bitlbee-command>
257        </bitlbee-command>
258
259        <bitlbee-command name="add">
260                <short-description>Add a buddy to your contact list</short-description>
261                <syntax>add &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
262                <syntax>add -tmp &lt;connection&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
263
264                <description>
265                        <para>
266                                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.
267                        </para>
268
269                        <para>
270                                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.
271                        </para>
272                </description>
273
274                <ircexample>
275                        <ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
276                        <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
277                </ircexample>
278        </bitlbee-command>
279
280        <bitlbee-command name="info">
281                <short-description>Request user information</short-description>
282                <syntax>info &lt;connection&gt; &lt;handle&gt;</syntax>
283                <syntax>info &lt;nick&gt;</syntax>
284
285                <description>
286                        <para>
287                                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.
288                        </para>
289                </description>
290
291                <ircexample>
292                        <ircline nick="ctrlsoft">info 0 72696705</ircline>
293                        <ircline nick="root">User info - UIN: 72696705   Nick: Lintux   First/Last name: Wilmer van der Gaast   E-mail: lintux@lintux.cx</ircline>
294                </ircexample>
295
296        </bitlbee-command>
297
298        <bitlbee-command name="remove">
299                <short-description>Remove a buddy from your contact list</short-description>
300                <syntax>remove &lt;nick&gt;</syntax>
301
302                <description>
303                        <para>
304                                Removes the specified nick from your buddy list.
305                        </para>
306                </description>
307
308                <ircexample>
309                        <ircline nick="ctrlsoft">remove gryp</ircline>
310                        <ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction>
311                </ircexample>
312
313        </bitlbee-command>
314
315        <bitlbee-command name="block">
316                <short-description>Block someone</short-description>
317                <syntax>block &lt;nick&gt;</syntax>
318                <syntax>block &lt;connection&gt; &lt;handle&gt;</syntax>
319                <syntax>block &lt;connection&gt;</syntax>
320
321                <description>
322                        <para>
323                                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.
324                        </para>
325                       
326                        <para>
327                                When called with only a connection specification as an argument, the command displays the current block list for that connection.
328                        </para>
329                </description>
330        </bitlbee-command>
331
332        <bitlbee-command name="allow">
333                <short-description>Unblock someone</short-description>
334                <syntax>allow &lt;nick&gt;</syntax>
335                <syntax>allow &lt;connection&gt; &lt;handle&gt;</syntax>
336
337                <description>
338                        <para>
339                                Reverse of block. Unignores the specified user or user handle on specified connection.
340                        </para>
341                       
342                        <para>
343                                When called with only a connection specification as an argument, the command displays the current allow list for that connection.
344                        </para>
345                </description>
346        </bitlbee-command>
347
348        <bitlbee-command name="set">
349                <short-description>Miscellaneous settings</short-description>
350                <syntax>set</syntax>
351                <syntax>set &lt;variable&gt;</syntax>
352                <syntax>set &lt;variable&gt; &lt;value&gt;</syntax>
353                <syntax>set -del &lt;variable&gt;</syntax>
354
355                <description>
356
357                        <para>
358                                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.
359                        </para>
360
361                        <para>
362                                To get more help information about a setting, try:
363                        </para>
364
365                </description>
366
367                <ircexample>
368                        <ircline nick="ctrlsoft">help set private</ircline>
369                </ircexample>
370
371        </bitlbee-command>
372
373        <bitlbee-command name="help">
374                <short-description>BitlBee help system</short-description>
375
376                <syntax>help [subject]</syntax>
377
378                <description>
379                        <para>
380                                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.
381                        </para>
382                </description>
383        </bitlbee-command>
384
385        <bitlbee-command name="save">
386                <short-description>Save your account data</short-description>
387                <syntax>save</syntax>
388
389                <description>
390                        <para>
391                                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... ;-)
392                        </para>
393                </description>
394        </bitlbee-command>
395
396        <bitlbee-setting name="auto_connect" type="boolean" scope="both">
397                <default>true</default>
398
399                <description>
400                        <para>
401                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
402                        </para>
403                       
404                        <para>
405                                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!)
406                        </para>
407                </description>
408        </bitlbee-setting>
409
410        <bitlbee-setting name="auto_join" type="boolean" scope="chat">
411                <default>false</default>
412
413                <description>
414                        <para>
415                                With this option enabled, BitlBee will automatically join this chatroom when you log in.
416                        </para>
417                </description>
418        </bitlbee-setting>
419
420        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
421                <default>true</default>
422
423                <description>
424                        <para>
425                                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.
426                        </para>
427
428                        <para>
429                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
430                        </para>
431
432                        <para>
433                                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!)
434                        </para>
435                </description>
436        </bitlbee-setting>
437
438        <bitlbee-setting name="auto_reconnect_delay" type="string" scope="global">
439                <default>5*3&lt;900</default>
440
441                <description>
442                        <para>
443                                Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up.
444                        </para>
445
446                        <para>
447                                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.
448                        </para>
449
450                        <para>
451                                See also the <emphasis>auto_reconnect</emphasis> setting.
452                        </para>
453                </description>
454        </bitlbee-setting>
455
456        <bitlbee-setting name="away" type="string" scope="both">
457                <description>
458                        <para>
459                                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.
460                        </para>
461
462                        <para>
463                                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.
464                        </para>
465
466                        <para>
467                                Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>.
468                        </para>
469                </description>
470        </bitlbee-setting>
471
472        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
473                <default>true</default>
474
475                <description>
476                        <para>
477                                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.
478                        </para>
479                </description>
480        </bitlbee-setting>
481
482        <bitlbee-setting name="buddy_sendbuffer" type="boolean" scope="global">
483                <default>false</default>
484
485                <description>
486                        <para>
487                                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.
488                        </para>
489
490                        <para>
491                                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.
492                        </para>
493
494                        <para>
495                                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.
496                        </para>
497                </description>
498        </bitlbee-setting>
499
500        <bitlbee-setting name="buddy_sendbuffer_delay" type="integer" scope="global">
501                <default>200</default>
502
503                <description>
504
505                        <para>
506                                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.
507                        </para>
508
509                        <para>
510                                See also the <emphasis>buddy_sendbuffer</emphasis> setting.
511                        </para>
512                </description>
513        </bitlbee-setting>
514
515        <bitlbee-setting name="charset" type="string" scope="global">
516                <default>utf-8</default>
517                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
518
519                <description>
520                        <para>
521                                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.
522                        </para>
523
524                        <para>
525                                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
526                        </para>
527                </description>
528
529        </bitlbee-setting>
530
531        <bitlbee-setting name="control_channel" type="string" scope="global">
532                <default>&amp;bitlbee</default>
533
534                <description>
535                        <para>
536                                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.
537                        </para>
538                </description>
539        </bitlbee-setting>
540
541        <bitlbee-setting name="debug" type="boolean" scope="global">
542                <default>false</default>
543
544                <description>
545                        <para>
546                                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.
547                        </para>
548                </description>
549        </bitlbee-setting>
550
551        <bitlbee-setting name="default_target" type="string" scope="global">
552                <default>root</default>
553                <possible-values>root, last</possible-values>
554
555                <description>
556                        <para>
557                                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>.
558                        </para>
559                </description>
560        </bitlbee-setting>
561
562        <bitlbee-setting name="display_name" type="string" scope="account">
563                <description>
564                        <para>
565                                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.
566                        </para>
567                </description>
568        </bitlbee-setting>
569
570        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
571                <default>false</default>
572
573                <description>
574                        <para>
575                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
576                        </para>
577                </description>
578        </bitlbee-setting>
579
580        <bitlbee-setting name="display_timestamps" type="boolean" scope="global">
581                <default>true</default>
582
583                <description>
584                        <para>
585                                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.
586                        </para>
587                </description>
588        </bitlbee-setting>
589
590        <bitlbee-setting name="handle_unknown" type="string" scope="global">
591                <default>root</default>
592                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
593
594                <description>
595                        <para>
596                                Messages from unknown users are echoed like this by default:
597                        </para>
598
599                        <ircexample>
600                                <ircline nick="root">Unknown message from handle 3137137:</ircline>
601                                <ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
602                        </ircexample>
603
604                        <para>
605                                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.
606                        </para>
607
608                        <note>
609                                <para>
610                                        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.
611                                </para>
612                        </note>
613                </description>
614
615        </bitlbee-setting>
616
617        <bitlbee-setting name="ignore_auth_requests" type="boolean" scope="account">
618                <default>true</default>
619
620                <description>
621                        <para>
622                                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.
623                        </para>
624                </description>
625
626        </bitlbee-setting>
627
628        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
629                <default>true</default>
630
631                <description>
632                        <para>
633                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
634                        </para>
635                </description>
636
637        </bitlbee-setting>
638
639        <bitlbee-setting name="local_display_name" type="boolean" scope="account">
640                <default>false</default>
641
642                <description>
643                        <para>
644                                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.
645                        </para>
646                </description>
647
648        </bitlbee-setting>
649
650        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
651                <default>false</default>
652
653                <description>
654                        <para>
655                                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.
656                        </para>
657                </description>
658
659        </bitlbee-setting>
660
661        <bitlbee-setting name="nick" type="string" scope="chat">
662
663                <description>
664                        <para>
665                                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.
666                        </para>
667                </description>
668        </bitlbee-setting>
669
670        <bitlbee-setting name="nick_source" type="string" scope="account">
671                <default>handle</default>
672                <possible-values>handle, full_name, first_name</possible-values>
673
674                <description>
675                        <para>
676                                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.
677                        </para>
678
679                        <para>
680                                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.
681                        </para>
682                </description>
683        </bitlbee-setting>
684
685        <bitlbee-setting name="ops" type="string" scope="global">
686                <default>both</default>
687                <possible-values>both, root, user, none</possible-values>
688
689                <description>
690                        <para>
691                                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.
692                        </para>
693
694                        <para>
695                                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.
696                        </para>
697                </description>
698        </bitlbee-setting>
699
700        <bitlbee-setting name="password" type="string" scope="both">
701                <description>
702                        <para>
703                                Use this global setting to change your "NickServ" password.
704                        </para>
705                       
706                        <para>
707                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
708                        </para>
709                       
710                        <para>
711                                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.
712                        </para>
713                </description>
714        </bitlbee-setting>
715       
716        <bitlbee-setting name="port" type="integer" scope="account">
717                <description>
718                        <para>
719                                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.
720                        </para>
721                </description>
722        </bitlbee-setting>
723
724        <bitlbee-setting name="priority" type="integer" scope="account">
725                <default>0</default>
726
727                <description>
728                        <para>
729                                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).
730                        </para>
731
732                        <para>
733                                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).
734                        </para>
735                </description>
736        </bitlbee-setting>
737
738        <bitlbee-setting name="private" type="boolean" scope="global">
739                <default>true</default>
740
741                <description>
742                        <para>
743                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
744                        </para>
745
746                        <para>
747                                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.
748                        </para>
749                </description>
750        </bitlbee-setting>
751
752        <bitlbee-setting name="query_order" type="string" scope="global">
753                <default>lifo</default>
754                <possible-values>lifo, fifo</possible-values>
755
756                <description>
757                        <para>
758                                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.
759                        </para>
760
761                        <para>
762                                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).
763                        </para>
764                </description>
765        </bitlbee-setting>
766
767        <bitlbee-setting name="resource" type="string" scope="account">
768                <default>BitlBee</default>
769
770                <description>
771                        <para>
772                                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.
773                        </para>
774                </description>
775        </bitlbee-setting>
776
777        <bitlbee-setting name="resource_select" type="string" scope="account">
778                <default>activity</default>
779                <possible-values>priority, activity</possible-values>
780
781                <description>
782                        <para>
783                                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.
784                        </para>
785
786                        <para>
787                                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).
788                        </para>
789                </description>
790        </bitlbee-setting>
791
792        <bitlbee-setting name="root_nick" type="string" scope="global">
793                <default>root</default>
794
795                <description>
796                        <para>
797                                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.
798                        </para>
799                </description>
800        </bitlbee-setting>
801
802        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
803                <default>true</default>
804
805                <description>
806                        <para>
807                                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.
808                        </para>
809                </description>
810        </bitlbee-setting>
811
812        <bitlbee-setting name="server" type="string" scope="account">
813                <description>
814                        <para>
815                                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.
816                        </para>
817                </description>
818        </bitlbee-setting>
819
820        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
821                <default>true</default>
822
823                <description>
824                        <para>
825                                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.
826                        </para>
827                </description>
828        </bitlbee-setting>
829
830        <bitlbee-setting name="ssl" type="boolean" scope="account">
831                <default>false</default>
832
833                <description>
834                        <para>
835                                Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
836                        </para>
837                </description>
838        </bitlbee-setting>
839
840        <bitlbee-setting name="status" type="string" scope="both">
841                <description>
842                        <para>
843                                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.
844                        </para>
845
846                        <para>
847                                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).
848                        </para>
849
850                        <para>
851                                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>.
852                        </para>
853                </description>
854        </bitlbee-setting>
855
856        <bitlbee-setting name="strip_html" type="boolean" scope="global">
857                <default>true</default>
858
859                <description>
860                        <para>
861                                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.
862                        </para>
863                        <para>
864                                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.
865                        </para>
866                </description>
867        </bitlbee-setting>
868
869        <bitlbee-setting name="timezone" type="string" scope="global">
870                <default>local</default>
871                <possible-values>local, utc, gmt, timezone-spec</possible-values>
872
873                <description>
874                        <para>
875                                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.
876                        </para>
877
878                        <para>
879                                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.
880                        </para>
881                </description>
882        </bitlbee-setting>
883
884        <bitlbee-setting name="tls" type="boolean" scope="account">
885                <default>try</default>
886
887                <description>
888                        <para>
889                                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.
890                        </para>
891
892                        <para>
893                                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.
894                        </para>
895                </description>
896        </bitlbee-setting>
897
898        <bitlbee-setting name="to_char" type="string" scope="global">
899                <default>": "</default>
900
901                <description>
902                        <para>
903                                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>.
904                        </para>
905
906                        <para>
907                                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.
908                        </para>
909                </description>
910        </bitlbee-setting>
911
912        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
913                <default>false</default>
914
915                <description>
916                        <para>
917                                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.
918                        </para>
919                </description>
920        </bitlbee-setting>
921
922        <bitlbee-setting name="use_groupchat" type="boolean" scope="account">
923                <default>false</default>
924
925                <description>
926                        <para>
927                                By default the Twitter module shows all Twitter contacts and their Tweet in &amp;bitlbee and/or private messages. With this setting enabled the module will show all contacts and their Tweets in a separate channel.
928                        </para>
929                </description>
930        </bitlbee-setting>
931
932        <bitlbee-setting name="web_aware" type="string" scope="account">
933                <default>false</default>
934
935                <description>
936                        <para>
937                                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.
938                        </para>
939
940                        <para>
941                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
942                        </para>
943                </description>
944        </bitlbee-setting>
945
946        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
947                <default>false</default>
948
949                <description>
950                        <para>
951                                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.
952                        </para>
953                        <para>
954                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
955                        </para>
956                </description>
957        </bitlbee-setting>
958
959        <bitlbee-command name="rename">
960                <short-description>Rename (renick) a buddy</short-description>
961                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
962
963                <description>
964                        <para>
965                                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).
966                        </para>
967                </description>
968
969                <ircexample>
970                        <ircline nick="itsme">rename itsme_ you</ircline>
971                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
972                </ircexample>
973
974        </bitlbee-command>
975
976        <bitlbee-command name="yes">
977                <short-description>Accept a request</short-description>
978                <syntax>yes [&lt;number&gt;]</syntax>
979
980                <description>
981                        <para>
982                                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.
983                        </para>
984
985                        <para>
986                                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.
987                        </para>
988                </description>
989
990        </bitlbee-command>
991
992        <bitlbee-command name="no">
993                <short-description>Deny a request</short-description>
994                <syntax>no [&lt;number&gt;]</syntax>
995
996                <description>
997                        <para>
998                                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.
999                        </para>
1000
1001                        <para>
1002                                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.
1003                        </para>
1004                </description>
1005        </bitlbee-command>
1006
1007        <bitlbee-command name="qlist">
1008                <short-description>List all the unanswered questions root asked</short-description>
1009                <syntax>qlist</syntax>
1010
1011                <description>
1012                        <para>
1013                                This gives you a list of all the unanswered questions from root.
1014                        </para>
1015                </description>
1016
1017        </bitlbee-command>
1018
1019        <bitlbee-command name="register">
1020                <short-description>Register yourself</short-description>
1021                <syntax>register &lt;password&gt;</syntax>
1022
1023                <description>
1024                        <para>
1025                                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.
1026                        </para>
1027
1028                        <para>
1029                                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.. ;-)
1030                        </para>
1031
1032                        <para>
1033                                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.
1034                        </para>
1035                </description>
1036
1037        </bitlbee-command>
1038
1039        <bitlbee-command name="identify">
1040                <syntax>identify &lt;password&gt;</syntax>
1041                <short-description>Identify yourself with your password</short-description>
1042
1043                <description>
1044                        <para>
1045                                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.
1046                        </para>
1047
1048                        <para>
1049                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
1050                        </para>
1051                </description>
1052        </bitlbee-command>
1053
1054        <bitlbee-command name="drop">
1055                <syntax>drop &lt;password&gt;</syntax>
1056                <short-description>Drop your account</short-description>
1057
1058                <description>
1059                        <para>
1060                                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.
1061                        </para>
1062                </description>
1063        </bitlbee-command>
1064
1065        <bitlbee-command name="blist">
1066                <syntax>blist [all|online|offline|away]</syntax>
1067                <short-description>List all the buddies in your contact list</short-description>
1068
1069                <description>
1070                        <para>
1071                                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.
1072                        </para>
1073                </description>
1074
1075        </bitlbee-command>
1076
1077        <bitlbee-command name="nick">
1078                <short-description>Change friendly name, nick</short-description>
1079                <syntax>nick &lt;connection&gt; [&lt;new nick&gt;]</syntax>
1080                <syntax>nick &lt;connection&gt;</syntax>
1081
1082                <description>
1083                        <para>
1084                                Deprecated: Use the per-account <emphasis>display_name</emphasis> setting to read and change this information.
1085                        </para>
1086                </description>
1087
1088                <ircexample>
1089                        <ircline nick="wouter">account set 1/display_name "The majestik møøse"</ircline>
1090                        <ircline nick="root">display_name = `The majestik møøse'</ircline>
1091                </ircexample>
1092
1093        </bitlbee-command>
1094</chapter>
Note: See TracBrowser for help on using the repository browser.