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

Last change on this file since 8167346 was d168091, checked in by Alyssa Ross <hi@…>, at 2018-02-08T11:29:08Z

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