source: doc/user-guide/commands.xml @ 1999fe5

Last change on this file since 1999fe5 was 1999fe5, checked in by dequis <dx@…>, at 2016-12-26T00:18:55Z

Misc documentation updates

  • Remove a bunch of mentions of yahoo
  • Remove 'smileys' topic from help index
  • Add 'identify_methods' help topic
  • Mention new commands like 'chat list' or 'plugins'
  • Property mode set to 100644
File size: 79.7 KB
Line 
1<chapter id="commands">
2        <title>Bitlbee commands</title>
3
4        <command-list/>
5
6        <bitlbee-command name="account">
7                <short-description>IM-account list maintenance</short-description>
8                <syntax>account [&lt;account id&gt;] &lt;action&gt; [&lt;arguments&gt;]</syntax>
9
10                <description>
11
12                        <para>
13                                Available actions: add, del, list, on, off and set. See <emphasis>help account &lt;action&gt;</emphasis> for more information.
14                        </para>
15
16                </description>
17
18                <bitlbee-command name="add">
19                        <syntax>account add &lt;protocol&gt; &lt;username&gt; [&lt;password&gt;]</syntax>
20
21                        <description>
22                                <para>
23                                        Adds an account on the given server with the specified protocol, username and password to the account list. For a list of supported protocols, use the <emphasis>plugins</emphasis> command. For more information about adding an account, see <emphasis>help account add &lt;protocol&gt;</emphasis>.
24                                </para>
25
26                                <para>
27                                        You can omit the password and enter it separately using the IRC /OPER command. This lets you enter your password without your IRC client echoing it on screen or recording it in logs.
28                                </para>
29                        </description>
30                       
31                        <bitlbee-command name="jabber">
32                                <syntax>account add jabber &lt;handle@server.tld&gt; [&lt;password&gt;]</syntax>
33
34                                <description>
35                                        <para>
36                                                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.
37                                        </para>
38
39                                        <para>
40                                                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>).
41                                        </para>
42                                </description>
43                        </bitlbee-command>
44
45                        <bitlbee-command name="msn">
46                                <syntax>account add msn &lt;handle@server.tld&gt; [&lt;password&gt;]</syntax>
47
48                                <description>
49                                        <para>
50                                                For MSN connections there are no special arguments.
51                                        </para>
52                                </description>
53                        </bitlbee-command>
54                       
55                        <bitlbee-command name="oscar">
56                                <syntax>account add oscar &lt;handle&gt; [&lt;password&gt;]</syntax>
57
58                                <description>
59                                        <para>
60                                                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.
61                                        </para>
62                                </description>
63
64                                <ircexample>
65                                        <ircline nick="wilmer">account add oscar 72696705 hobbelmeeuw</ircline>
66                                        <ircline nick="root">Account successfully added</ircline>
67                                </ircexample>
68                        </bitlbee-command>
69                       
70                        <bitlbee-command name="twitter">
71                                <syntax>account add twitter &lt;handle&gt;</syntax>
72
73                                <description>
74                                        <para>
75                                                This module gives you simple access to Twitter and Twitter API compatible services.
76                                        </para>
77                                       
78                                        <para>
79                                                By default all your Twitter contacts will appear in a new channel called #twitter_yourusername. You can change this behaviour using the <emphasis>mode</emphasis> setting (see <emphasis>help set mode</emphasis>).
80                                        </para>
81                                       
82                                        <para>
83                                                To send tweets yourself, send them to the twitter_(yourusername) contact, or just write in the groupchat channel if you enabled that option.
84                                        </para>
85
86                                        <para>
87                                                Since Twitter now requires OAuth authentication, you should not enter your Twitter password into BitlBee. Just type a bogus password. The first time you log in, BitlBee will start OAuth authentication. (See <emphasis>help set oauth</emphasis>.)
88                                        </para>
89                                       
90                                        <para>
91                                                To use a non-Twitter service, change the <emphasis>base_url</emphasis> setting. For identi.ca, you can simply use <emphasis>account add identica</emphasis>.
92                                        </para>
93                                </description>
94                        </bitlbee-command>
95                       
96                        <bitlbee-command name="identica">
97                                <syntax>account add identica &lt;handle&gt;</syntax>
98
99                                <description>
100                                        <para>
101                                                Same protocol as <emphasis>twitter</emphasis>, but defaults to a <emphasis>base_url</emphasis> pointing at identi.ca. It also works with OAuth (so don't specify your password).
102                                        </para>
103                                </description>
104                        </bitlbee-command>
105
106                </bitlbee-command>
107
108                <bitlbee-command name="del">
109                        <syntax>account &lt;account id&gt; del</syntax>
110
111                        <description>
112                                <para>
113                                        This command deletes an account from your account list. You should signoff the account before deleting it.
114                                </para>
115
116
117                                <para>
118                                        The account ID can be a number/tag (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
119                                </para>
120                        </description>
121                </bitlbee-command>
122
123                <bitlbee-command name="on">
124                        <syntax>account [&lt;account id&gt;] on</syntax>
125
126                        <description>
127                                <para>
128                                        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.
129                                </para>
130
131                                <para>
132                                        The account ID can be a number/tag (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
133                                </para>
134                        </description>
135
136                </bitlbee-command>
137
138                <bitlbee-command name="off">
139                        <syntax>account [&lt;account id&gt;] off</syntax>
140
141                        <description>
142                                <para>
143                                        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.
144                                </para>
145
146                                <para>
147                                        The account ID can be a number/tag (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
148                                </para>
149                        </description>
150                </bitlbee-command>
151
152                <bitlbee-command name="list">
153                        <syntax>account list</syntax>
154
155                        <description>
156                                <para>
157                                        This command gives you a list of all the accounts known by BitlBee.
158                                </para>
159                        </description>
160                </bitlbee-command>
161
162                <bitlbee-command name="set">
163                        <syntax>account &lt;account id&gt; set</syntax>
164                        <syntax>account &lt;account id&gt; set &lt;setting&gt;</syntax>
165                        <syntax>account &lt;account id&gt; set &lt;setting&gt; &lt;value&gt;</syntax>
166                        <syntax>account &lt;account id&gt; set -del &lt;setting&gt;</syntax>
167
168                        <description>
169                                <para>
170                                        This command can be used to change various settings for IM accounts. For all protocols, this command can be used to change the handle or the password BitlBee uses to log in and if it should be logged in automatically. Some protocols have additional settings. You can see the settings available for a connection by typing <emphasis>account &lt;account id&gt; set</emphasis>.
171                                </para>
172                               
173                                <para>
174                                        For more information about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
175                                </para>
176                               
177                                <para>
178                                        The account ID can be a number/tag (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
179                                </para>
180                        </description>
181                </bitlbee-command>
182        </bitlbee-command>
183
184        <bitlbee-command name="channel">
185                <short-description>Channel list maintenance</short-description>
186                <syntax>channel [&lt;account id&gt;] &lt;action&gt; [&lt;arguments&gt;]</syntax>
187
188                <description>
189                        <para>
190                                Available actions: del, list, set. See <emphasis>help channel &lt;action&gt;</emphasis> for more information.
191                        </para>
192                       
193                        <para>
194                                There is no <emphasis>channel add</emphasis> command. To create a new channel, just use the IRC <emphasis>/join</emphasis> command. See also <emphasis>help channels</emphasis> and <emphasis>help groupchats</emphasis>.
195                        </para>
196                </description>
197
198                <bitlbee-command name="del">
199                        <syntax>channel &lt;channel id&gt; del</syntax>
200
201                        <description>
202                                <para>
203                                        Remove a channel and forget all its settings. You can only remove channels you're not currently in, and can't remove the main control channel. (You can, however, leave it.)
204                                </para>
205                        </description>
206
207                </bitlbee-command>
208
209                <bitlbee-command name="list">
210                        <syntax>channel list</syntax>
211
212                        <description>
213                                <para>
214                                        This command gives you a list of all the channels you configured.
215                                </para>
216                        </description>
217
218                </bitlbee-command>
219
220                <bitlbee-command name="set">
221                        <syntax>channel [&lt;channel id&gt;] set</syntax>
222                        <syntax>channel [&lt;channel id&gt;] set &lt;setting&gt;</syntax>
223                        <syntax>channel [&lt;channel id&gt;] set &lt;setting&gt; &lt;value&gt;</syntax>
224                        <syntax>channel [&lt;channel id&gt;] set -del &lt;setting&gt;</syntax>
225
226                        <description>
227                                <para>
228                                        This command can be used to change various settings for channels. Different channel types support different settings. You can see the settings available for a channel by typing <emphasis>channel &lt;channel id&gt; set</emphasis>.
229                                </para>
230                               
231                                <para>
232                                        For more information about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
233                                </para>
234                               
235                                <para>
236                                        The channel ID can be a number (see <emphasis>channel list</emphasis>), or (part of) its name, as long as it matches only one channel. If you want to change settings of the current channel, you can omit the channel ID.
237                                </para>
238                        </description>
239                </bitlbee-command>
240
241        </bitlbee-command>
242
243        <bitlbee-command name="chat">
244                <short-description>Chatroom list maintenance</short-description>
245                <syntax>chat &lt;action&gt; [&lt;arguments&gt;]</syntax>
246
247                <description>
248
249                        <para>
250                                Available actions: add, with, list. See <emphasis>help chat &lt;action&gt;</emphasis> for more information.
251                        </para>
252
253                </description>
254
255                <bitlbee-command name="add">
256                        <syntax>chat add &lt;account id&gt; &lt;room|!index&gt; [&lt;channel&gt;]</syntax>
257
258                        <description>
259                                <para>
260                                        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.
261                                </para>
262
263                                <para>
264                                        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. (<emphasis>channel &lt;channel&gt; set auto_join true</emphasis>)
265                                </para>
266
267                                <para>
268                                        Password-protected rooms work exactly like on IRC, by passing the password as an extra argument to /join.
269                                </para>
270                        </description>
271
272                </bitlbee-command>
273
274                <bitlbee-command name="list">
275                        <syntax>chat list &lt;account id&gt; [&lt;server&gt;]</syntax>
276
277                        <description>
278                                <para>
279                                        List existing chatrooms provided by an account. BitlBee needs this to propogate an internal list of chats. The existing chat can then be added with <emphasis>chat add</emphasis>, using the number in the index column after a "!" as a shortcut.
280                                </para>
281                        </description>
282
283                        <ircexample>
284                                <ircline nick="dx">chat list facebook</ircline>
285                                <ircline pre="1" nick="root">Index  Title                 Topic</ircline>
286                                <ircline pre="1" nick="root">    1  869891016470949       cool kids club</ircline>
287                                <ircline pre="1" nick="root">    2  457892181062459       uncool kids club</ircline>
288                                <ircline nick="root">2 facebook chatrooms</ircline>
289                                <ircline nick="dx">chat add facebook !1 #cool-kids-club</ircline>
290                        </ircexample>
291                </bitlbee-command>
292
293                <bitlbee-command name="with">
294                        <syntax>chat with &lt;nickname&gt;</syntax>
295
296                        <description>
297                                <para>
298                                        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.
299                                </para>
300
301                                <para>
302                                        Another way to do this is to join to a new, empty channel with <emphasis>/join #newchannel</emphasis> and invite the first person with <emphasis>/invite nickname</emphasis>
303                                </para>
304                        </description>
305                </bitlbee-command>
306        </bitlbee-command>
307
308        <bitlbee-command name="add">
309                <short-description>Add a buddy to your contact list</short-description>
310                <syntax>add &lt;account id&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
311                <syntax>add -tmp &lt;account id&gt; &lt;handle&gt; [&lt;nick&gt;]</syntax>
312
313                <description>
314                        <para>
315                                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.
316                        </para>
317
318                        <para>
319                                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.
320                        </para>
321
322                        <para>
323                                If you use this command in a control channel containing people from only one group, the new contact will be added to that group automatically.
324                        </para>
325                </description>
326
327                <ircexample>
328                        <ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
329                        <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
330                </ircexample>
331        </bitlbee-command>
332
333        <bitlbee-command name="info">
334                <short-description>Request user information</short-description>
335                <syntax>info &lt;connection&gt; &lt;handle&gt;</syntax>
336                <syntax>info &lt;nick&gt;</syntax>
337
338                <description>
339                        <para>
340                                Requests IM-network-specific information about the specified user. The amount of information you'll get differs per protocol. For some protocols it'll give you an URL which you can visit with a normal web browser to get the information.
341                        </para>
342                </description>
343
344                <ircexample>
345                        <ircline nick="ctrlsoft">info 0 72696705</ircline>
346                        <ircline nick="root">User info - UIN: 72696705   Nick: Lintux   First/Last name: Wilmer van der Gaast   E-mail: lintux@lintux.cx</ircline>
347                </ircexample>
348
349        </bitlbee-command>
350
351        <bitlbee-command name="remove">
352                <short-description>Remove a buddy from your contact list</short-description>
353                <syntax>remove &lt;nick&gt;</syntax>
354
355                <description>
356                        <para>
357                                Removes the specified nick from your buddy list.
358                        </para>
359                </description>
360
361                <ircexample>
362                        <ircline nick="ctrlsoft">remove gryp</ircline>
363                        <ircaction nick="gryp" hostmask="gryp@jabber.jabber.org">has quit <emphasis>[Leaving...]</emphasis></ircaction>
364                </ircexample>
365
366        </bitlbee-command>
367
368        <bitlbee-command name="block">
369                <short-description>Block someone</short-description>
370                <syntax>block &lt;nick&gt;</syntax>
371                <syntax>block &lt;connection&gt; &lt;handle&gt;</syntax>
372                <syntax>block &lt;connection&gt;</syntax>
373
374                <description>
375                        <para>
376                                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.
377                        </para>
378                       
379                        <para>
380                                When called with only a connection specification as an argument, the command displays the current block list for that connection.
381                        </para>
382                </description>
383        </bitlbee-command>
384
385        <bitlbee-command name="allow">
386                <short-description>Unblock someone</short-description>
387                <syntax>allow &lt;nick&gt;</syntax>
388                <syntax>allow &lt;connection&gt; &lt;handle&gt;</syntax>
389
390                <description>
391                        <para>
392                                Reverse of block. Unignores the specified user or user handle on specified connection.
393                        </para>
394                       
395                        <para>
396                                When called with only a connection specification as an argument, the command displays the current allow list for that connection.
397                        </para>
398                </description>
399        </bitlbee-command>
400       
401        <bitlbee-command name="otr">
402                <short-description>Off-the-Record encryption control</short-description>
403                <syntax>otr &lt;subcommand&gt; [&lt;arguments&gt;]</syntax>
404
405                <description>
406
407                        <para>
408                                Available subcommands: connect, disconnect, reconnect, smp, smpq, trust, info, keygen, and forget. See <emphasis>help otr &lt;subcommand&gt;</emphasis> for more information.
409                        </para>
410
411                </description>
412               
413                <bitlbee-command name="connect">
414                        <syntax>otr connect &lt;nick&gt;</syntax>
415                       
416                        <description>
417                       
418                                <para>
419                                        Attempts to establish an encrypted connection with the specified user by sending a magic string.
420                                </para>
421                               
422                        </description>
423               
424                </bitlbee-command>
425               
426                <bitlbee-command name="disconnect">
427                        <syntax>otr disconnect &lt;nick&gt;</syntax>
428                        <syntax>otr disconnect *</syntax>
429                       
430                        <description>
431                       
432                                <para>
433                                        Resets the connection with the specified user/all users to cleartext.
434                                </para>
435                               
436                        </description>
437               
438                </bitlbee-command>
439               
440                <bitlbee-command name="reconnect">
441                        <syntax>otr reconnect &lt;nick&gt;</syntax>
442                       
443                        <description>
444                       
445                                <para>
446                                        Breaks and re-establishes the encrypted connection with the specified user. Useful if something got desynced.
447                                </para>
448                               
449                                <para>
450                                        Equivalent to <emphasis>otr disconnect</emphasis> followed by <emphasis>otr connect</emphasis>.
451                                </para>
452                               
453                        </description>
454               
455                </bitlbee-command>
456               
457                <bitlbee-command name="smp">
458                        <syntax>otr smp &lt;nick&gt; &lt;secret&gt;</syntax>
459                       
460                        <description>
461                       
462                                <para>
463                                        Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol.
464                                </para>
465                               
466                                <para>
467                                        If an SMP challenge has been received from the given user, responds with the specified secret/answer. Otherwise, sends a challenge for the given secret.
468                                </para>
469                               
470                                <para>
471                                        Note that there are two flavors of SMP challenges: "shared-secret" and "question &amp; answer". This command is used to respond to both of them, or to initiate a shared-secret style exchange. Use the <emphasis>otr smpq</emphasis> command to initiate a "Q&amp;A" session.
472                                </para>
473                               
474                                <para>
475                                        When responding to a "Q&amp;A" challenge, the local trust value is not altered. Only the <emphasis>asking party</emphasis> sets trust in the case of success. Use <emphasis>otr smpq</emphasis> to pose your challenge. In a shared-secret exchange, both parties set their trust according to the outcome.
476                                </para>
477                               
478                        </description>
479               
480                </bitlbee-command>
481               
482                <bitlbee-command name="smpq">
483                        <syntax>otr smpq &lt;nick&gt; &lt;question&gt; &lt;answer&gt;</syntax>
484                       
485                        <description>
486                       
487                                <para>
488                                        Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol, Q&amp;A style.
489                                </para>
490
491                                <para>
492                                        Initiates an SMP session in "question &amp; answer" style. The question is transmitted with the initial SMP packet and used to prompt the other party. You must be confident that only they know the answer. If the protocol succeeds (i.e. they answer correctly), the fingerprint will be trusted. Note that the answer must be entered exactly, case and punctuation count!
493                                </para>
494                               
495                                <para>
496                                        Note that this style of SMP only affects the trust setting on your side. Expect your opponent to send you their own challenge. Alternatively, if you and the other party have a shared secret, use the <emphasis>otr smp</emphasis> command.
497                                </para>
498                               
499                        </description>
500               
501                </bitlbee-command>
502               
503                <bitlbee-command name="trust">
504                        <syntax>otr trust &lt;nick&gt; &lt;fp1&gt; &lt;fp2&gt; &lt;fp3&gt; &lt;fp4&gt; &lt;fp5&gt;</syntax>
505                       
506                        <description>
507                       
508                                <para>
509                                        Manually affirms trust in the specified fingerprint, given as five blocks of precisely eight (hexadecimal) digits each.
510                                </para>
511                               
512                        </description>
513               
514                </bitlbee-command>
515               
516                <bitlbee-command name="info">
517                        <syntax>otr info</syntax>
518                        <syntax>otr info &lt;nick&gt;</syntax>
519                       
520                        <description>
521                       
522                                <para>
523                                        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.
524                                </para>
525                               
526                        </description>
527               
528                </bitlbee-command>
529               
530                <bitlbee-command name="keygen">
531                        <syntax>otr keygen &lt;account-no&gt;</syntax>
532                       
533                        <description>
534                       
535                                <para>
536                                        Generates a new OTR private key for the given account.
537                                </para>
538                               
539                        </description>
540               
541                </bitlbee-command>
542               
543                <bitlbee-command name="forget">
544                        <syntax>otr forget &lt;thing&gt; &lt;arguments&gt;</syntax>
545                       
546                        <description>
547                       
548                                <para>
549                                        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.
550                                </para>
551                       
552                        </description>
553                       
554                        <bitlbee-command name="fingerprint">
555                                <syntax>otr forget fingerprint &lt;nick&gt; &lt;fingerprint&gt;</syntax>
556                               
557                                <description>
558                               
559                                        <para>
560                                                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.
561                                        </para>
562                                       
563                                </description>
564                               
565                        </bitlbee-command>
566                               
567                        <bitlbee-command name="context">
568                                <syntax>otr forget context &lt;nick&gt;</syntax>
569                               
570                                <description>
571                               
572                                        <para>
573                                                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.
574                                        </para>
575                                       
576                                </description>
577                               
578                        </bitlbee-command>
579
580                        <bitlbee-command name="key">
581                                <syntax>otr forget key &lt;fingerprint&gt;</syntax>
582                               
583                                <description>
584                               
585                                        <para>
586                                                Forgets an OTR private key matching the specified fingerprint. It is allowed to specify only a (unique) prefix of the fingerprint.
587                                        </para>
588                                       
589                                </description>
590                               
591                        </bitlbee-command>
592               
593                </bitlbee-command>
594               
595        </bitlbee-command>
596
597        <bitlbee-command name="set">
598                <short-description>Miscellaneous settings</short-description>
599                <syntax>set</syntax>
600                <syntax>set &lt;variable&gt;</syntax>
601                <syntax>set &lt;variable&gt; &lt;value&gt;</syntax>
602                <syntax>set -del &lt;variable&gt;</syntax>
603
604                <description>
605
606                        <para>
607                                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.
608                        </para>
609
610                        <para>
611                                To get more help information about a setting, try:
612                        </para>
613
614                </description>
615
616                <ircexample>
617                        <ircline nick="ctrlsoft">help set private</ircline>
618                </ircexample>
619
620        </bitlbee-command>
621
622        <bitlbee-command name="help">
623                <short-description>BitlBee help system</short-description>
624
625                <syntax>help [subject]</syntax>
626
627                <description>
628                        <para>
629                                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.
630                        </para>
631                </description>
632        </bitlbee-command>
633
634        <bitlbee-command name="save">
635                <short-description>Save your account data</short-description>
636                <syntax>save</syntax>
637
638                <description>
639                        <para>
640                                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... ;-)
641                        </para>
642                </description>
643        </bitlbee-command>
644
645        <bitlbee-setting name="account" type="string" scope="channel">
646
647                <description>
648                        <para>
649                                For control channels with <emphasis>fill_by</emphasis> set to <emphasis>account</emphasis>: Set this setting to the account id (numeric, or part of the username) of the account containing the contacts you want to see in this channel.
650                        </para>
651                </description>
652        </bitlbee-setting>
653
654        <bitlbee-setting name="allow_takeover" type="boolean" scope="global">
655                <default>true</default>
656
657                <description>
658                        <para>
659                                When you're already connected to a BitlBee server and you connect (and identify) again, BitlBee will offer to migrate your existing session to the new connection. If for whatever reason you don't want this, you can disable this setting.
660                        </para>
661                </description>
662        </bitlbee-setting>
663
664        <bitlbee-setting name="always_use_nicks" type="boolean" scope="channel">
665                <default>false</default>
666
667                <description>
668                        <para>
669                                Jabber groupchat specific. This setting ensures that the nicks defined by the other members of a groupchat are used, instead of the username part of their JID. This only applies to groupchats where their real JID is known (either "non-anonymous" ones, or "semi-anonymous" from the point of view of the channel moderators)
670                        </para>
671
672                        <para>
673                                Enabling this may have the side effect of changing the nick of existing contacts, either in your buddy list or in other groupchats. If a contact is in multiple groupchats with different nicks, enabling this setting for all those would result in multiple nick changes when joining, and the order of those changes may vary.
674                        </para>
675
676                        <para>
677                                Note that manual nick changes done through the <emphasis>rename</emphasis> command always take priority
678                        </para>
679                </description>
680        </bitlbee-setting>
681
682        <bitlbee-setting name="auto_connect" type="boolean" scope="account,global">
683                <default>true</default>
684
685                <description>
686                        <para>
687                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
688                        </para>
689                       
690                        <para>
691                                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!)
692                        </para>
693                </description>
694        </bitlbee-setting>
695
696        <bitlbee-setting name="auto_join" type="boolean" scope="channel">
697                <default>false</default>
698
699                <description>
700                        <para>
701                                With this option enabled, BitlBee will automatically join this channel when you log in.
702                        </para>
703                </description>
704        </bitlbee-setting>
705
706        <bitlbee-setting name="auto_reconnect" type="boolean" scope="account,global">
707                <default>true</default>
708
709                <description>
710                        <para>
711                                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.
712                        </para>
713
714                        <para>
715                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
716                        </para>
717
718                        <para>
719                                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!)
720                        </para>
721                </description>
722        </bitlbee-setting>
723
724        <bitlbee-setting name="auto_reconnect_delay" type="string" scope="global">
725                <default>5*3&lt;900</default>
726
727                <description>
728                        <para>
729                                Tell BitlBee after how many seconds it should attempt to bring a broken IM-connection back up.
730                        </para>
731
732                        <para>
733                                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.
734                        </para>
735
736                        <para>
737                                See also the <emphasis>auto_reconnect</emphasis> setting.
738                        </para>
739                </description>
740        </bitlbee-setting>
741
742        <bitlbee-setting name="auto_reply_timeout" type="integer" scope="account">
743                <default>10800</default>
744
745                <description>
746                        <para>
747                                For Twitter accounts: If you respond to Tweets IRC-style (like "nickname: reply"), this will automatically be converted to the usual Twitter format ("@screenname reply").
748                        </para>
749
750                        <para>
751                                By default, BitlBee will then also add a reference to that person's most recent Tweet, unless that message is older than the value of this setting in seconds.
752                        </para>
753
754                        <para>
755                                If you want to disable this feature, just set this to 0. Alternatively, if you want to write a message once that is <emphasis>not</emphasis> a reply, use the Twitter reply syntax (@screenname).
756                        </para>
757                </description>
758        </bitlbee-setting>
759
760        <bitlbee-setting name="away" type="string" scope="account,global">
761                <description>
762                        <para>
763                                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.
764                        </para>
765
766                        <para>
767                                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.
768                        </para>
769
770                        <para>
771                                Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>.
772                        </para>
773                </description>
774        </bitlbee-setting>
775
776        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
777                <default>true</default>
778
779                <description>
780                        <para>
781                                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.
782                        </para>
783                       
784                        <para>
785                                Replaced with the <emphasis>show_users</emphasis> setting. See <emphasis>help show_users</emphasis>.
786                        </para>
787                </description>
788        </bitlbee-setting>
789
790        <bitlbee-setting name="away_reply_timeout" type="integer" scope="global">
791                <default>3600</default>
792
793                <description>
794                        <para>
795                                Most IRC servers send a user's away message every time s/he gets a private message, to inform the sender that they may not get a response immediately. With this setting set to 0, BitlBee will also behave like this.
796                        </para>
797
798                        <para>
799                                Since not all IRC clients do an excellent job at suppressing these messages, this setting lets BitlBee do it instead. BitlBee will wait this many seconds (or until the away state/message changes) before re-informing you that the person's away.
800                        </para>
801                </description>
802        </bitlbee-setting>
803
804        <bitlbee-setting name="base_url" type="string" scope="account">
805                <default>http://api.twitter.com/1</default>
806
807                <description>
808                        <para>
809                                There are more services that understand the Twitter API than just Twitter.com. BitlBee can connect to all Twitter API implementations.
810                        </para>
811
812                        <para>
813                                For example, set this setting to <emphasis>http://identi.ca/api</emphasis> to use Identi.ca.
814                        </para>
815
816                        <para>
817                                Keep two things in mind: When not using Twitter, you <emphasis>must</emphasis> also disable the <emphasis>oauth</emphasis> setting as it currently only works with Twitter. If you're still having issues, make sure there is <emphasis>no</emphasis> slash at the end of the URL you enter here.
818                        </para>
819                </description>
820        </bitlbee-setting>
821
822        <bitlbee-setting name="carbons" type="boolean" scope="account">
823                <default>true</default>
824
825                <description>
826                        <para>
827                                Jabber specific. "Message carbons" (XEP-0280) is a server feature to get copies of outgoing messages sent from other clients connected to the same account. It's not widely supported by most public XMPP servers (easier if you host your own), but this will probably change in the next few years.
828                        </para>
829                        <para>
830                                This defaults to true, which will enable it if the server supports it, or fail silently if it's not. This setting only exists to allow disabling the feature if anyone considers it undesirable.
831                        </para>
832                        <para>
833                                See also the <emphasis>self_messages</emphasis> setting.
834                        </para>
835                </description>
836        </bitlbee-setting>
837
838        <bitlbee-setting name="charset" type="string" scope="global">
839                <default>utf-8</default>
840                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
841
842                <description>
843                        <para>
844                                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.
845                        </para>
846
847                        <para>
848                                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
849                        </para>
850                </description>
851
852        </bitlbee-setting>
853
854        <bitlbee-setting name="color_encrypted" type="boolean" scope="global">
855                <default>true</default>
856
857                <description>
858                        <para>
859                                If set to true, BitlBee will color incoming encrypted messages according to their fingerprint trust level: untrusted=red, trusted=green.
860                        </para>
861                </description>
862        </bitlbee-setting>
863
864        <bitlbee-setting name="chat_type" type="string" scope="channel">
865                <default>groupchat</default>
866                <possible-values>groupchat, room</possible-values>
867
868                <description>
869                        <para>
870                                There are two kinds of chat channels: simple groupchats (basically normal IM chats with more than two participants) and names chatrooms, more similar to IRC channels.
871                        </para>
872                       
873                        <para>
874                                BitlBee supports both types. With this setting set to <emphasis>groupchat</emphasis> (the default), you can just invite people into the room and start talking.
875                        </para>
876                       
877                        <para>
878                                For setting up named chatrooms, it's currently easier to just use the <emphasis>chat add</emphasis> command.
879                        </para>
880                </description>
881        </bitlbee-setting>
882
883        <bitlbee-setting name="commands" type="boolean" scope="account">
884                <default>true</default>
885                <possible-values>true, false, strict</possible-values>
886
887                <description>
888                        <para>
889                                With this setting enabled, you can use some commands in your Twitter channel/query. The commands are simple and not documented in too much detail:
890                        </para>
891
892                        <variablelist>
893                                <varlistentry><term>undo #[&lt;id&gt;]</term><listitem><para>Delete your last Tweet (or one with the given ID)</para></listitem></varlistentry>
894                                <varlistentry><term>rt &lt;screenname|#id&gt;</term><listitem><para>Retweet someone's last Tweet (or one with the given ID)</para></listitem></varlistentry>
895                                <varlistentry><term>reply &lt;screenname|#id&gt;</term><listitem><para>Reply to a Tweet (with a reply-to reference)</para></listitem></varlistentry>
896                                <varlistentry><term>rawreply &lt;screenname|#id&gt;</term><listitem><para>Reply to a Tweet (with no reply-to reference)</para></listitem></varlistentry>
897                                <varlistentry><term>report &lt;screenname|#id&gt;</term><listitem><para>Report the given user (or the user who posted the tweet with the given ID) for sending spam. This will also block them.</para></listitem></varlistentry>
898                                <varlistentry><term>follow &lt;screenname&gt;</term><listitem><para>Start following a person</para></listitem></varlistentry>
899                                <varlistentry><term>unfollow &lt;screenname&gt;</term><listitem><para>Stop following a person</para></listitem></varlistentry>
900                                <varlistentry><term>favourite &lt;screenname|#id&gt;</term><listitem><para>Favo<emphasis>u</emphasis>rite the given user's most recent tweet, or the given tweet ID.</para></listitem></varlistentry>
901                                <varlistentry><term>post &lt;message&gt;</term><listitem><para>Post a tweet</para></listitem></varlistentry>
902                                <varlistentry><term>url &lt;screenname|#id&gt;</term><listitem><para>Show URL for a tweet to open it in a browser (and see context)</para></listitem></varlistentry>
903                        </variablelist>
904
905                        <para>
906                                Anything that doesn't look like a command will be treated as a tweet. Watch out for typos, or to avoid this behaviour, you can set this setting to <emphasis>strict</emphasis>, which causes the <emphasis>post</emphasis> command to become mandatory for posting a tweet.
907                        </para>
908                </description>
909        </bitlbee-setting>
910
911        <bitlbee-setting name="debug" type="boolean" scope="global">
912                <default>false</default>
913
914                <description>
915                        <para>
916                                Some debugging messages can be logged if you wish. They're probably not really useful for you, unless you're doing some development on BitlBee.
917                        </para>
918                       
919                        <para>
920                                This feature is not currently used for anything so don't expect this to generate any output.
921                        </para>
922                </description>
923        </bitlbee-setting>
924
925        <bitlbee-setting name="default_target" type="string" scope="global">
926                <default>root</default>
927                <possible-values>root, last</possible-values>
928
929                <description>
930                        <para>
931                                With this value set to <emphasis>root</emphasis>, lines written in a 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 that control channel, set this to <emphasis>last</emphasis>.
932                        </para>
933                </description>
934        </bitlbee-setting>
935
936        <bitlbee-setting name="display_name" type="string" scope="account">
937                <description>
938                        <para>
939                                Currently only available for MSN connections, and for jabber groupchats.
940                        </para>
941                        <para>
942                                For MSN: 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.
943                        </para>
944                        <para>
945                                For jabber groupchats: this sets the default value of 'nick' for newly created groupchats. There is no way to set an account-wide nick like MSN.
946                        </para>
947                </description>
948        </bitlbee-setting>
949
950        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
951                <default>false</default>
952
953                <description>
954                        <para>
955                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
956                        </para>
957                </description>
958        </bitlbee-setting>
959
960        <bitlbee-setting name="display_timestamps" type="boolean" scope="global">
961                <default>true</default>
962
963                <description>
964                        <para>
965                                When incoming messages are old (i.e. offline messages and channel backlogs), BitlBee will prepend them with a timestamp. If you find them ugly or useless, you can use this setting to hide them.
966                        </para>
967                </description>
968        </bitlbee-setting>
969
970        <bitlbee-setting name="fill_by" type="string" scope="channel">
971                <default>all</default>
972                <possible-values>all, group, account, protocol</possible-values>
973
974                <description>
975                        <para>
976                                For control channels only: This setting determines which contacts the channel gets populated with.
977                        </para>
978
979                        <para>
980                                By default, control channels will contain all your contacts. You instead select contacts by buddy group, IM account or IM protocol.
981                        </para>
982                       
983                        <para>
984                                Change this setting and the corresponding <emphasis>account</emphasis>/<emphasis>group</emphasis>/<emphasis>protocol</emphasis> setting to set up this selection.
985                        </para>
986                       
987                        <para>
988                                With a ! prefix an inverted channel can be created, for example with this setting set to <emphasis>!group</emphasis> you can create a channel with all users <emphasis>not</emphasis> in that group.
989                        </para>
990                       
991                        <para>
992                                Note that, when creating a new channel, BitlBee will try to preconfigure the channel for you, based on the channel name. See <emphasis>help channels</emphasis>.
993                        </para>
994                </description>
995        </bitlbee-setting>
996
997        <bitlbee-setting name="group" type="string" scope="channel">
998
999                <description>
1000                        <para>
1001                                For control channels with <emphasis>fill_by</emphasis> set to <emphasis>group</emphasis>: Set this setting to the name of the group containing the contacts you want to see in this channel.
1002                        </para>
1003                </description>
1004        </bitlbee-setting>
1005
1006        <bitlbee-setting name="handle_unknown" type="string" scope="global">
1007                <default>add_channel</default>
1008                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
1009
1010                <description>
1011                        <para>
1012                                By default, messages from people who aren't in your contact list are shown in a control channel instead of as a private message.
1013                        </para>
1014
1015                        <para>
1016                                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.
1017                        </para>
1018
1019                        <note>
1020                                <para>
1021                                        Although these users will appear in your control channel, they aren't added to your real contact list. When you restart BitlBee, these auto-added users will be gone. If you want to keep someone in your list, you have to fixate the add using the <emphasis>add</emphasis> command.
1022                                </para>
1023                        </note>
1024                </description>
1025
1026        </bitlbee-setting>
1027
1028        <bitlbee-setting name="ignore_auth_requests" type="boolean" scope="account">
1029                <default>false</default>
1030
1031                <description>
1032                        <para>
1033                                Only supported by OSCAR so far, you can use this setting to ignore ICQ authorization requests, which are hardly used for legitimate (i.e. non-spam) reasons anymore.
1034                        </para>
1035                </description>
1036
1037        </bitlbee-setting>
1038
1039        <bitlbee-setting name="local_display_name" type="boolean" scope="account">
1040                <default>false</default>
1041
1042                <description>
1043                        <para>
1044                                Mostly meant to work around a bug in MSN servers (forgetting the display name set by the user), this setting tells BitlBee to store your display name locally and set this name on the MSN servers when connecting.
1045                        </para>
1046                </description>
1047
1048        </bitlbee-setting>
1049
1050        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
1051                <default>false</default>
1052
1053                <description>
1054                        <para>
1055                                Some protocols can notify via IM about new e-mail. If you want these notifications, you can enable this setting.
1056                        </para>
1057                </description>
1058
1059        </bitlbee-setting>
1060
1061        <bitlbee-setting name="mail_notifications_handle" type="string" scope="account">
1062                <default>empty</default>
1063
1064                <description>
1065                        <para>
1066                                This setting is available for protocols with e-mail notification functionality. If set to empty all e-mail notifications will go to control channel, if set to some string - this will be the name of a contact who will PRIVMSG you on every new notification.
1067                        </para>
1068                </description>
1069
1070        </bitlbee-setting>
1071
1072        <bitlbee-setting name="message_length" type="integer" scope="account">
1073                <default>140</default>
1074
1075                <description>
1076                        <para>
1077                                Since Twitter rejects messages longer than 140 characters, BitlBee can count message length and emit a warning instead of waiting for Twitter to reject it.
1078                        </para>
1079
1080                        <para>
1081                                You can change this limit here but this won't disable length checks on Twitter's side. You can also set it to 0 to disable the check in case you believe BitlBee doesn't count the characters correctly.
1082                        </para>
1083                </description>
1084
1085        </bitlbee-setting>
1086
1087        <bitlbee-setting name="stream" type="boolean" scope="account">
1088                <default>true</default>
1089
1090                <description>
1091                        <para>
1092                                For Twitter accounts, this setting enables use of the Streaming API. This automatically gives you incoming DMs as well.
1093                        </para>
1094                       
1095                        <para>
1096                                For other Twitter-like services, this setting is not supported.
1097                        </para>
1098                </description>
1099
1100        </bitlbee-setting>
1101       
1102        <bitlbee-setting name="target_url_length" type="integer" scope="account">
1103                <default>20</default>
1104
1105                <description>
1106                        <para>
1107                                Twitter replaces every URL with fixed-length t.co URLs. BitlBee is able to take t.co urls into account when calculating <emphasis>message_length</emphasis> replacing the actual URL length with target_url_length. Setting target_url_length to 0 disables this feature.
1108                        </para>
1109
1110                        <para>
1111                                This setting is disabled for identica accounts by default and will not affect anything other than message safety checks (i.e. Twitter will still replace your URLs with t.co links, even if that makes them longer).
1112                        </para>
1113                </description>
1114
1115        </bitlbee-setting>
1116
1117        <bitlbee-setting name="mode" type="string" scope="account">
1118                <possible-values>one, many, chat</possible-values>
1119                <default>chat</default>
1120
1121                <description>
1122                        <para>
1123                                By default, BitlBee will create a separate channel (called #twitter_yourusername) for all your Twitter contacts/messages.
1124                        </para>
1125
1126                        <para>
1127                                If you don't want an extra channel, you can set this setting to "one" (everything will come from one nick, twitter_yourusername), or to "many" (individual nicks for everyone).
1128                        </para>
1129                       
1130                        <para>
1131                                With modes "chat" and "many", you can send direct messages by /msg'ing your contacts directly. Incoming DMs are only fetched if the "stream" setting is on (default).
1132                        </para>
1133                       
1134                        <para>
1135                                With modes "many" and "one", you can post tweets by /msg'ing the twitter_yourusername contact. In mode "chat", messages posted in the Twitter channel will also be posted as tweets.
1136                        </para>
1137                </description>
1138
1139        </bitlbee-setting>
1140
1141        <bitlbee-setting name="mobile_is_away" type="boolean" scope="global">
1142                <default>false</default>
1143
1144                <description>
1145                        <para>
1146                                Most IM networks have a mobile version of their client. People who use these may not be paying that much attention to messages coming in. By enabling this setting, people using mobile clients will always be shown as away.
1147                        </para>
1148                </description>
1149
1150        </bitlbee-setting>
1151
1152        <bitlbee-setting name="nick" type="string" scope="chat">
1153                <description>
1154                        <para>
1155                                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.
1156                        </para>
1157                </description>
1158        </bitlbee-setting>
1159
1160        <bitlbee-setting name="nick_format" type="string" scope="account,global">
1161                <default>%-@nick</default>
1162
1163                <description>
1164                        <para>
1165                                By default, BitlBee tries to derive sensible nicknames for all your contacts from their IM handles. In some cases, IM modules (ICQ for example) will provide a nickname suggestion, which will then be used instead. This setting lets you change this behaviour.
1166                        </para>
1167
1168                        <para>
1169                                Whenever this setting is set for an account, it will be used for all its contacts. If it's not set, the global value will be used.
1170                        </para>
1171
1172                        <para>
1173                                It's easier to describe this setting using a few examples:
1174                        </para>
1175
1176                        <para>
1177                                FB-%full_name will make all nicknames start with "FB-", followed by the person's full name. For example you can set this format for your Facebook account so all Facebook contacts are clearly marked.
1178                        </para>
1179
1180                        <para>
1181                                [%group]%-@nick will make all nicknames start with the group the contact is in between square brackets, followed by the nickname suggestions from the IM module if available, or otherwise the handle. Because of the "-@" part, everything from the first @ will be stripped.
1182                        </para>
1183
1184                        <para>
1185                                See <emphasis>help nick_format</emphasis> for more information.
1186                        </para>
1187                </description>
1188        </bitlbee-setting>
1189
1190        <bitlbee-setting name="nick_source" type="string" scope="account">
1191                <default>handle</default>
1192                <possible-values>handle, full_name, first_name</possible-values>
1193
1194                <description>
1195                        <para>
1196                                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. Some servers use internal identifiers, which are often just numbers.
1197                        </para>
1198
1199                        <para>
1200                                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.
1201                        </para>
1202                </description>
1203        </bitlbee-setting>
1204
1205        <bitlbee-setting name="nick_lowercase" type="boolean" scope="global">
1206                <default>true</default>
1207
1208                <description>
1209                        <para>
1210                                If enabled, all nicknames are turned into lower case.
1211                        </para>
1212
1213                        <para>
1214                                See also the <emphasis>nick_underscores</emphasis> setting. This setting was previously known as <emphasis>lcnicks</emphasis>.
1215                        </para>
1216                </description>
1217
1218        </bitlbee-setting>
1219
1220        <bitlbee-setting name="nick_underscores" type="boolean" scope="global">
1221                <default>true</default>
1222
1223                <description>
1224                        <para>
1225                                If enabled, spaces in nicknames are turned into underscores instead of being stripped.
1226                        </para>
1227
1228                        <para>
1229                                See also the <emphasis>nick_lowercase</emphasis> setting.
1230                        </para>
1231                </description>
1232
1233        </bitlbee-setting>
1234
1235        <bitlbee-setting name="oauth" type="boolean" scope="account">
1236                <default>true</default>
1237
1238                <description>
1239                        <para>
1240                                This enables OAuth authentication for an IM account; right now the Twitter (working for Twitter only) and Jabber (for Google Talk only) module support it.
1241                        </para>
1242
1243                        <para>
1244                                With OAuth enabled, you shouldn't tell BitlBee your account password. Just add your account with a bogus password and type <emphasis>account on</emphasis>. BitlBee will then give you a URL to authenticate with the service. If this succeeds, you will get a PIN code which you can give back to BitlBee to finish the process.
1245                        </para>
1246
1247                        <para>
1248                                The resulting access token will be saved permanently, so you have to do this only once. If for any reason you want to/have to reauthenticate, you can use <emphasis>account set</emphasis> to reset the account password to something random.
1249                        </para>
1250                </description>
1251
1252        </bitlbee-setting>
1253
1254        <bitlbee-setting name="anonymous" type="boolean" scope="account">
1255                <default>false</default>
1256
1257                <description>
1258                        <para>
1259                                This enables SASL ANONYMOUS login for jabber accounts, as specified by XEP-0175.
1260                        </para>
1261
1262                        <para>
1263                                With this setting enabled, if the server allows this method, a password isn't required and the username part of the JID is ignored (you can use anonymous@jabber.example.com). Servers will usually assign you a random numeric username instead.
1264                        </para>
1265                </description>
1266
1267        </bitlbee-setting>
1268
1269        <bitlbee-setting name="ops" type="string" scope="global">
1270                <default>both</default>
1271                <possible-values>both, root, user, none</possible-values>
1272
1273                <description>
1274                        <para>
1275                                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.
1276                        </para>
1277
1278                        <para>
1279                                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.
1280                        </para>
1281                </description>
1282        </bitlbee-setting>
1283
1284        <bitlbee-setting name="otr_policy" type="string" scope="global">
1285                <default>opportunistic</default>
1286                <possible-values>never, opportunistic, manual, always</possible-values>
1287
1288                <description>
1289                        <para>
1290                                This setting controls the policy for establishing Off-the-Record connections.
1291                        </para>
1292                        <para>
1293                                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.
1294                        </para>
1295                </description>
1296        </bitlbee-setting>
1297
1298        <bitlbee-setting name="password" type="string" scope="account,global">
1299                <description>
1300                        <para>
1301                                Use this global setting to change your "NickServ" password.
1302                        </para>
1303                       
1304                        <para>
1305                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
1306                        </para>
1307                       
1308                        <para>
1309                                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.
1310                        </para>
1311                </description>
1312        </bitlbee-setting>
1313
1314        <bitlbee-setting name="paste_buffer" type="boolean" scope="global">
1315                <default>false</default>
1316
1317                <description>
1318                        <para>
1319                                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.
1320                        </para>
1321
1322                        <para>
1323                                Using the <emphasis>paste_buffer_delay</emphasis> setting you can specify the number of seconds BitlBee should wait for more data before the complete message is sent.
1324                        </para>
1325
1326                        <para>
1327                                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.
1328                        </para>
1329                </description>
1330        </bitlbee-setting>
1331
1332        <bitlbee-setting name="paste_buffer_delay" type="integer" scope="global">
1333                <default>200</default>
1334
1335                <description>
1336
1337                        <para>
1338                                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.
1339                        </para>
1340
1341                        <para>
1342                                See also the <emphasis>paste_buffer</emphasis> setting.
1343                        </para>
1344                </description>
1345        </bitlbee-setting>
1346       
1347        <bitlbee-setting name="port" type="integer" scope="account">
1348                <description>
1349                        <para>
1350                                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.
1351                        </para>
1352                </description>
1353        </bitlbee-setting>
1354
1355        <bitlbee-setting name="priority" type="integer" scope="account">
1356                <default>0</default>
1357
1358                <description>
1359                        <para>
1360                                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).
1361                        </para>
1362
1363                        <para>
1364                                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).
1365                        </para>
1366                </description>
1367        </bitlbee-setting>
1368
1369        <bitlbee-setting name="private" type="boolean" scope="global">
1370                <default>true</default>
1371
1372                <description>
1373                        <para>
1374                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in a control channel.
1375                        </para>
1376
1377                        <para>
1378                                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.
1379                        </para>
1380                </description>
1381        </bitlbee-setting>
1382
1383        <bitlbee-setting name="protocol" type="string" scope="channel">
1384
1385                <description>
1386                        <para>
1387                                For control channels with <emphasis>fill_by</emphasis> set to <emphasis>protocol</emphasis>: Set this setting to the name of the IM protocol of all contacts you want to see in this channel.
1388                        </para>
1389                </description>
1390        </bitlbee-setting>
1391
1392        <bitlbee-setting name="proxy" type="string" scope="account">
1393                <default>&lt;local&gt;&lt;auto&gt;</default>
1394
1395                <description>
1396                        <para>
1397                                A list of <emphasis>file transfer proxies</emphasis> for jabber. This isn't the connection proxy. Sorry, look in bitlbee.conf for those.
1398                        </para>
1399
1400                        <para>
1401                                It's a semicolon-separated list of items that can be either <emphasis>JID,HOST,PORT</emphasis> or two special values, <emphasis>&lt;local&gt;</emphasis> (to try a direct connection first) and <emphasis>&lt;auto&gt;</emphasis> (to try to discover a proxy). For example, "&lt;local&gt;;proxy.somewhere.org,123.123.123.123,7777".
1402                        </para>
1403                        <para>
1404                                The address should point to a SOCKS5 bytestreams server, usually provided by jabber servers. This is only used for sending files. Note that the host address might not match what DNS tells you, and the port isn't always the same.
1405                        </para>
1406                        <para>
1407                                The correct way to get a socks proxy host/port is a mystery, and the file transfer might fail anyway. Maybe just try using dropbox instead.
1408                        </para>
1409                </description>
1410        </bitlbee-setting>
1411
1412        <bitlbee-setting name="query_order" type="string" scope="global">
1413                <default>lifo</default>
1414                <possible-values>lifo, fifo</possible-values>
1415
1416                <description>
1417                        <para>
1418                                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.
1419                        </para>
1420
1421                        <para>
1422                                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).
1423                        </para>
1424                </description>
1425        </bitlbee-setting>
1426
1427        <bitlbee-setting name="resource" type="string" scope="account">
1428                <default>BitlBee</default>
1429
1430                <description>
1431                        <para>
1432                                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.
1433                        </para>
1434                </description>
1435        </bitlbee-setting>
1436
1437        <bitlbee-setting name="resource_select" type="string" scope="account">
1438                <default>activity</default>
1439                <possible-values>priority, activity</possible-values>
1440
1441                <description>
1442                        <para>
1443                                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.
1444                        </para>
1445
1446                        <para>
1447                                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).
1448                        </para>
1449                </description>
1450        </bitlbee-setting>
1451
1452        <bitlbee-setting name="root_nick" type="string" scope="global">
1453                <default>root</default>
1454
1455                <description>
1456                        <para>
1457                                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.
1458                        </para>
1459                </description>
1460        </bitlbee-setting>
1461
1462        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
1463                <default>true</default>
1464
1465                <description>
1466                        <para>
1467                                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.
1468                        </para>
1469                </description>
1470        </bitlbee-setting>
1471
1472        <bitlbee-setting name="self_messages" type="string" scope="global">
1473                <default>true</default>
1474                <possible-values>true, false, prefix, prefix_notice</possible-values>
1475
1476                <description>
1477                        <para>
1478                                Change this setting to customize how (or whether) to show self-messages, which are messages sent by yourself from other locations (for example, mobile clients), for IM protocols that support it.
1479                        </para>
1480
1481                        <para>
1482                                When this is set to "true", it will send those messages in the "standard" way, which is a PRIVMSG with source and target fields swapped.
1483                        </para>
1484                       
1485                        <para>
1486                                Since this isn't very well supported by some clients (the messages might appear in the wrong window), you can set it to "prefix" to show them as a normal message prefixed with "-> ", or use "prefix_notice" which is the same thing but with a NOTICE instead.
1487                        </para>
1488
1489                        <para>
1490                                You can also set it to "false" to disable these messages completely.
1491                        </para>
1492
1493                        <para>
1494                                This setting only applies to private messages. Self messages in groupchats are always shown, since they haven't caused issues in any clients so far.
1495                        </para>
1496
1497                        <para>
1498                                More information: <emphasis>https://wiki.bitlbee.org/SelfMessages</emphasis>
1499                        </para>
1500                </description>
1501        </bitlbee-setting>
1502
1503        <bitlbee-setting name="server" type="string" scope="account">
1504                <description>
1505                        <para>
1506                                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.
1507                        </para>
1508                </description>
1509        </bitlbee-setting>
1510
1511        <bitlbee-setting name="show_ids" type="boolean" scope="account">
1512                <default>true</default>
1513
1514                <description>
1515                        <para>
1516                                Enable this setting on a Twitter account to have BitlBee include a two-digit "id" in front of every message. This id can then be used for replies and retweets.
1517                        </para>
1518                </description>
1519        </bitlbee-setting>
1520
1521        <bitlbee-setting name="show_offline" type="boolean" scope="global">
1522                <default>false</default>
1523
1524                <description>
1525                        <para>
1526                                If enabled causes BitlBee to also show offline users in Channel. Online-users will get op, away-users voice and offline users none of both. This option takes effect as soon as you reconnect.
1527                        </para>
1528                       
1529                        <para>
1530                                Replaced with the <emphasis>show_users</emphasis> setting. See <emphasis>help show_users</emphasis>.
1531                        </para>
1532                </description>
1533        </bitlbee-setting>
1534
1535        <bitlbee-setting name="show_users" type="string" scope="channel">
1536                <default>online+,special%,away</default>
1537
1538                <description>
1539                        <para>
1540                                Comma-separated list of statuses of users you want in the channel,
1541                                and any modes they should have. The following statuses are currently
1542                                recognised: <emphasis>online</emphasis> (i.e. available, not
1543                                away), <emphasis>special</emphasis> (specific to the protocol),
1544                                <emphasis>away</emphasis>, and <emphasis>offline</emphasis>.
1545                        </para>
1546                       
1547                        <para>
1548                                If a status is followed by a valid channel mode character
1549                                (@, % or +), it will be given to users with that status.
1550                                For example, <emphasis>online@,special%,away+,offline</emphasis> 
1551                                will show all users in the channel. Online people will
1552                                have +o, people who are online but away will have +v,
1553                                and others will have no special modes.
1554                        </para>
1555                </description>
1556        </bitlbee-setting>
1557
1558        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
1559                <default>true</default>
1560
1561                <description>
1562                        <para>
1563                                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 channels window clean. If you don't like this (or if your IRC client doesn't support this) you can disable this setting.
1564                        </para>
1565                </description>
1566        </bitlbee-setting>
1567
1568        <bitlbee-setting name="ssl" type="boolean" scope="account">
1569                <default>false</default>
1570
1571                <description>
1572                        <para>
1573                                Currently only available for Jabber connections. Set this to true if you want to connect to the server on an SSL-enabled port (usually 5223).
1574                        </para>
1575
1576                        <para>
1577                                Please note that this method of establishing a secure connection to the server has long been deprecated. You are encouraged to look at the <emphasis>tls</emphasis> setting instead.
1578                        </para>
1579                </description>
1580        </bitlbee-setting>
1581
1582        <bitlbee-setting name="status" type="string" scope="account,global">
1583                <description>
1584                        <para>
1585                                Most IM protocols 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.
1586                        </para>
1587
1588                        <para>
1589                                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).
1590                        </para>
1591
1592                        <para>
1593                                Away states set using <emphasis>/away</emphasis> or the <emphasis>away</emphasis> setting will override this setting. To clear the setting, use <emphasis>set -del status</emphasis>.
1594                        </para>
1595                </description>
1596        </bitlbee-setting>
1597
1598        <bitlbee-setting name="strip_html" type="boolean" scope="global">
1599                <default>true</default>
1600
1601                <description>
1602                        <para>
1603                                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.
1604                        </para>
1605                        <para>
1606                                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.
1607                        </para>
1608                </description>
1609        </bitlbee-setting>
1610
1611        <bitlbee-setting name="strip_newlines" type="boolean" scope="account">
1612                <default>false</default>
1613
1614                <description>
1615                        <para>
1616                                Turn on this flag to prevent tweets from spanning over multiple lines.
1617                        </para>
1618                </description>
1619        </bitlbee-setting>
1620
1621        <bitlbee-setting name="show_old_mentions" type="integer" scope="account">
1622                <default>20</default>
1623
1624                <description>
1625                        <para>
1626                                This setting specifies the number of old mentions to fetch on connection. Must be less or equal to 200. Setting it to 0 disables this feature.
1627                        </para>
1628                </description>
1629        </bitlbee-setting>
1630
1631        <bitlbee-setting name="switchboard_keepalives" type="boolean" scope="account">
1632                <default>false</default>
1633
1634                <description>
1635                        <para>
1636                                Turn on this flag if you have difficulties talking to offline/invisible contacts.
1637                        </para>
1638                       
1639                        <para>
1640                                With this setting enabled, BitlBee will send keepalives to MSN switchboards with offline/invisible contacts every twenty seconds. This should keep the server and client on the other side from shutting it down.
1641                        </para>
1642                       
1643                        <para>
1644                                This is useful because BitlBee doesn't support MSN offline messages yet and the MSN servers won't let the user reopen switchboards to offline users. Once offline messaging is supported, this flag might be removed.
1645                        </para>
1646                </description>
1647        </bitlbee-setting>
1648
1649        <bitlbee-setting name="tag" type="string" scope="account">
1650                <description>
1651                        <para>
1652                                For every account you have, you can set a tag you can use to uniquely identify that account. This tag can be used instead of the account number (or protocol name, or part of the screenname) when using commands like <emphasis>account</emphasis>, <emphasis>add</emphasis>, etc. You can't have two accounts with one and the same account tag.
1653                        </para>
1654
1655                        <para>
1656                                By default, it will be set to the name of the IM protocol. Once you add a second account on an IM network, a numeric suffix will be added, starting with 2.
1657                        </para>
1658                </description>
1659        </bitlbee-setting>
1660
1661        <bitlbee-setting name="timezone" type="string" scope="global">
1662                <default>local</default>
1663                <possible-values>local, utc, gmt, timezone-spec</possible-values>
1664
1665                <description>
1666                        <para>
1667                                If message timestamps are available for offline messages or chatroom backlogs, BitlBee will display them as part of the message. By default it will use the local timezone. If you're not in the same timezone as the BitlBee server, you can adjust the timestamps using this setting.
1668                        </para>
1669
1670                        <para>
1671                                Values local/utc/gmt should be self-explanatory. timezone-spec is a time offset in hours:minutes, for example: -8 for Pacific Standard Time, +2 for Central European Summer Time, +5:30 for Indian Standard Time.
1672                        </para>
1673                </description>
1674        </bitlbee-setting>
1675
1676        <bitlbee-setting name="tls" type="boolean" scope="account">
1677                <default>true</default>
1678
1679                <description>
1680                        <para>
1681                                By default (with this setting enabled), BitlBee will require Jabber servers to offer encryption via StartTLS and refuse to connect if they don't.
1682                        </para>
1683
1684                        <para>
1685                                If you set this to "try", BitlBee will use StartTLS only if it's offered. With the setting disabled, StartTLS support will be ignored and avoided entirely.
1686                        </para>
1687                </description>
1688        </bitlbee-setting>
1689
1690        <bitlbee-setting name="tls_verify" type="boolean" scope="account">
1691                <default>true</default>
1692
1693                <description>
1694                        <para>
1695                                Currently only available for Jabber connections in combination with the <emphasis>tls</emphasis> setting. Set this to <emphasis>true</emphasis> if you want BitlBee to strictly verify the server's certificate against a list of trusted certificate authorities.
1696                        </para>
1697
1698                        <para>
1699                                The hostname used in the certificate verification is the value of the <emphasis>server</emphasis> setting if the latter is nonempty and the domain of the username else. If you get a hostname related error when connecting to Google Talk with a username from the gmail.com or googlemail.com domain, please try to empty the <emphasis>server</emphasis> setting.
1700                        </para>
1701
1702                        <para>
1703                                Please note that no certificate verification is performed when the <emphasis>ssl</emphasis> setting is used, or when the <emphasis>CAfile</emphasis> setting in <emphasis>bitlbee.conf</emphasis> is not set.
1704                        </para>
1705                </description>
1706        </bitlbee-setting>
1707
1708        <bitlbee-setting name="to_char" type="string" scope="global">
1709                <default>": "</default>
1710
1711                <description>
1712                        <para>
1713                                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>.
1714                        </para>
1715
1716                        <para>
1717                                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.
1718                        </para>
1719                </description>
1720        </bitlbee-setting>
1721
1722        <bitlbee-setting name="translate_to_nicks" type="boolean" scope="channel">
1723                <default>true</default>
1724
1725                <description>
1726                        <para>
1727                                IRC's nickname namespace is quite limited compared to most IM protocols. Not any non-ASCII characters are allowed, in fact nicknames have to be mostly alpha-numeric. Also, BitlBee has to add underscores sometimes to avoid nickname collisions.
1728                        </para>
1729
1730                        <para>
1731                                While normally the BitlBee user is the only one seeing these names, they may be exposed to other chatroom participants for example when addressing someone in the channel (with or without tab completion). By default BitlBee will translate these stripped nicknames back to the original nick. If you don't want this, disable this setting.
1732                        </para>
1733                </description>
1734        </bitlbee-setting>
1735
1736        <bitlbee-setting name="type" type="string" scope="channel">
1737                <default>control</default>
1738                <possible-values>control, chat</possible-values>
1739
1740                <description>
1741                        <para>
1742                                BitlBee supports two kinds of channels: control channels (usually with a name starting with a &amp;) and chatroom channels (name usually starts with a #).
1743                        </para>
1744
1745                        <para>
1746                                See <emphasis>help channels</emphasis> for a full description of channel types in BitlBee.
1747                        </para>
1748                </description>
1749        </bitlbee-setting>
1750
1751        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
1752                <default>false</default>
1753
1754                <description>
1755                        <para>
1756                                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.
1757                        </para>
1758                </description>
1759        </bitlbee-setting>
1760
1761        <bitlbee-setting name="user_agent" type="string" scope="account">
1762                <default>BitlBee</default>
1763
1764                <description>
1765                        <para>
1766                                Some Jabber servers are configured to only allow a few (or even just one) kinds of XMPP clients to connect to them.
1767                        </para>
1768                       
1769                        <para>
1770                                You can change this setting to make BitlBee present itself as a different client, so that you can still connect to these servers.
1771                        </para>
1772                </description>
1773        </bitlbee-setting>
1774
1775        <bitlbee-setting name="utf8_nicks" type="boolean" scope="global">
1776                <default>false</default>
1777
1778                <description>
1779                        <para>
1780                                Officially, IRC nicknames are restricted to ASCII. Recently some clients and servers started supporting Unicode nicknames though. To enable UTF-8 nickname support (contacts only) in BitlBee, enable this setting.
1781                        </para>
1782                       
1783                        <para>
1784                                To avoid confusing old clients, this setting is disabled by default. Be careful when you try it, and be prepared to be locked out of your BitlBee in case your client interacts poorly with UTF-8 nicknames.
1785                        </para>
1786                </description>
1787        </bitlbee-setting>
1788
1789        <bitlbee-setting name="web_aware" type="string" scope="account">
1790                <default>false</default>
1791
1792                <description>
1793                        <para>
1794                                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.
1795                        </para>
1796
1797                        <para>
1798                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
1799                        </para>
1800                </description>
1801        </bitlbee-setting>
1802
1803        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
1804                <default>false</default>
1805
1806                <description>
1807                        <para>
1808                                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.
1809                        </para>
1810                        <para>
1811                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
1812                        </para>
1813                </description>
1814        </bitlbee-setting>
1815
1816        <bitlbee-command name="rename">
1817                <short-description>Rename (renick) a buddy</short-description>
1818                <syntax>rename &lt;oldnick&gt; &lt;newnick&gt;</syntax>
1819                <syntax>rename -del &lt;oldnick&gt;</syntax>
1820
1821                <description>
1822                        <para>
1823                                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).
1824                        </para>
1825                       
1826                        <para>
1827                                <emphasis>rename -del</emphasis> can be used to erase your manually set nickname for a contact and reset it to what was automatically generated.
1828                        </para>
1829                </description>
1830
1831                <ircexample>
1832                        <ircline nick="itsme">rename itsme_ you</ircline>
1833                        <ircaction nick="itsme_">is now known as <emphasis>you</emphasis></ircaction>
1834                </ircexample>
1835
1836        </bitlbee-command>
1837
1838        <bitlbee-command name="yes">
1839                <short-description>Accept a request</short-description>
1840                <syntax>yes [&lt;number&gt;]</syntax>
1841
1842                <description>
1843                        <para>
1844                                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.
1845                        </para>
1846
1847                        <para>
1848                                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.
1849                        </para>
1850                </description>
1851
1852        </bitlbee-command>
1853
1854        <bitlbee-command name="no">
1855                <short-description>Deny a request</short-description>
1856                <syntax>no [&lt;number&gt;]</syntax>
1857
1858                <description>
1859                        <para>
1860                                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.
1861                        </para>
1862
1863                        <para>
1864                                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.
1865                        </para>
1866                </description>
1867        </bitlbee-command>
1868
1869        <bitlbee-command name="plugins">
1870                <short-description>List all the external plugins and protocols</short-description>
1871                <syntax>plugins</syntax>
1872
1873                <description>
1874                        <para>
1875                                This gives you a list of all the external plugins and protocols.
1876                        </para>
1877                </description>
1878
1879        </bitlbee-command>
1880
1881        <bitlbee-command name="qlist">
1882                <short-description>List all the unanswered questions root asked</short-description>
1883                <syntax>qlist</syntax>
1884
1885                <description>
1886                        <para>
1887                                This gives you a list of all the unanswered questions from root.
1888                        </para>
1889                </description>
1890
1891        </bitlbee-command>
1892
1893        <bitlbee-command name="register">
1894                <short-description>Register yourself</short-description>
1895                <syntax>register [&lt;password&gt;]</syntax>
1896
1897                <description>
1898                        <para>
1899                                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.
1900                        </para>
1901
1902                        <para>
1903                                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.. ;-)
1904                        </para>
1905
1906                        <para>
1907                                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.
1908                        </para>
1909
1910                        <para>
1911                                You can omit the password and enter it separately using the IRC /OPER command. This lets you enter your password without your IRC client echoing it on screen or recording it in logs.
1912                        </para>
1913                </description>
1914
1915        </bitlbee-command>
1916
1917        <bitlbee-command name="identify">
1918                <syntax>identify [-noload|-force] [&lt;password&gt;]</syntax>
1919                <short-description>Identify yourself with your password</short-description>
1920
1921                <description>
1922                        <para>
1923                                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.
1924                        </para>
1925
1926                        <para>
1927                                Once you're registered, you can change your password using <emphasis>set password &lt;password&gt;</emphasis>.
1928                        </para>
1929
1930                        <para>
1931                                The <emphasis>-noload</emphasis> and <emphasis>-force</emphasis> flags can be used to identify when you're logged into some IM accounts already. <emphasis>-force</emphasis> will let you identify yourself and load all saved accounts (and keep the accounts you're logged into already).
1932                        </para>
1933                       
1934                        <para>
1935                                <emphasis>-noload</emphasis> will log you in but not load any accounts and settings saved under your current nickname. These will be overwritten once you save your settings (i.e. when you disconnect).
1936                        </para>
1937
1938                        <para>
1939                                You can omit the password and enter it separately using the IRC /OPER command. This lets you enter your password without your IRC client echoing it on screen or recording it in logs.
1940                        </para>
1941                </description>
1942        </bitlbee-command>
1943
1944        <bitlbee-command name="drop">
1945                <syntax>drop &lt;password&gt;</syntax>
1946                <short-description>Drop your account</short-description>
1947
1948                <description>
1949                        <para>
1950                                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.
1951                        </para>
1952                </description>
1953        </bitlbee-command>
1954
1955        <bitlbee-command name="blist">
1956                <syntax>blist [all|online|offline|away] [&lt;pattern&gt;]</syntax>
1957                <short-description>List all the buddies in the current channel</short-description>
1958
1959                <description>
1960                        <para>
1961                                You can get a more readable buddy list using the <emphasis>blist</emphasis> command. If you want a complete list (including the offline users) you can use the <emphasis>all</emphasis> argument.
1962                        </para>
1963
1964                        <para>
1965                                A perl-compatible regular expression can be supplied as <emphasis>pattern</emphasis> to filter the results (case-insensitive).
1966                        </para>
1967                </description>
1968
1969        </bitlbee-command>
1970
1971        <bitlbee-command name="group">
1972                <short-description>Contact group management</short-description>
1973                <syntax>group [ list | info &lt;group&gt; ]</syntax>
1974
1975                <description>
1976                        <para>
1977                                The <emphasis>group list</emphasis> command shows a list of all groups defined so far.
1978                        </para>
1979                       
1980                        <para>
1981                                The <emphasis>group info</emphasis> command shows a list of all members of a the group &lt;group&gt;.
1982                        </para>
1983                       
1984                        <para>
1985                                If you want to move contacts between groups, you can use the IRC <emphasis>/invite</emphasis> command. Also, if you use the <emphasis>add</emphasis> command in a control channel configured to show just one group, the new contact will automatically be added to that group.
1986                        </para>
1987                </description>
1988        </bitlbee-command>
1989       
1990        <bitlbee-command name="transfer">
1991                <short-description>Monitor, cancel, or reject file transfers</short-description>
1992                <syntax>transfer [&lt;cancel&gt; id | &lt;reject&gt;]</syntax>
1993               
1994                <description>
1995                        <para>
1996                                Without parameters the currently pending file transfers and their status will be listed. Available actions are <emphasis>cancel</emphasis> and <emphasis>reject</emphasis>. See <emphasis>help transfer &lt;action&gt;</emphasis> for more information.
1997                        </para>
1998
1999                        <ircexample>
2000                                <ircline nick="ulim">transfer</ircline>
2001                        </ircexample>
2002                </description>
2003               
2004                <bitlbee-command name="cancel">
2005                        <short-description>Cancels the file transfer with the given id</short-description>
2006                        <syntax>transfer &lt;cancel&gt; id</syntax>
2007
2008                        <description>
2009                                <para>Cancels the file transfer with the given id</para>
2010                        </description>
2011
2012                        <ircexample>
2013                                <ircline nick="ulim">transfer cancel 1</ircline>
2014                                <ircline nick="root">Canceling file transfer for test</ircline>
2015                        </ircexample>
2016                </bitlbee-command>
2017
2018                <bitlbee-command name="reject">
2019                        <short-description>Rejects all incoming transfers</short-description>
2020                        <syntax>transfer &lt;reject&gt;</syntax>
2021
2022                        <description>
2023                                <para>Rejects all incoming (not already transferring) file transfers. Since you probably have only one incoming transfer at a time, no id is necessary. Or is it?</para>
2024                        </description>
2025
2026                        <ircexample>
2027                                <ircline nick="ulim">transfer reject</ircline>
2028                        </ircexample>
2029                </bitlbee-command>
2030        </bitlbee-command>
2031       
2032</chapter>
Note: See TracBrowser for help on using the repository browser.