source: doc/user-guide/commands.xml @ 2dd6076

Last change on this file since 2dd6076 was cfe7243, checked in by dequis <dx@…>, at 2021-11-13T15:19:14Z

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