source: doc/user-guide/commands.xml @ 3f81999

Last change on this file since 3f81999 was 3f81999, checked in by Sven Moritz Hallberg <pesco@…>, at 2010-06-03T10:31:46Z

merge in bitlbee 1.2.4
  • Property mode set to 100644
File size: 43.4 KB
Line 
1<chapter id="commands">
2        <title>Bitlbee commands</title>
3
4        <command-list/>
5
6        <bitlbee-command name="account">
7                <short-description>IM-account list maintenance</short-description>
8                <syntax>account &lt;action&gt; [&lt;arguments&gt;]</syntax>
9
10                <description>
11
12                        <para>
13                                Available actions: add, del, list, on, off and set. See <emphasis>help account &lt;action&gt;</emphasis> for more information.
14                        </para>
15
16                </description>
17
18                <bitlbee-command name="add">
19                        <syntax>account add &lt;protocol&gt; &lt;username&gt; &lt;password&gt;</syntax>
20
21                        <description>
22                                <para>
23                                        Adds an account on the given server with the specified protocol, username and password to the account list. Supported protocols right now are: Jabber, MSN, OSCAR (AIM/ICQ) 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="otr">
331                <short-description>Off-the-Record encryption control</short-description>
332                <syntax>otr &lt;subcommand&gt; [&lt;arguments&gt;]</syntax>
333
334                <description>
335
336                        <para>
337                                Available subcommands: connect, disconnect, smp, trust, info, keygen, and forget. See <emphasis>help otr &lt;subcommand&gt;</emphasis> for more information.
338                        </para>
339
340                </description>
341               
342                <bitlbee-command name="connect">
343                        <syntax>otr connect &lt;nick&gt;</syntax>
344                       
345                        <description>
346                       
347                                <para>
348                                        Attempts to establish an encrypted connection with the specified user by sending a magic string.
349                                </para>
350                               
351                        </description>
352               
353                </bitlbee-command>
354               
355                <bitlbee-command name="disconnect">
356                        <syntax>otr disconnect &lt;nick&gt;</syntax>
357                       
358                        <description>
359                       
360                                <para>
361                                        Resets the connection with the specified user to cleartext.
362                                </para>
363                               
364                        </description>
365               
366                </bitlbee-command>
367               
368                <bitlbee-command name="smp">
369                        <syntax>otr smp &lt;nick&gt; &lt;secret&gt;</syntax>
370                       
371                        <description>
372                       
373                                <para>
374                                        Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol.
375                                </para>
376                               
377                                <para>
378                                        If an SMP challenge has already been received from the given user, responds with the specified secret. Otherwise, a challenge for the secret will be sent. If the protocol succeeds (i.e. both parties gave the same secret), the fingerprint will be trusted.
379                                </para>
380                               
381                        </description>
382               
383                </bitlbee-command>
384               
385                <bitlbee-command name="trust">
386                        <syntax>otr trust &lt;nick&gt; &lt;fp1&gt; &lt;fp2&gt; &lt;fp3&gt; &lt;fp4&gt; &lt;fp5&gt;</syntax>
387                       
388                        <description>
389                       
390                                <para>
391                                        Manually affirms trust in the specified fingerprint, given as five blocks of precisely eight (hexadecimal) digits each.
392                                </para>
393                               
394                        </description>
395               
396                </bitlbee-command>
397               
398                <bitlbee-command name="info">
399                        <syntax>otr info</syntax>
400                        <syntax>otr info &lt;nick&gt;</syntax>
401                       
402                        <description>
403                       
404                                <para>
405                                        Shows information about the OTR state. The first form lists our private keys and current OTR contexts. The second form displays information about the connection with a given user, including the list of their known fingerprints.
406                                </para>
407                               
408                        </description>
409               
410                </bitlbee-command>
411               
412                <bitlbee-command name="keygen">
413                        <syntax>otr keygen &lt;account-no&gt;</syntax>
414                       
415                        <description>
416                       
417                                <para>
418                                        Generates a new OTR private key for the given account.
419                                </para>
420                               
421                        </description>
422               
423                </bitlbee-command>
424               
425                <bitlbee-command name="forget">
426                        <syntax>otr forget &lt;thing&gt; &lt;arguments&gt;</syntax>
427                       
428                        <description>
429                       
430                                <para>
431                                        Forgets some part of our OTR userstate. Available things: fingerprint, context, and key. See <emphasis>help otr forget &lt;thing&gt;</emphasis> for more information.
432                                </para>
433                       
434                        </description>
435                       
436                        <bitlbee-command name="fingerprint">
437                                <syntax>otr forget fingerprint &lt;nick&gt; &lt;fingerprint&gt;</syntax>
438                               
439                                <description>
440                               
441                                        <para>
442                                                Drops the specified fingerprint from the given user's OTR connection context. It is allowed to specify only a (unique) prefix of the desired fingerprint.
443                                        </para>
444                                       
445                                </description>
446                               
447                        </bitlbee-command>
448                               
449                        <bitlbee-command name="context">
450                                <syntax>otr forget context &lt;nick&gt;</syntax>
451                               
452                                <description>
453                               
454                                        <para>
455                                                Forgets the entire OTR context associated with the given user. This includes current message and protocol states, as well as any fingerprints for that user.
456                                        </para>
457                                       
458                                </description>
459                               
460                        </bitlbee-command>
461
462                        <bitlbee-command name="key">
463                                <syntax>otr forget key &lt;fingerprint&gt;</syntax>
464                               
465                                <description>
466                               
467                                        <para>
468                                                Forgets an OTR private key matching the specified fingerprint. It is allowed to specify only a (unique) prefix of the fingerprint.
469                                        </para>
470                                       
471                                </description>
472                               
473                        </bitlbee-command>
474               
475                </bitlbee-command>
476               
477        </bitlbee-command>
478
479        <bitlbee-command name="set">
480                <short-description>Miscellaneous settings</short-description>
481                <syntax>set</syntax>
482                <syntax>set &lt;variable&gt;</syntax>
483                <syntax>set &lt;variable&gt; &lt;value&gt;</syntax>
484                <syntax>set -del &lt;variable&gt;</syntax>
485
486                <description>
487
488                        <para>
489                                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.
490                        </para>
491
492                        <para>
493                                To get more help information about a setting, try:
494                        </para>
495
496                </description>
497
498                <ircexample>
499                        <ircline nick="ctrlsoft">help set private</ircline>
500                </ircexample>
501
502        </bitlbee-command>
503
504        <bitlbee-command name="help">
505                <short-description>BitlBee help system</short-description>
506
507                <syntax>help [subject]</syntax>
508
509                <description>
510                        <para>
511                                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.
512                        </para>
513                </description>
514        </bitlbee-command>
515
516        <bitlbee-command name="save">
517                <short-description>Save your account data</short-description>
518                <syntax>save</syntax>
519
520                <description>
521                        <para>
522                                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... ;-)
523                        </para>
524                </description>
525        </bitlbee-command>
526
527        <bitlbee-setting name="auto_connect" type="boolean" scope="both">
528                <default>true</default>
529
530                <description>
531                        <para>
532                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
533                        </para>
534                       
535                        <para>
536                                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!)
537                        </para>
538                </description>
539        </bitlbee-setting>
540
541        <bitlbee-setting name="auto_join" type="boolean" scope="chat">
542                <default>false</default>
543
544                <description>
545                        <para>
546                                With this option enabled, BitlBee will automatically join this chatroom when you log in.
547                        </para>
548                </description>
549        </bitlbee-setting>
550
551        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
552                <default>false</default>
553
554                <description>
555                        <para>
556                                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.
557                        </para>
558
559                        <para>
560                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
561                        </para>
562
563                        <para>
564                                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!)
565                        </para>
566                </description>
567        </bitlbee-setting>
568
569        <bitlbee-setting name="auto_reconnect_delay" type="string" scope="global">
570                <default>5*3&lt;900</default>
571
572                <description>
573                        <para>
574                                Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up.
575                        </para>
576
577                        <para>
578                                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.
579                        </para>
580
581                        <para>
582                                See also the <emphasis>auto_reconnect</emphasis> setting.
583                        </para>
584                </description>
585        </bitlbee-setting>
586
587        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
588                <default>true</default>
589
590                <description>
591                        <para>
592                                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.
593                        </para>
594                </description>
595        </bitlbee-setting>
596
597        <bitlbee-setting name="buddy_sendbuffer" type="boolean" scope="global">
598                <default>false</default>
599
600                <description>
601                        <para>
602                                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.
603                        </para>
604
605                        <para>
606                                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.
607                        </para>
608
609                        <para>
610                                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.
611                        </para>
612                </description>
613        </bitlbee-setting>
614
615        <bitlbee-setting name="buddy_sendbuffer_delay" type="integer" scope="global">
616                <default>200</default>
617
618                <description>
619
620                        <para>
621                                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.
622                        </para>
623
624                        <para>
625                                See also the <emphasis>buddy_sendbuffer</emphasis> setting.
626                        </para>
627                </description>
628        </bitlbee-setting>
629
630        <bitlbee-setting name="charset" type="string" scope="global">
631                <default>utf-8</default>
632                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
633
634                <description>
635                        <para>
636                                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.
637                        </para>
638
639                        <para>
640                                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
641                        </para>
642                </description>
643
644        </bitlbee-setting>
645
646        <bitlbee-setting name="color_encrypted" type="boolean" scope="global">
647                <default>true</default>
648
649                <description>
650                        <para>
651                                If set to true, BitlBee will color incoming encrypted messages according to their fingerprint trust level: untrusted=red, trusted=green.
652                        </para>
653                </description>
654
655        </bitlbee-setting>
656
657        <bitlbee-setting name="debug" type="boolean" scope="global">
658                <default>false</default>
659
660                <description>
661                        <para>
662                                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.
663                        </para>
664                </description>
665        </bitlbee-setting>
666
667        <bitlbee-setting name="default_target" type="string" scope="global">
668                <default>root</default>
669                <possible-values>root, last</possible-values>
670
671                <description>
672                        <para>
673                                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>.
674                        </para>
675                </description>
676        </bitlbee-setting>
677
678        <bitlbee-setting name="display_name" type="string" scope="account">
679                <description>
680                        <para>
681                                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.
682                        </para>
683                </description>
684        </bitlbee-setting>
685
686        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
687                <default>false</default>
688
689                <description>
690                        <para>
691                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
692                        </para>
693                </description>
694        </bitlbee-setting>
695
696        <bitlbee-setting name="handle_unknown" type="string" scope="global">
697                <default>root</default>
698                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
699
700                <description>
701                        <para>
702                                Messages from unknown users are echoed like this by default:
703                        </para>
704
705                        <ircexample>
706                                <ircline nick="root">Unknown message from handle 3137137:</ircline>
707                                <ircline nick="root">j0000! 1 4m l33t h4x0r! kill me!</ircline>
708                        </ircexample>
709
710                        <para>
711                                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.
712                        </para>
713
714                        <note>
715                                <para>
716                                        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.
717                                </para>
718                        </note>
719                </description>
720
721        </bitlbee-setting>
722
723        <bitlbee-setting name="halfop_buddies" type="string" scope="global">
724                <default>encrypted</default>
725                <possible-values>encrypted, trusted, notaway, false</possible-values>
726
727                <description>
728                        <para>
729                                Specifies under which circumstances BitlBee should give the "halfop" mode flag (+h) to buddies.
730                        </para>
731                       
732                        <para>
733                                If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key.
734                        </para>
735                </description>
736
737        </bitlbee-setting>
738
739        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
740                <default>true</default>
741
742                <description>
743                        <para>
744                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
745                        </para>
746                </description>
747
748        </bitlbee-setting>
749
750        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
751                <default>false</default>
752
753                <description>
754                        <para>
755                                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.
756                        </para>
757                </description>
758
759        </bitlbee-setting>
760
761        <bitlbee-setting name="op_buddies" type="string" scope="global">
762                <default>trusted</default>
763                <possible-values>encrypted, trusted, notaway, false</possible-values>
764
765                <description>
766                        <para>
767                                Specifies under which circumstances BitlBee should give the "op" mode flag (+o) to buddies.
768                        </para>
769                       
770                        <para>
771                                If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key.
772                        </para>
773                </description>
774
775        </bitlbee-setting>
776
777        <bitlbee-setting name="op_root" type="bool" scope="global">
778                <default>true</default>
779
780                <description>
781                        <para>
782                                Some people prefer themself and root to have operator status in &amp;bitlbee, other people don't. You can set the desired state for root using this setting.
783                        </para>
784                </description>
785        </bitlbee-setting>
786
787        <bitlbee-setting name="op_user" type="bool" scope="global">
788                <default>true</default>
789
790                <description>
791                        <para>
792                                Some people prefer themself and root to have operator status in &amp;bitlbee, other people don't. You can set the desired state for yourself using this setting.
793                        </para>
794                </description>
795        </bitlbee-setting>
796
797        <bitlbee-setting name="otr_policy" type="string" scope="global">
798                <default>opportunistic</default>
799                <possible-values>never, opportunistic, manual, always</possible-values>
800
801                <description>
802                        <para>
803                                This setting controls the policy for establishing Off-the-Record connections.
804                        </para>
805                        <para>
806                                A value of "never" effectively disables the OTR subsystem. In "opportunistic" mode, a magic whitespace pattern will be appended to the first message sent to any user. If the peer is also running opportunistic OTR, an encrypted connection will be set up automatically. On "manual", on the other hand, OTR connections must be established explicitly using <emphasis>otr connect</emphasis>. Finally, the setting "always" enforces encrypted communication by causing BitlBee to refuse to send any cleartext messages at all.
807                        </para>
808                </description>
809        </bitlbee-setting>
810
811        <bitlbee-setting name="nick" type="string" scope="chat">
812
813                <description>
814                        <para>
815                                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.
816                        </para>
817                </description>
818        </bitlbee-setting>
819
820        <bitlbee-setting name="password" type="string" scope="both">
821                <description>
822                        <para>
823                                Use this global setting to change your "NickServ" password.
824                        </para>
825                       
826                        <para>
827                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
828                        </para>
829                       
830                        <para>
831                                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.
832                        </para>
833                </description>
834        </bitlbee-setting>
835       
836        <bitlbee-setting name="port" type="integer" scope="account">
837                <description>
838                        <para>
839                                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.
840                        </para>
841                </description>
842        </bitlbee-setting>
843
844        <bitlbee-setting name="priority" type="integer" scope="account">
845                <default>0</default>
846
847                <description>
848                        <para>
849                                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).
850                        </para>
851
852                        <para>
853                                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).
854                        </para>
855                </description>
856        </bitlbee-setting>
857
858        <bitlbee-setting name="private" type="boolean" scope="global">
859                <default>true</default>
860
861                <description>
862                        <para>
863                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
864                        </para>
865
866                        <para>
867                                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.
868                        </para>
869                </description>
870        </bitlbee-setting>
871
872        <bitlbee-setting name="query_order" type="string" scope="global">
873                <default>lifo</default>
874                <possible-values>lifo, fifo</possible-values>
875
876                <description>
877                        <para>
878                                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.
879                        </para>
880
881                        <para>
882                                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).
883                        </para>
884                </description>
885        </bitlbee-setting>
886
887        <bitlbee-setting name="resource" type="string" scope="account">
888                <default>BitlBee</default>
889
890                <description>
891                        <para>
892                                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.
893                        </para>
894                </description>
895        </bitlbee-setting>
896
897        <bitlbee-setting name="resource_select" type="string" scope="account">
898                <default>priority</default>
899                <possible-values>priority, activity</possible-values>
900
901                <description>
902                        <para>
903                                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.
904                        </para>
905
906                        <para>
907                                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).
908                        </para>
909                </description>
910        </bitlbee-setting>
911
912        <bitlbee-setting name="root_nick" type="string" scope="global">
913                <default>root</default>
914
915                <description>
916                        <para>
917                                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.
918                        </para>
919                </description>
920        </bitlbee-setting>
921
922        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
923                <default>true</default>
924
925                <description>
926                        <para>
927                                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.
928                        </para>
929                </description>
930        </bitlbee-setting>
931
932        <bitlbee-setting name="server" type="string" scope="account">
933                <description>
934                        <para>
935                                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.
936                        </para>
937                </description>
938        </bitlbee-setting>
939
940        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
941                <default>true</default>
942
943                <description>
944                        <para>
945                                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.
946                        </para>
947                </description>
948        </bitlbee-setting>
949
950        <bitlbee-setting name="ssl" type="boolean" scope="account">
951                <default>false</default>
952
953                <description>
954                        <para>
955                                Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
956                        </para>
957                </description>
958        </bitlbee-setting>
959
960        <bitlbee-setting name="strip_html" type="boolean" scope="global">
961                <default>true</default>
962
963                <description>
964                        <para>
965                                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.
966                        </para>
967                        <para>
968                                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.
969                        </para>
970                </description>
971        </bitlbee-setting>
972
973        <bitlbee-setting name="tls" type="boolean" scope="account">
974                <default>try</default>
975
976                <description>
977                        <para>
978                                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.
979                        </para>
980
981                        <para>
982                                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.
983                        </para>
984                </description>
985        </bitlbee-setting>
986
987        <bitlbee-setting name="to_char" type="string" scope="global">
988                <default>": "</default>
989
990                <description>
991                        <para>
992                                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>.
993                        </para>
994
995                        <para>
996                                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.
997                        </para>
998                </description>
999        </bitlbee-setting>
1000
1001        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
1002                <default>false</default>
1003
1004                <description>
1005                        <para>
1006                                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.
1007                        </para>
1008                </description>
1009        </bitlbee-setting>
1010
1011        <bitlbee-setting name="voice_buddies" type="string" scope="global">
1012                <default>trusted</default>
1013                <possible-values>encrypted, trusted, notaway, false</possible-values>
1014
1015                <description>
1016                        <para>
1017                                Specifies under which circumstances BitlBee should give the "voice" mode flag (+v) to buddies.
1018                        </para>
1019                       
1020                        <para>
1021                                If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key.
1022                        </para>
1023                </description>
1024
1025        </bitlbee-setting>
1026
1027        <bitlbee-setting name="web_aware" type="string" scope="account">
1028                <default>false</default>
1029
1030                <description>
1031                        <para>
1032                                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.
1033                        </para>
1034
1035                        <para>
1036                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
1037                        </para>
1038                </description>
1039        </bitlbee-setting>
1040
1041        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
1042                <default>false</default>
1043
1044                <description>
1045                        <para>
1046                                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.
1047                        </para>
1048                        <para>
1049                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
1050                        </para>
1051                </description>
1052        </bitlbee-setting>
1053
1054        <bitlbee-command name="rename">
1055                <short-description>Rename (renick) a buddy</short-description>
1056                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
1057
1058                <description>
1059                        <para>
1060                                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).
1061                        </para>
1062                </description>
1063
1064                <ircexample>
1065                        <ircline nick="itsme">rename itsme_ you</ircline>
1066                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
1067                </ircexample>
1068
1069        </bitlbee-command>
1070
1071        <bitlbee-command name="yes">
1072                <short-description>Accept a request</short-description>
1073                <syntax>yes [&lt;number&gt;]</syntax>
1074
1075                <description>
1076                        <para>
1077                                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.
1078                        </para>
1079
1080                        <para>
1081                                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.
1082                        </para>
1083                </description>
1084
1085        </bitlbee-command>
1086
1087        <bitlbee-command name="no">
1088                <short-description>Deny a request</short-description>
1089                <syntax>no [&lt;number&gt;]</syntax>
1090
1091                <description>
1092                        <para>
1093                                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.
1094                        </para>
1095
1096                        <para>
1097                                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.
1098                        </para>
1099                </description>
1100        </bitlbee-command>
1101
1102        <bitlbee-command name="qlist">
1103                <short-description>List all the unanswered questions root asked</short-description>
1104                <syntax>qlist</syntax>
1105
1106                <description>
1107                        <para>
1108                                This gives you a list of all the unanswered questions from root.
1109                        </para>
1110                </description>
1111
1112        </bitlbee-command>
1113
1114        <bitlbee-command name="register">
1115                <short-description>Register yourself</short-description>
1116                <syntax>register &lt;password&gt;</syntax>
1117
1118                <description>
1119                        <para>
1120                                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.
1121                        </para>
1122
1123                        <para>
1124                                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.. ;-)
1125                        </para>
1126
1127                        <para>
1128                                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.
1129                        </para>
1130                </description>
1131
1132        </bitlbee-command>
1133
1134        <bitlbee-command name="identify">
1135                <syntax>identify &lt;password&gt;</syntax>
1136                <short-description>Identify yourself with your password</short-description>
1137
1138                <description>
1139                        <para>
1140                                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.
1141                        </para>
1142
1143                        <para>
1144                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
1145                        </para>
1146                </description>
1147        </bitlbee-command>
1148
1149        <bitlbee-command name="drop">
1150                <syntax>drop &lt;password&gt;</syntax>
1151                <short-description>Drop your account</short-description>
1152
1153                <description>
1154                        <para>
1155                                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.
1156                        </para>
1157                </description>
1158        </bitlbee-command>
1159
1160        <bitlbee-command name="blist">
1161                <syntax>blist [all|online|offline|away]</syntax>
1162                <short-description>List all the buddies in your contact list</short-description>
1163
1164                <description>
1165                        <para>
1166                                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.
1167                        </para>
1168                </description>
1169
1170        </bitlbee-command>
1171
1172        <bitlbee-command name="nick">
1173                <short-description>Change friendly name, nick</short-description>
1174                <syntax>nick &lt;connection&gt; [&lt;new nick&gt;]</syntax>
1175                <syntax>nick &lt;connection&gt;</syntax>
1176
1177                <description>
1178                        <para>
1179                                Deprecated: Use the per-account <emphasis>display_name</emphasis> setting to read and change this information.
1180                        </para>
1181                </description>
1182
1183                <ircexample>
1184                        <ircline nick="wouter">account set 1/display_name "The majestik møøse"</ircline>
1185                        <ircline nick="root">display_name = `The majestik møøse'</ircline>
1186                </ircexample>
1187
1188        </bitlbee-command>
1189</chapter>
Note: See TracBrowser for help on using the repository browser.