source: doc/user-guide/commands.xml @ 7e2b593

Last change on this file since 7e2b593 was 286b28e, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-03-13T01:02:47Z

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