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

Last change on this file since fca4683 was 028ca92, checked in by dequis <dx@…>, at 2016-09-21T02:48:14Z

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